← Back to branch summary

~ubuntu-branches/ubuntu/maverick/telepathy-glib/maverick

« back to all changes in this revision

Viewing changes to spec/Connection_Interface_Service_Point.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2010-06-14 17:42:08 UTC
  • mfrom: (1.6.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20100614174208-7b6teypo8jnx5uux
Tags: 0.11.7-1
* New upstream version
  - requires gobject-introspection 0.6.13
  - new ABI, API

Show diffs side-by-side

added added

removed removed

Lines of Context:
spec/Connection_Interface_Service_Point.xml
17
17
License along with this library; if not, write to the Free Software
18
18
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
19
19
  </tp:license>
20
 
  <interface name="org.freedesktop.Telepathy.Connection.Interface.ServicePoint.DRAFT" tp:causes-havoc="experimental">
21
 
    <tp:added version="0.19.6">(draft version, not API-stable)</tp:added>
 
20
  <interface name="org.freedesktop.Telepathy.Connection.Interface.ServicePoint">
 
21
    <tp:added version="0.19.7">(as stable API)</tp:added>
22
22
 
23
23
    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
24
24
      <p>An interface for connections whose channels may be able to indicate
33
33
    </tp:docstring>
34
34
 
35
35
   <tp:struct name="Service_Point_Info" array-name="Service_Point_Info_List">
36
 
      <tp:member type="(us)" tp:type="Service_Point" name="ServicePoint">
 
36
      <tp:member type="(us)" tp:type="Service_Point" name="Service_Point">
37
37
        <tp:docstring>
38
38
          The service point.
39
39
        </tp:docstring>
40
40
      </tp:member>
41
 
      <tp:member type="as" name="ServiceIDs">
 
41
      <tp:member type="as" name="Service_IDs">
42
42
        <tp:docstring>
43
43
          A list of IDs that are mapped to this service. This is provided as
44
44
          a convenience for the UIs, but the preferred method for
45
 
          requesting channel to a service is by setting <tp:dbus-ref
46
 
            namespace="org.freedesktop.Telepathy.Channel.Interface.ServicePoint.DRAFT">InitialServicePoint</tp:dbus-ref>
47
 
            property in channel request.
 
45
          requesting channel to a service is by setting the <tp:dbus-ref
 
46
            namespace="org.freedesktop.Telepathy.Channel.Interface.ServicePoint">InitialServicePoint</tp:dbus-ref>
 
47
            property in a channel request.
48
48
        </tp:docstring>
49
49
      </tp:member>
50
50
      <tp:docstring>
51
 
        <p>Description of a service point and IDs which are mapped to id.</p>
 
51
        <p>Description of a service point and IDs which are mapped to it.</p>
52
52
 
53
 
        <p>An example Service Point info for GSM emergency calls (callable through
54
 
        "911" and "112") could look like:</p>
 
53
        <p>An example Service Point info for GSM emergency calls (callable
 
54
          through "911" and "112") could look like:</p>
55
55
 
56
56
<pre>
57
57
  ServicePointInfo = (
58
 
    ServicePoint: (
59
 
      ServicePointType: 1 (Emergency),
60
 
      ServicePoint: "urn:service:sos"
 
58
    Service_Point: (
 
59
      Service_Point_Type: 1 (Emergency),
 
60
      Service_Point: "urn:service:sos"
61
61
    ),
62
 
    ServiceIDs: [ "911", "112" ]
 
62
    Service_IDs: [ "911", "112" ]
63
63
  )
64
64
</pre>
65
65
      </tp:docstring>
73
73
    </property>
74
74
 
75
75
    <signal name="ServicePointsChanged" tp:name-for-bindings="Service_Points_Changed">
76
 
      <arg name="ServicePoints" type="a((us)as)" tp:type="Service_Point_Info[]">
 
76
      <arg name="Service_Points" type="a((us)as)" tp:type="Service_Point_Info[]">
77
77
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
78
 
         <p>The new list of service points.</p>
 
78
          <p>The new value of
 
79
            <tp:member-ref>KnownServicePoints</tp:member-ref>.</p>
79
80
        </tp:docstring>
80
81
      </arg>
81
82
      <tp:docstring>
82
 
        Indicate that the list of known service points (or their IDs) have
83
 
        changed, presenting the new list.
 
83
        Emitted when the list of known service points (or their IDs) has
 
84
        changed.
84
85
      </tp:docstring>
85
86
    </signal>
86
87
 
87
88
    <tp:struct name="Service_Point">
88
89
      <tp:docstring>A service point.</tp:docstring>
89
 
      <tp:member type="u" name="ServicePointType" tp:type="Service_Point_Type">
 
90
      <tp:member type="u" name="Service_Point_Type"
 
91
        tp:type="Service_Point_Type">
90
92
        <tp:docstring>
91
93
          The service type.
92
94
        </tp:docstring>
94
96
      <tp:member type="s" name="Service">
95
97
        <tp:docstring>
96
98
          String representation of the service point. The representation is
97
 
          service specific; it may be <tp:type>Uniform_Resource_Name</tp:type>
 
99
          service specific; it may be a 'service' Uniform Resource Name as
 
100
          specified by <a
 
101
            href="http://www.rfc-editor.org/rfc/rfc5031.txt">RFC 5031</a>,
98
102
          or may be in some other form. Empty, unused or unknown value is
99
103
          represented by "".
100
104
        </tp:docstring>
103
107
 
104
108
    <tp:enum name="Service_Point_Type" type="u">
105
109
      <tp:docstring>
106
 
        The various types of service points the channel might connect to.
 
110
        The various types of service points a channel might connect to.
107
111
      </tp:docstring>
108
112
 
109
113
      <tp:enumvalue value="0" suffix="None">
110
114
        <tp:docstring>
111
 
          The service point is not used/available.
 
115
          The channel is not communicating with a service point, or it is not
 
116
          known whether it is communicating with a service point (e.g. an
 
117
          ordinary call).
112
118
        </tp:docstring>
113
119
      </tp:enumvalue>
114
120
 
125
131
        </tp:docstring>
126
132
      </tp:enumvalue>
127
133
    </tp:enum>
128
 
 
129
 
    <tp:simple-type name="Uniform_Resource_Name" type="s">
130
 
      <tp:docstring>Uniform Resource Name as specified by
131
 
        <a href="http://www.rfc-editor.org/rfc/rfc5031.txt">RFC 5031</a>.</tp:docstring>
132
 
    </tp:simple-type>
133
134
  </interface>
134
135
</node>
135
136
<!-- vim:set sw=2 sts=2 et ft=xml: -->