summaryrefslogtreecommitdiff
path: root/spec/all.xml
blob: e77f63405681865f673d3e26e67b5815569433d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<tp:spec
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
  xmlns:xi="http://www.w3.org/2001/XInclude">

<tp:title>Telepathy D-Bus Interface Specification</tp:title>
<tp:version>0.19.9</tp:version>

<tp:copyright>Copyright © 2005-2010 Collabora Limited</tp:copyright>
<tp:copyright>Copyright © 2005-2010 Nokia Corporation</tp:copyright>
<tp:copyright>Copyright © 2006 INdT</tp:copyright>

<tp:license xmlns="http://www.w3.org/1999/xhtml">
<p>This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.</p>

<p>This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.</p>

<p>You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
</tp:license>

<tp:section name="Connection Managers">
 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  <p>
   A Connection Manager is a factory for connections.
  </p>
 </tp:docstring>
 <xi:include href="Connection_Manager.xml"/>
 <xi:include href="Protocol.xml"/>
 <xi:include href="Protocol_Interface_Avatars.xml"/>
 <xi:include href="Protocol_Interface_Presence.xml"/>

 <tp:section name="Connection Object">
  <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   <p>
    Connections represent active protocol sessions.
   </p>
  </tp:docstring>
  <xi:include href="Connection.xml"/>
  <xi:include href="Connection_Future.xml"/>
  <xi:include href="Connection_Interface_Aliasing.xml"/>
  <xi:include href="Connection_Interface_Anonymity.xml"/>
  <xi:include href="Connection_Interface_Avatars.xml"/>
  <xi:include href="Connection_Interface_Balance.xml"/>
  <xi:include href="Connection_Interface_Capabilities.xml"/>
  <xi:include href="Connection_Interface_Cellular.xml"/>
  <xi:include href="Connection_Interface_Contact_Capabilities.xml"/>
  <xi:include href="Connection_Interface_Contact_Groups.xml"/>
  <xi:include href="Connection_Interface_Contact_Info.xml"/>
  <xi:include href="Connection_Interface_Contact_List.xml"/>
  <xi:include href="Connection_Interface_Contacts.xml"/>
  <xi:include href="Connection_Interface_Forwarding.xml"/>
  <xi:include href="Connection_Interface_Location.xml"/>
  <xi:include href="Connection_Interface_Mail_Notification.xml"/>
  <xi:include href="Connection_Interface_Presence.xml"/>
  <xi:include href="Connection_Interface_Renaming.xml"/>
  <xi:include href="Connection_Interface_Requests.xml"/>
  <xi:include href="Connection_Interface_Service_Point.xml"/>
  <xi:include href="Connection_Interface_Simple_Presence.xml"/>
 </tp:section>

 <xi:include href="Channel_Bundle.xml"/>

 <tp:section name="Channel Object">
  <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   <p>
    A Channel is used by Telepathy to exchange data between local
    applications and remote servers. A given connection will have many
    channels, each one represented by a D-Bus object.
   </p>
   <p>
    Each Channel has a type, represented by a D-Bus interface, and may
    implement one or more additional interfaces from the list of channel
    interfaces below.
   </p>
  </tp:docstring>
  <xi:include href="Channel.xml"/>
  <xi:include href="Channel_Future.xml"/>

  <tp:section name="Channel Types">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
    <p>
     Each Channel implements one of the following types:
    </p>
   </tp:docstring>
   <xi:include href="Channel_Type_Call.xml"/>
   <xi:include href="Channel_Type_Contact_List.xml"/>
   <xi:include href="Channel_Type_Contact_Search.xml"/>
   <xi:include href="Channel_Type_DBus_Tube.xml"/>
   <xi:include href="Channel_Type_File_Transfer.xml"/>
   <xi:include href="Channel_Type_Room_List.xml"/>
   <xi:include href="Channel_Type_Stream_Tube.xml"/>
   <xi:include href="Channel_Type_Streamed_Media.xml"/>
   <xi:include href="Channel_Type_Text.xml"/>
   <xi:include href="Channel_Type_Tubes.xml"/>
  </tp:section>

  <tp:section name="Channel Interfaces">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
    <p>
     A Channel may also implement one or more of the following interfaces,
     depending on its type:
    </p>
   </tp:docstring>
   <xi:include href="Channel_Interface_Anonymity.xml"/>
   <xi:include href="Channel_Interface_Call_State.xml"/>
   <xi:include href="Channel_Interface_Chat_State.xml"/>
   <xi:include href="Channel_Interface_Conference.xml"/>
   <xi:include href="Channel_Interface_DTMF.xml"/>
   <xi:include href="Channel_Interface_Destroyable.xml"/>
   <xi:include href="Channel_Interface_Group.xml"/>
   <xi:include href="Channel_Interface_HTML.xml"/>
   <xi:include href="Channel_Interface_Hold.xml"/>
   <xi:include href="Channel_Interface_Media_Signalling.xml"/>
   <xi:include href="Channel_Interface_Mergeable_Conference.xml"/>
   <xi:include href="Channel_Interface_Messages.xml"/>
   <xi:include href="Channel_Interface_Password.xml"/>
   <xi:include href="Channel_Interface_Service_Point.xml"/>
   <xi:include href="Channel_Interface_Splittable.xml"/>
   <xi:include href="Channel_Interface_Tube.xml"/>
  </tp:section>
 </tp:section>

 <tp:section name="Media">
  <xi:include href="Media_Session_Handler.xml"/>
  <xi:include href="Media_Stream_Handler.xml"/>
 </tp:section>

 <tp:section name="Calls">
   <xi:include href="Call_Content.xml"/>
   <xi:include href="Call_Content_Interface_Media.xml"/>
   <xi:include href="Call_Content_Interface_Mute.xml"/>
   <xi:include href="Call_Content_Codec_Offer.xml"/>
   <xi:include href="Call_Stream.xml"/>
   <xi:include href="Call_Stream_Interface_Media.xml"/>
   <xi:include href="Call_Stream_Endpoint.xml"/>
 </tp:section>

 <tp:section name="Debugging">
  <xi:include href="Debug.xml"/>
 </tp:section>
