~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-05-25 16:57:39 UTC
  • mfrom: (1.6.2 upstream) (30.1.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20100525165739-kted5mhm904f8lwj
Tags: 0.11.6-1
* New upstream version
  - requires gtk-doc 1.15
  - requires gobject-introspection 0.6.11
  - new ABI, API
* Merge from experimental
  - add gir1.0-telepathyglib-0.12 binary package

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
 
2
<node name="/Connection_Interface_Service_Point" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
 
3
  <tp:copyright> Copyright © 2005-2010 Nokia Corporation </tp:copyright>
 
4
  <tp:copyright> Copyright © 2005-2010 Collabora Ltd </tp:copyright>
 
5
  <tp:license xmlns="http://www.w3.org/1999/xhtml">
 
6
    <p>This library is free software; you can redistribute it and/or
 
7
modify it under the terms of the GNU Lesser General Public
 
8
License as published by the Free Software Foundation; either
 
9
version 2.1 of the License, or (at your option) any later version.</p>
 
10
 
 
11
<p>This library is distributed in the hope that it will be useful,
 
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
14
Lesser General Public License for more details.</p>
 
15
 
 
16
<p>You should have received a copy of the GNU Lesser General Public
 
17
License along with this library; if not, write to the Free Software
 
18
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
 
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>
 
22
 
 
23
    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
24
      <p>An interface for connections whose channels may be able to indicate
 
25
        specific they are connected to some form
 
26
        of service station.  For example, when
 
27
        dialing 9-1-1 in the US, a GSM modem/network will recognize that as
 
28
        an emergency call, and inform higher levels of the stack that the
 
29
        call is being handled by an emergency service.  In this example,
 
30
        the call is handled by a Public Safety Answering Point (PSAP) which is labeled
 
31
        as "urn:service:sos".  Other networks and protocols may handle this
 
32
        differently while still using this interface.</p>
 
33
    </tp:docstring>
 
34
 
 
35
   <tp:struct name="Service_Point_Info" array-name="Service_Point_Info_List">
 
36
      <tp:member type="(us)" tp:type="Service_Point" name="ServicePoint">
 
37
        <tp:docstring>
 
38
          The service point.
 
39
        </tp:docstring>
 
40
      </tp:member>
 
41
      <tp:member type="as" name="ServiceIDs">
 
42
        <tp:docstring>
 
43
          A list of IDs that are mapped to this service. This is provided as
 
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.
 
48
        </tp:docstring>
 
49
      </tp:member>
 
50
      <tp:docstring>
 
51
        <p>Description of a service point and IDs which are mapped to id.</p>
 
52
 
 
53
        <p>An example Service Point info for GSM emergency calls (callable through
 
54
        "911" and "112") could look like:</p>
 
55
 
 
56
<pre>
 
57
  ServicePointInfo = (
 
58
    ServicePoint: (
 
59
      ServicePointType: 1 (Emergency),
 
60
      ServicePoint: "urn:service:sos"
 
61
    ),
 
62
    ServiceIDs: [ "911", "112" ]
 
63
  )
 
64
</pre>
 
65
      </tp:docstring>
 
66
    </tp:struct>
 
67
 
 
68
    <property name="KnownServicePoints" tp:name-for-bindings="Known_Service_Points"
 
69
      type="a((us)as)" tp:type="Service_Point_Info[]" access="read">
 
70
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
71
         The list of all (known) service points.
 
72
        </tp:docstring>
 
73
    </property>
 
74
 
 
75
    <signal name="ServicePointsChanged" tp:name-for-bindings="Service_Points_Changed">
 
76
      <arg name="ServicePoints" type="a((us)as)" tp:type="Service_Point_Info[]">
 
77
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
78
         <p>The new list of service points.</p>
 
79
        </tp:docstring>
 
80
      </arg>
 
81
      <tp:docstring>
 
82
        Indicate that the list of known service points (or their IDs) have
 
83
        changed, presenting the new list.
 
84
      </tp:docstring>
 
85
    </signal>
 
86
 
 
87
    <tp:struct name="Service_Point">
 
88
      <tp:docstring>A service point.</tp:docstring>
 
89
      <tp:member type="u" name="ServicePointType" tp:type="Service_Point_Type">
 
90
        <tp:docstring>
 
91
          The service type.
 
92
        </tp:docstring>
 
93
      </tp:member>
 
94
      <tp:member type="s" name="Service">
 
95
        <tp:docstring>
 
96
          String representation of the service point. The representation is
 
97
          service specific; it may be <tp:type>Uniform_Resource_Name</tp:type>
 
98
          or may be in some other form. Empty, unused or unknown value is
 
99
          represented by "".
 
100
        </tp:docstring>
 
101
      </tp:member>
 
102
    </tp:struct>
 
103
 
 
104
    <tp:enum name="Service_Point_Type" type="u">
 
105
      <tp:docstring>
 
106
        The various types of service points the channel might connect to.
 
107
      </tp:docstring>
 
108
 
 
109
      <tp:enumvalue value="0" suffix="None">
 
110
        <tp:docstring>
 
111
          The service point is not used/available.
 
112
        </tp:docstring>
 
113
      </tp:enumvalue>
 
114
 
 
115
      <tp:enumvalue value="1" suffix="Emergency">
 
116
        <tp:docstring>
 
117
          The service point is a generic emergency point.
 
118
        </tp:docstring>
 
119
      </tp:enumvalue>
 
120
 
 
121
      <tp:enumvalue value="2" suffix="Counseling">
 
122
        <tp:docstring>
 
123
          The service point is some kind of counseling service (ie, mental health
 
124
          or child-services counseling).
 
125
        </tp:docstring>
 
126
      </tp:enumvalue>
 
127
    </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
  </interface>
 
134
</node>
 
135
<!-- vim:set sw=2 sts=2 et ft=xml: -->