</tp:section>

<tp:section name="The Account Manager">
 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  <p>
   The Account Manager is a desktop service that provides account configuration
   and can manage the connection managers. In general, clients will use the
   account manager to find out about instant messaging accounts and their
   associated connections.
  </p>
 </tp:docstring>
 <xi:include href="Account_Manager.xml"/>
 <xi:include href="Account.xml"/>
 <xi:include href="Account_Interface_Avatar.xml"/>
 <xi:include href="Account_Interface_Storage.xml"/>
</tp:section>

<tp:section name="The Channel Dispatcher">
 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  <p>
   The Channel Dispatcher is a desktop service whose purpose is to dispatch
   incoming Telepathy Channels to the appropriate client (e.g. incoming text
   chat, file transfer, tubes, etc.).
  </p>
 </tp:docstring>
 <xi:include href="Channel_Dispatcher.xml"/>
 <xi:include href="Channel_Dispatcher_Interface_Operation_List.xml"/>
 <xi:include href="Channel_Dispatch_Operation.xml"/>
 <xi:include href="Channel_Request.xml"/>
</tp:section>

<tp:section name="Clients">
 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  <p>
   Clients should implement one or more of these interfaces to be able to
   handle channels coming in from the Channel Dispatcher.
  </p>
 </tp:docstring>
 <xi:include href="Client.xml"/>
 <xi:include href="Client_Observer.xml"/>
 <xi:include href="Client_Approver.xml"/>
 <xi:include href="Client_Handler.xml"/>
 <xi:include href="Client_Handler_Future.xml"/>
 <xi:include href="Client_Interface_Requests.xml"/>

 <xi:include href="Channel_Handler.xml"/>
</tp:section>

<xi:include href="Properties_Interface.xml"/>

<xi:include href="errors.xml"/>
<xi:include href="generic-types.xml"/>

<!-- Never implemented, vague
<xi:include href="Connection_Interface_Privacy.xml"/> -->
<!-- Causes havoc, never implemented, unclear requirements
<xi:include href="Channel_Interface_Transfer.xml"/> -->

</tp:spec>