Imported Upstream version 0.17.19
Simon McVittie
15 years ago
0 | commit 4d1c7ea5760a48d6896f22a01e8cc73d666b28b3 | |
1 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
2 | Date: 2009-01-28 15:42:51 +0000 | |
3 | ||
4 | Prepare release 0.17.19 | |
5 | ||
6 | NEWS | 11 +++++++++-- | |
7 | spec/all.xml | 2 +- | |
8 | 2 files changed, 10 insertions(+), 3 deletions(-) | |
9 | ||
10 | commit 4864a8b4d07588b93c878bd5d7f46feecd075be3 | |
11 | Merge: 2b48df6... 94b6f9b... | |
12 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
13 | Date: 2009-01-28 15:36:01 +0000 | |
14 | ||
15 | Merge branch 'errors' into release | |
16 | ||
17 | Signed-off-by: Senko Rasic <senko.rasic@collabora.co.uk> | |
18 | ||
19 | commit 94b6f9b56185555e4f18a5792c6d36681d720b8e | |
20 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
21 | Date: 2009-01-28 14:27:12 +0000 | |
22 | ||
23 | Group: add errors corresponding to most of the change reasons, and attempt to document how they work | |
24 | ||
25 | spec/Channel_Interface_Group.xml | 124 +++++++++++++++++++++++++++++++------- | |
26 | spec/errors.xml | 61 +++++++++++++++++++ | |
27 | 2 files changed, 164 insertions(+), 21 deletions(-) | |
28 | ||
29 | commit 2b48df6f827a888986183f2df54adc513a198711 | |
30 | Merge: 1533cec... 2e6a99d... | |
31 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
32 | Date: 2009-01-28 12:01:05 +0000 | |
33 | ||
34 | Merge branch 'trivia' | |
35 | ||
36 | Signed-off-by: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | |
37 | ||
38 | commit 2e6a99dd1d2e0b9593cef83ace003137991346c7 | |
39 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
40 | Date: 2009-01-28 11:44:05 +0000 | |
41 | ||
42 | Fix markup for ConnectionError arguments | |
43 | ||
44 | spec/Connection.xml | 69 ++++++++++++++++++++++++++------------------------- | |
45 | 1 files changed, 35 insertions(+), 34 deletions(-) | |
46 | ||
47 | commit ccc9e64b4be6ff3363d448ebdc029ff7df993be9 | |
48 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
49 | Date: 2009-01-27 19:25:53 +0000 | |
50 | ||
51 | Update NEWS with the changes so far | |
52 | ||
53 | NEWS | 31 +++++++++++++++++++++++++++++++ | |
54 | 1 files changed, 31 insertions(+), 0 deletions(-) | |
55 | ||
56 | commit 1533cecb1acf9393a610688d4e4d6ec1e7a5bd56 | |
57 | Merge: 126e4fd... e79d6d5... | |
58 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
59 | Date: 2009-01-27 19:17:15 +0000 | |
60 | ||
61 | Merge branch 'media' | |
62 | ||
63 | Signed-off-by: Senko Rasic <senko.rasic@collabora.co.uk> | |
64 | ||
65 | commit 126e4fdd86bdacbfac8fa8b8e727848f4a58d412 | |
66 | Merge: dc0e60e... b4da1a3... | |
67 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
68 | Date: 2009-01-27 19:06:42 +0000 | |
69 | ||
70 | Merge branch 'notcapable' | |
71 | ||
72 | Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
73 | Signed-off-by: Senko Rasic <senko.rasic@collabora.co.uk> | |
74 | ||
75 | commit b4da1a3eea5c7a76b6c37a47c43159f4383b8c55 | |
76 | Author: Senko Rasic <senko.rasic@collabora.co.uk> | |
77 | Date: 2008-12-02 12:30:33 +0100 | |
78 | ||
79 | Add NotCapable to the list of errors. | |
80 | ||
81 | spec/errors.xml | 6 ++++++ | |
82 | 1 files changed, 6 insertions(+), 0 deletions(-) | |
83 | ||
84 | commit 57848fe1e9c8fef5168cb9b97866d1cc2152de5c | |
85 | Author: Senko Rasic <senko.rasic@collabora.co.uk> | |
86 | Date: 2008-12-02 12:25:14 +0100 | |
87 | ||
88 | Actually add NotCapable to EnsureChannel also. | |
89 | ||
90 | spec/Connection_Interface_Requests.xml | 10 +++++++--- | |
91 | 1 files changed, 7 insertions(+), 3 deletions(-) | |
92 | ||
93 | commit cdfb93978254a1ab7fe23959739a3f47b2fdddfa | |
94 | Author: Senko Rasic <senko.rasic@collabora.co.uk> | |
95 | Date: 2008-12-02 12:13:27 +0100 | |
96 | ||
97 | Connection, Connection.Interface.Requests: add NotCapable error | |
98 | ||
99 | spec/Connection.xml | 6 ++++++ | |
100 | spec/Connection_Interface_Requests.xml | 8 ++++++-- | |
101 | 2 files changed, 12 insertions(+), 2 deletions(-) | |
102 | ||
103 | commit e79d6d5dcc9698da41e3e5596445091cf7ad570e | |
104 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
105 | Date: 2009-01-27 18:47:27 +0000 | |
106 | ||
107 | StreamedMedia.FUTURE: explain how InitialAudio/InitialVideo work in Ensure requests | |
108 | ||
109 | spec/Channel_Type_Streamed_Media_Future.xml | 14 ++++++++++---- | |
110 | 1 files changed, 10 insertions(+), 4 deletions(-) | |
111 | ||
112 | commit 8563c849bf8338a60d1065dbd8b795ea29848a0f | |
113 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
114 | Date: 2009-01-27 18:47:02 +0000 | |
115 | ||
116 | MediaSignalling.FUTURE: Explain how FooTransportAvailable works in requests | |
117 | ||
118 | spec/Channel_Interface_Media_Signalling_Future.xml | 42 ++++++++++++++++++++ | |
119 | 1 files changed, 42 insertions(+), 0 deletions(-) | |
120 | ||
121 | commit 614f14106053ce5768c53e264e8c705c475c2315 | |
122 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
123 | Date: 2009-01-27 18:13:07 +0000 | |
124 | ||
125 | MediaSignalling: add a Future part with transport capability discovery | |
126 | ||
127 | spec/Channel_Interface_Media_Signalling_Future.xml | 147 ++++++++++++++++++++ | |
128 | spec/all.xml | 1 + | |
129 | 2 files changed, 148 insertions(+), 0 deletions(-) | |
130 | ||
131 | commit 6d5d192e19d423425fc05c5a108757889d0cd1a4 | |
132 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
133 | Date: 2009-01-27 17:46:50 +0000 | |
134 | ||
135 | StreamedMedia: add a draft version of InitialAudio, InitialVideo | |
136 | ||
137 | These allow us to represent the audio and video capabilities in various | |
138 | contexts. | |
139 | ||
140 | spec/Channel_Type_Streamed_Media.xml | 10 ++- | |
141 | spec/Channel_Type_Streamed_Media_Future.xml | 160 +++++++++++++++++++++++++++ | |
142 | spec/all.xml | 1 + | |
143 | 3 files changed, 170 insertions(+), 1 deletions(-) | |
144 | ||
145 | commit dc0e60e75b9cc3a1268ddd907b67147be3f3bf6c | |
146 | Author: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | |
147 | Date: 2009-01-27 11:06:46 +0000 | |
148 | ||
149 | rename org.freedesktop.Telepathy.Channel.Interface.Tube.DRAFT.Status to State | |
150 | ||
151 | spec/Channel_Interface_Tube.xml | 6 +++--- | |
152 | 1 files changed, 3 insertions(+), 3 deletions(-) | |
153 | ||
154 | commit 79b2e2c03ea6ded1c2b3c09d404855347406ed85 | |
155 | Author: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | |
156 | Date: 2009-01-27 11:00:01 +0000 | |
157 | ||
158 | DBusNames is an empty dict and not en empty list in the 1-1 case | |
159 | ||
160 | spec/Channel_Type_DBus_Tube.xml | 2 +- | |
161 | 1 files changed, 1 insertions(+), 1 deletions(-) | |
162 | ||
163 | commit fb5fce5d3a6c03a30241c2fa22d7ea41b64d3a87 | |
164 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
165 | Date: 2009-01-26 15:47:10 +0000 | |
166 | ||
167 | StreamedMedia: use a hyperlink to the wiki, now that they work | |
168 | ||
169 | spec/Channel_Type_Streamed_Media.xml | 2 +- | |
170 | 1 files changed, 1 insertions(+), 1 deletions(-) | |
171 | ||
172 | commit 765fdf58b9389687e736e8bc9eb9dfb7ff236e1c | |
173 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
174 | Date: 2009-01-26 15:44:18 +0000 | |
175 | ||
176 | MediaSignalling: move tp:docstring to the top and explain it a bit more | |
177 | ||
178 | spec/Channel_Interface_Media_Signalling.xml | 46 ++++++++++++++++++++------ | |
179 | 1 files changed, 35 insertions(+), 11 deletions(-) | |
180 | ||
181 | commit 9f80dfcdbbc1a35239982970cd4a0532ddfb0055 | |
182 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
183 | Date: 2009-01-26 15:43:57 +0000 | |
184 | ||
185 | doc-generator: don't drop HTML attributes | |
186 | ||
187 | This fixes generation of hyperlinks in HTML. | |
188 | ||
189 | tools/doc-generator.xsl | 2 +- | |
190 | 1 files changed, 1 insertions(+), 1 deletions(-) | |
191 | ||
192 | commit 15889687698da4c278a06e4ce8632bee6810c1e0 | |
193 | Merge: 05062e5... b4879a0... | |
194 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
195 | Date: 2009-01-22 13:54:24 +0000 | |
196 | ||
197 | Merge branch 'errors' | |
198 | ||
199 | Signed-off-by: Will Thompson <will.thompson@collabora.co.uk> | |
200 | ||
201 | commit 05062e5836a473041ca8ea120c39698554a43c4b | |
202 | Merge: dcc7701... 4895fd0... | |
203 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
204 | Date: 2009-01-22 13:54:04 +0000 | |
205 | ||
206 | Merge branch 'trivia' | |
207 | ||
208 | Signed-off-by: Will Thompson <will.thompson@collabora.co.uk> | |
209 | ||
210 | commit 4895fd0d9ae3f2011f8e150ccb585c7fc0270a68 | |
211 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
212 | Date: 2009-01-22 13:45:04 +0000 | |
213 | ||
214 | Correct "UNRELEASED" annotations | |
215 | ||
216 | spec/Channel_Type_File_Transfer.xml | 2 +- | |
217 | spec/Connection_Interface_Contact_Info.xml | 2 +- | |
218 | spec/Connection_Interface_Location.xml | 2 +- | |
219 | 3 files changed, 3 insertions(+), 3 deletions(-) | |
220 | ||
221 | commit dcc7701014e6ffab424fd7405e7a0b91aa68e267 | |
222 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
223 | Date: 2009-01-22 13:44:50 +0000 | |
224 | ||
225 | Start 0.17.19 development | |
226 | ||
227 | spec/all.xml | 2 +- | |
228 | 1 files changed, 1 insertions(+), 1 deletions(-) | |
229 | ||
0 | 230 | commit c6ea4fe81342eee731df3f215b6ff884deccfddf |
1 | 231 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> |
2 | 232 | Date: 2009-01-20 11:38:15 +0000 |
33 | 263 | |
34 | 264 | Signed-off-by: Robert McQueen <robert.mcqueen@collabora.co.uk> |
35 | 265 | |
266 | commit b4879a05a3ec219bf1e68fdd2ea904ab9e59dbbf | |
267 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
268 | Date: 2009-01-19 18:30:52 +0000 | |
269 | ||
270 | Channel_Group_Change_Reason_Banned: document equivalence to Channel.Banned error | |
271 | ||
272 | spec/Channel_Interface_Group.xml | 9 +++++++-- | |
273 | 1 files changed, 7 insertions(+), 2 deletions(-) | |
274 | ||
275 | commit a52a674aeb52e0e7244c0b80490b4f10d76d59ff | |
276 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
277 | Date: 2009-01-19 18:30:11 +0000 | |
278 | ||
279 | Explicitly say that the SelfHandle's removal reason in a Group that later closes is also the Channel's close reason | |
280 | ||
281 | spec/Channel_Interface_Group.xml | 8 ++++++++ | |
282 | 1 files changed, 8 insertions(+), 0 deletions(-) | |
283 | ||
284 | commit b9c42d86cedfa2617379855d8e47ac929725c57a | |
285 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
286 | Date: 2009-01-19 18:05:36 +0000 | |
287 | ||
288 | Attempt to explain what Channel_Group_Change_Reason_Invalid_Contact means | |
289 | ||
290 | spec/Channel_Interface_Group.xml | 12 ++++++++++-- | |
291 | 1 files changed, 10 insertions(+), 2 deletions(-) | |
292 | ||
293 | commit c487671f52d44d89668a8ffda3ad4337195d0488 | |
294 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
295 | Date: 2009-01-19 17:48:04 +0000 | |
296 | ||
297 | Connection: add ConnectionError signal | |
298 | ||
299 | spec/Connection.xml | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++ | |
300 | 1 files changed, 71 insertions(+), 0 deletions(-) | |
301 | ||
302 | commit 096f89a71c211a5bd14e2c5b29876ab81f777969 | |
303 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
304 | Date: 2009-01-19 17:30:28 +0000 | |
305 | ||
306 | errors: Add errors corresponding to Connection disconnect reasons | |
307 | ||
308 | spec/errors.xml | 130 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ | |
309 | 1 files changed, 130 insertions(+), 0 deletions(-) | |
310 | ||
311 | commit d8b5f6aefbf76a76e4fe78dedbd51295c888c08d | |
312 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
313 | Date: 2009-01-19 17:17:08 +0000 | |
314 | ||
315 | Cancelled error: may be used to represent Connection_Status_Reason_Requested or a user-closed channel | |
316 | ||
317 | spec/errors.xml | 14 +++++++++++++- | |
318 | 1 files changed, 13 insertions(+), 1 deletions(-) | |
319 | ||
320 | commit 8489dd898ca2e034741cbedd017614d116dcc0ab | |
321 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
322 | Date: 2009-01-19 17:16:18 +0000 | |
323 | ||
324 | Disconnected error: may be used to represent Connection_Status_Reason_None | |
325 | ||
326 | spec/errors.xml | 12 +++++++++++- | |
327 | 1 files changed, 11 insertions(+), 1 deletions(-) | |
328 | ||
36 | 329 | commit b3226d13c6b65cffd7553f9d4f596551b3a3df9d |
37 | 330 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> |
38 | 331 | Date: 2009-01-19 17:19:51 +0000 |
41 | 334 | |
42 | 335 | spec/Connection_Interface_Location.xml | 4 ++-- |
43 | 336 | 1 files changed, 2 insertions(+), 2 deletions(-) |
337 | ||
338 | commit abc55f9ebaaa8929ac5cec35b0f420541f3f9b50 | |
339 | Author: Simon McVittie <simon.mcvittie@collabora.co.uk> | |
340 | Date: 2009-01-19 17:15:50 +0000 | |
341 | ||
342 | Connection_Status_Reason: document equivalent D-Bus errors | |
343 | ||
344 | Also explain that changes to Connecting or Connected SHOULD always be for | |
345 | reason Requested, explain the three possibilities for Name_In_Use, and | |
346 | add more whitespace. | |
347 | ||
348 | spec/Connection.xml | 182 ++++++++++++++++++++++++++++++++++++++++++--------- | |
349 | 1 files changed, 151 insertions(+), 31 deletions(-) | |
44 | 350 | |
45 | 351 | commit 420617d5fea43c39fa074e239510919b9b212065 |
46 | 352 | Merge: b6c71e7... 9a9ef62... |
0 | 0 | This file contains the same edited highlights as the announcement emails. |
1 | 1 | For full details, see the ChangeLog in tarballs, or "git log" in Git |
2 | 2 | checkouts. |
3 | ||
4 | telepathy-spec 0.17.19 (2009-01-28) | |
5 | =================================== | |
6 | ||
7 | The "out of cheese error" release. | |
8 | ||
9 | Changes to experimental API: | |
10 | ||
11 | * Tube.Status is now called Tube.State to be more consistent | |
12 | ||
13 | New API: | |
14 | ||
15 | * Many new errors: NotCapable (a more specific form of NotAvailable), | |
16 | and D-Bus error forms of all the Connection disconnection reasons and | |
17 | all the error-like Group change reasons: Offline, Channel.Kicked, | |
18 | Busy, DoesNotExist, NoAnswer, AuthenticationFailed, EncryptionNotAvailable, | |
19 | EncryptionError, Cert.NotProvided, Cert.Untrusted, Cert.Expired, | |
20 | Cert.NotActivated, Cert.FingerprintMismatch, Cert.HostnameMismatch, | |
21 | Cert.SelfSigned, Cert.Invalid | |
22 | ||
23 | * ConnectionError, a signal which can emit extensible error information | |
24 | from the Connection just before StatusChanged(Disconnected, ...) is signalled | |
25 | ||
26 | New experimental API: | |
27 | ||
28 | * A preliminary design for audio, video and transport capabilities has been | |
29 | added to StreamedMedia.FUTURE and MediaSignalling.FUTURE | |
30 | ||
31 | Clarifications: | |
32 | ||
33 | * The reason for the SelfHandle being removed from a Group before a channel | |
34 | closes can be taken to be the error that the channel closed. | |
35 | (telepathy-glib already had this interpretation.) | |
36 | ||
37 | Tools: | |
38 | ||
39 | * It is now possible to have hyperlinks (or other HTML with attributes) | |
40 | in the specification markup format | |
3 | 41 | |
4 | 42 | telepathy-spec 0.17.18 (2009-01-20) |
5 | 43 | =================================== |
571 | 571 | </tp:docstring> |
572 | 572 | </tp:enumvalue> |
573 | 573 | <tp:enumvalue suffix="Offline" value="1"> |
574 | <tp:docstring> | |
575 | The change is due to a user going offline. Also used when | |
576 | user is already offline, but this wasn't known previously. | |
574 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
575 | <p>The change is due to a user going offline. Also used when | |
576 | user is already offline, but this wasn't known previously.</p> | |
577 | ||
578 | <p>If a one-to-one <tp:dbus-ref | |
579 | namespace="org.freedesktop.Telepathy.Channel.Type">StreamedMedia</tp:dbus-ref> | |
580 | call fails because the contact being called is offline, the | |
581 | connection manager SHOULD indicate this by removing both the | |
582 | <tp:member-ref>SelfHandle</tp:member-ref> and the other contact's | |
583 | handle from the Group interface with reason Offline.</p> | |
584 | ||
585 | <tp:rationale> | |
586 | For 1-1 calls, the call terminates as a result of removing the | |
587 | remote contact, so the SelfHandle should be removed at the same | |
588 | time as the remote contact and for the same reason. | |
589 | </tp:rationale> | |
590 | ||
591 | <p>If a handle is removed from a group for this reason, the | |
592 | equivalent D-Bus error is | |
593 | <code>org.freedesktop.Telepathy.Error.Offline</code>.</p> | |
577 | 594 | </tp:docstring> |
578 | 595 | </tp:enumvalue> |
579 | 596 | <tp:enumvalue suffix="Kicked" value="2"> |
580 | <tp:docstring> | |
581 | The change is due to a kick operation. | |
597 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
598 | <p>The change is due to a kick operation.</p> | |
599 | ||
600 | <p>If the <tp:member-ref>SelfHandle</tp:member-ref> is removed | |
601 | from a group for this reason, the equivalent D-Bus error is | |
602 | <code>org.freedesktop.Telepathy.Error.Channel.Kicked</code>. | |
603 | </p> | |
582 | 604 | </tp:docstring> |
583 | 605 | </tp:enumvalue> |
584 | 606 | <tp:enumvalue suffix="Busy" value="3"> |
585 | <tp:docstring> | |
586 | The change is due to a busy indication. | |
607 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
608 | <p>The change is due to a busy indication.</p> | |
609 | ||
610 | <p>If a one-to-one <tp:dbus-ref | |
611 | namespace="org.freedesktop.Telepathy.Channel.Type">StreamedMedia</tp:dbus-ref> | |
612 | call fails because the contact being called is busy, the | |
613 | connection manager SHOULD indicate this by removing both the | |
614 | <tp:member-ref>SelfHandle</tp:member-ref> and the other contact's | |
615 | handle from the Group interface with reason Busy.</p> | |
616 | ||
617 | <tp:rationale> | |
618 | For 1-1 calls, the call terminates as a result of removing the | |
619 | remote contact, so the SelfHandle should be removed at the same | |
620 | time as the remote contact and for the same reason. | |
621 | </tp:rationale> | |
622 | ||
623 | <p>If the <tp:member-ref>SelfHandle</tp:member-ref> is removed | |
624 | from a group for this reason, the equivalent D-Bus error is | |
625 | <code>org.freedesktop.Telepathy.Error.Busy</code>. | |
626 | </p> | |
587 | 627 | </tp:docstring> |
588 | 628 | </tp:enumvalue> |
589 | 629 | <tp:enumvalue suffix="Invited" value="4"> |
590 | 630 | <tp:docstring> |
591 | The change is due to an invitation. | |
631 | The change is due to an invitation. This reason SHOULD only be used | |
632 | when contacts are added to the remote-pending set (to indicate that | |
633 | the contact has been invited) or to the members (to indicate that | |
634 | the contact has accepted the invitation). | |
635 | ||
636 | <tp:rationale> | |
637 | Otherwise, what would it mean? | |
638 | </tp:rationale> | |
592 | 639 | </tp:docstring> |
593 | 640 | </tp:enumvalue> |
594 | 641 | <tp:enumvalue suffix="Banned" value="5"> |
595 | <tp:docstring> | |
596 | The change is due to a kick+ban operation. | |
642 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
643 | <p>The change is due to a kick+ban operation.</p> | |
644 | ||
645 | <p>If the <tp:member-ref>SelfHandle</tp:member-ref> is removed | |
646 | from a group for this reason, the equivalent D-Bus error is | |
647 | <code>org.freedesktop.Telepathy.Error.Channel.Banned</code>. | |
648 | </p> | |
597 | 649 | </tp:docstring> |
598 | 650 | </tp:enumvalue> |
599 | 651 | <tp:enumvalue suffix="Error" value="6"> |
602 | 654 | </tp:docstring> |
603 | 655 | </tp:enumvalue> |
604 | 656 | <tp:enumvalue suffix="Invalid_Contact" value="7"> |
605 | <tp:docstring> | |
606 | The change is because the requested contact does not exist. | |
657 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
658 | <p>The change is because the requested contact does not exist.</p> | |
659 | ||
660 | <p>For instance, if the user invites a nonexistent contact to a | |
661 | chatroom or attempts to call a nonexistent contact, this could | |
662 | be indicated by the CM adding that contact's handle to | |
663 | remote-pending for reason None or Invited, then removing it for | |
664 | reason Invalid_Contact. In the case of a 1-1 StreamedMedia | |
665 | call, the CM SHOULD remove the self handle from the Group | |
666 | in the same signal.</p> | |
667 | ||
668 | <tp:rationale> | |
669 | For 1-1 calls, the call terminates as a result of removing the | |
670 | remote contact, so the SelfHandle should be removed at the same | |
671 | time as the remote contact and for the same reason. | |
672 | </tp:rationale> | |
673 | ||
674 | <p>If a contact is removed from a group for this reason, the | |
675 | equivalent D-Bus error is | |
676 | <code>org.freedesktop.Telepathy.Error.DoesNotExist</code>. | |
677 | </p> | |
607 | 678 | </tp:docstring> |
608 | 679 | </tp:enumvalue> |
609 | 680 | <tp:enumvalue suffix="No_Answer" value="8"> |
610 | <tp:docstring> | |
611 | The change is because the requested contact did not respond. | |
681 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
682 | <p>The change is because the requested contact did not respond.</p> | |
683 | ||
684 | <p>If a one-to-one <tp:dbus-ref | |
685 | namespace="org.freedesktop.Telepathy.Channel.Type">StreamedMedia</tp:dbus-ref> | |
686 | call fails because the contact being called did not respond, the | |
687 | connection manager SHOULD indicate this by removing both the | |
688 | <tp:member-ref>SelfHandle</tp:member-ref> and the other contact's | |
689 | handle from the Group interface with reason No_Answer.</p> | |
690 | ||
691 | <tp:rationale> | |
692 | Documenting existing practice. | |
693 | </tp:rationale> | |
694 | ||
695 | <p>If a contact is removed from a group for this reason, the | |
696 | equivalent D-Bus error is | |
697 | <code>org.freedesktop.Telepathy.Error.NoAnswer</code>. | |
698 | </p> | |
612 | 699 | </tp:docstring> |
613 | 700 | </tp:enumvalue> |
614 | 701 | <tp:enumvalue suffix="Renamed" value="9"> |
615 | <tp:docstring> | |
616 | The change is because a contact's unique identifier changed. | |
702 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
703 | <p>The change is because a contact's unique identifier changed. | |
617 | 704 | There must be exactly one handle in the removed set and exactly |
618 | 705 | one handle in one of the added sets. The <tp:dbus-ref |
619 | 706 | namespace="org.freedesktop.Telepathy.Connection.Interface.Renaming">Renamed</tp:dbus-ref> |
621 | 708 | <tp:dbus-ref |
622 | 709 | namespace="org.freedesktop.Telepathy.Connection.Interface">Renaming</tp:dbus-ref> |
623 | 710 | interface will have been emitted for the same handles, |
624 | shortly before this <tp:member-ref>MembersChanged</tp:member-ref> signal is emitted. | |
711 | shortly before this <tp:member-ref>MembersChanged</tp:member-ref> signal is emitted.</p> | |
625 | 712 | </tp:docstring> |
626 | 713 | </tp:enumvalue> |
627 | 714 | <tp:enumvalue suffix="Permission_Denied" value="10"> |
628 | <tp:docstring> | |
629 | The change is because there was no permission to contact the | |
630 | requested handle. | |
715 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
716 | <p>The change is because there was no permission to contact the | |
717 | requested handle.</p> | |
718 | ||
719 | <p>If a contact is removed from a group for this reason, the | |
720 | equivalent D-Bus error is | |
721 | <code>org.freedesktop.Telepathy.Error.PermissionDenied</code>. | |
722 | </p> | |
631 | 723 | </tp:docstring> |
632 | 724 | </tp:enumvalue> |
633 | 725 | <tp:enumvalue suffix="Separated" value="11"> |
656 | 748 | the group with reason Separated. Application protocols in Tubes |
657 | 749 | should be prepared to cope with this situation. |
658 | 750 | </p> |
751 | ||
752 | <p>The <tp:member-ref>SelfHandle</tp:member-ref> SHOULD NOT be | |
753 | removed from channels with this reason.</p> | |
659 | 754 | </tp:docstring> |
660 | 755 | </tp:enumvalue> |
661 | 756 | </tp:enum> |
936 | 1031 | should be emitted when information |
937 | 1032 | is retrieved from the server, or changes occur.</p> |
938 | 1033 | |
1034 | <p>If the <tp:member-ref>MembersChanged</tp:member-ref> or | |
1035 | <tp:member-ref>MembersChangedDetailed</tp:member-ref> signal indicates | |
1036 | that the <tp:member-ref>SelfHandle</tp:member-ref> has been removed from | |
1037 | the channel, and the channel subsequently emits <tp:dbus-ref | |
1038 | namespace="org.freedesktop.Telepathy.Channel">Closed</tp:dbus-ref>, | |
1039 | clients SHOULD consider the details given in the MembersChanged or | |
1040 | MembersChangedDetailed signal to be the reason why the channel closed.</p> | |
1041 | ||
939 | 1042 | <p>Addition of members to the channel may be requested by using |
940 | 1043 | <tp:member-ref>AddMembers</tp:member-ref>. If |
941 | 1044 | remote acknowledgement is required, use of the AddMembers method will cause |
20 | 20 | <interface name="org.freedesktop.Telepathy.Channel.Interface.MediaSignalling"> |
21 | 21 | <tp:requires interface="org.freedesktop.Telepathy.Channel"/> |
22 | 22 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.StreamedMedia"/> |
23 | ||
24 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
25 | <p>An interface for signalling a channel containing synchronised media | |
26 | sessions which can contain an arbitrary number of streams. The | |
27 | presence of this interface on a Channel indicates that the connection | |
28 | manager will not carry out the actual streaming for this channel, | |
29 | and that the client handling the channel is responsible for doing | |
30 | so; in most cases we recommend doing this by using the | |
31 | telepathy-farsight library.</p> | |
32 | ||
33 | <tp:rationale> | |
34 | <p>Streaming audio and (particularly) video requires a high level of | |
35 | integration with the UI, and having the connection manager act as | |
36 | a proxy would be likely to introduce unacceptable latency. As a | |
37 | result, audio/video streaming is offloaded into the client | |
38 | where possible, as an exception to the general design of | |
39 | Telepathy.</p> | |
40 | </tp:rationale> | |
41 | ||
42 | <p>The negotiation interface is based on the API of the | |
43 | <a href="http://farsight.freedesktop.org/">Farsight</a> library. | |
44 | This, in turn, is based upon the IETF MMusic ICE drafts, where | |
45 | connections are established by signalling potential connection | |
46 | candidates to the peer until a usable connection is found, and | |
47 | codecs are negotiated with an SDP-style offer and answer. However, | |
48 | the principles should be applicable to other media streaming methods | |
49 | and the API re-used without difficulty.</p> | |
50 | ||
51 | <p>Note that the naming conventions used in the MediaStreamHandler | |
52 | and MediaSessionHandler interfaces are rather confusing; methods | |
53 | have signal-like names and signals have method-like names, due to | |
54 | the API being based rather too closely on that of Farsight. This | |
55 | is for historical reasons and will be fixed in a future release | |
56 | of the Telepathy specification.</p> | |
57 | </tp:docstring> | |
23 | 58 | |
24 | 59 | <tp:simple-type name="Media_Session_Type" type="s"> |
25 | 60 | <tp:docstring>The type of a media session. Currently, the only supported |
104 | 139 | </tp:docstring> |
105 | 140 | </tp:property> |
106 | 141 | |
107 | <tp:docstring> | |
108 | An interface for signalling a channel containing synchronised media | |
109 | sessions which can contain an arbitrary number of streams. The negotiation | |
110 | interface is based closely around the API of the Farsight library | |
111 | (http://farsight.sourceforge.net/). This in turn is based upon the IETF | |
112 | MMusic ICE drafts where connections are established by signalling potential | |
113 | connection candidates to the peer until a usable connection is found, and | |
114 | codecs are negotiated with an SDP-style offer and answer. However, the | |
115 | principles should be applicable to other media streaming methods and the | |
116 | API re-used without difficulty. | |
117 | </tp:docstring> | |
118 | 142 | </interface> |
119 | 143 | </node> |
120 | 144 | <!-- vim:set sw=2 sts=2 et ft=xml: --> |
0 | <?xml version="1.0" ?> | |
1 | <node name="/Channel_Interface_Media_Signalling_Future" | |
2 | xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> | |
3 | <tp:copyright> Copyright (C) 2009 Collabora Limited </tp:copyright> | |
4 | <tp:copyright> Copyright (C) 2009 Nokia Corporation </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, | |
19 | USA.</p> | |
20 | </tp:license> | |
21 | <interface name="org.freedesktop.Telepathy.Channel.Interface.MediaSignalling.FUTURE"> | |
22 | <tp:requires interface="org.freedesktop.Telepathy.Channel"/> | |
23 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.StreamedMedia"/> | |
24 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.MediaSignalling"/> | |
25 | ||
26 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
27 | <p>This interface contains functionality which we intend to incorporate | |
28 | into the <tp:dbus-ref | |
29 | namespace="org.freedesktop.Telepathy">Channel.Interface.MediaSignalling</tp:dbus-ref> | |
30 | interface in future. It should be considered to be conceptually part | |
31 | of the core MediaSignalling interface, but without API or ABI | |
32 | guarantees.</p> | |
33 | ||
34 | <tp:rationale> | |
35 | <p>The rationale is the same as for <tp:dbus-ref | |
36 | namespace="org.freedesktop.Telepathy">Channel.FUTURE</tp:dbus-ref>.</p> | |
37 | </tp:rationale> | |
38 | </tp:docstring> | |
39 | ||
40 | <property name="ICETransportAvailable" | |
41 | tp:name-for-bindings="ICE_Transport_Available" | |
42 | type="b" access="read"> | |
43 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
44 | <p>True if this channel supports the use of the ICE-UDP transport | |
45 | (<a href="http://xmpp.org/extensions/xep-0176.html">XEP-0176</a>, | |
46 | <a href="http://tools.ietf.org/html/draft-ietf-mmusic-ice">ICE RFC | |
47 | draft)</a>. Various other transports have boolean properties | |
48 | that work in the same way as this one, so this description covers | |
49 | all such transports.</p> | |
50 | ||
51 | <p>This property is immutable (cannot change), and therefore SHOULD | |
52 | appear wherever immutable properties are reported, e.g. <tp:dbus-ref | |
53 | namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">NewChannels</tp:dbus-ref> | |
54 | signals.</p> | |
55 | ||
56 | <p>Connection managers capable of signalling streamed media calls to | |
57 | contacts SHOULD include the properties representing all supported | |
58 | transports in the allowed properties list of the channel class | |
59 | in <tp:dbus-ref | |
60 | namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">RequestableChannelClasses</tp:dbus-ref> | |
61 | that advertises support for streamed media channels.</p> | |
62 | ||
63 | <p>Similarly, connection managers that support the <tp:dbus-ref | |
64 | namespace="org.freedesktop.Telepathy.Connection.Interface">ContactCapabilities.DRAFT</tp:dbus-ref> | |
65 | interface SHOULD include all supported transports in the allowed | |
66 | properties list of the channel class that advertises a contact's | |
67 | ability to receive streamed media calls.</p> | |
68 | ||
69 | <p>Clients that are able to receive calls with particular NAT | |
70 | traversal mechanisms MAY include the following filters if | |
71 | calling <tp:dbus-ref | |
72 | namespace="org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities.DRAFT">SetSelfCapabilities</tp:dbus-ref> | |
73 | (clients of a <tp:dbus-ref | |
74 | namespace="org.freedesktop.Telepathy">ChannelDispatcher.DRAFT</tp:dbus-ref> | |
75 | SHOULD instead arrange for the ChannelDispatcher to do this, | |
76 | by including the filters in their <tp:dbus-ref | |
77 | namespace="org.freedesktop.Telepathy.Client.Handler.DRAFT">HandlerChannelFilter</tp:dbus-ref> | |
78 | properties):</p> | |
79 | ||
80 | <ul> | |
81 | <li>{ ChannelType = StreamedMedia, ICETransportAvailable = true } | |
82 | if the ICE transport is supported</li> | |
83 | <li>{ ChannelType = StreamedMedia, RawUDPTransportAvailable = true } | |
84 | if the raw UDP transport is supported</li> | |
85 | <li>... and so on, one filter per available transport.</li> | |
86 | </ul> | |
87 | ||
88 | <p>Connection managers MAY use this information to adjust the | |
89 | transports for which they advertise support to other contacts. | |
90 | If a client has indicated support for any particular transports, | |
91 | the connection manager SHOULD advertise support for | |
92 | each transport that is supported by any client, and also | |
93 | supported by the CM itself.</p> | |
94 | ||
95 | <tp:rationale> | |
96 | <p>This minimizes the possibility that a call will be started that | |
97 | cannot in fact succeed, because the intersection of the contacts' | |
98 | available transports is empty.</p> | |
99 | </tp:rationale> | |
100 | ||
101 | <p>If no client has mentioned any of the transports known to the | |
102 | connection manager in a call to SetSelfCapabilities, the connection | |
103 | manager SHOULD advertise support for every transport that it can | |
104 | signal.</p> | |
105 | ||
106 | <tp:rationale> | |
107 | <p>This simplifies implementation on integrated platforms like Maemo, | |
108 | where it can be assumed that client libraries will support all the | |
109 | "standard" transports known to any connection manager, and | |
110 | lowers the "barrier to entry" for new Telepathy clients.</p> | |
111 | </tp:rationale> | |
112 | ||
113 | <p>Clients making outgoing calls for which the same client that made | |
114 | the request will handle the streaming MAY indicate their ability or | |
115 | inability to handle particular transports by including | |
116 | <code>ICETransportAvailable = true</code>, | |
117 | <code>RawUDPTransportAvailable = false</code>, etc. | |
118 | in the request properties parameter of their call to <tp:dbus-ref | |
119 | namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">EnsureChannel</tp:dbus-ref> | |
120 | or similar functions. When they do so, the connection manager | |
121 | SHOULD attempt to use a transport that the client has indicated | |
122 | it is able to handle; if this is not possible, the connection | |
123 | manager SHOULD raise an error instead of creating a channel.</p> | |
124 | ||
125 | <tp:rationale> | |
126 | <p>This enables such clients to restrict the CM to the subset of | |
127 | transports supported by that particular client.</p> | |
128 | </tp:rationale> | |
129 | ||
130 | <p>Clients making outgoing calls for which they will not themselves | |
131 | handle the streaming (e.g. an address book starting a call which | |
132 | will be streamed by a separate call UI) SHOULD NOT include those | |
133 | properties in the request.</p> | |
134 | ||
135 | <tp:rationale> | |
136 | <p>In general, such a client can't know the capabilities of the | |
137 | streaming implementation, or even which streaming implementation | |
138 | will be used.</p> | |
139 | </tp:rationale> | |
140 | ||
141 | <p>In the absence of any indication of supported transports from the | |
142 | client, the connection manager SHOULD assume that the transports | |
143 | indicated by calling SetSelfCapabilities are available. If | |
144 | no transports were indicated as supported by calling | |
145 | SetSelfCapabilities either, it SHOULD assume that any transport | |
146 | that it can signal will be acceptable.</p> | |
147 | ||
148 | <p>If this property, or any of the similar transport availability | |
149 | properties, is passed to EnsureChannel (as opposed to CreateChannel), | |
150 | the connection manager SHOULD ignore these properties when checking | |
151 | whether it can return an existing channel as suitable; these | |
152 | properties only become significant when the connection manager has | |
153 | decided to create a new channel.</p> | |
154 | </tp:docstring> | |
155 | </property> | |
156 | ||
157 | <property name="RawUDPTransportAvailable" | |
158 | tp:name-for-bindings="Raw_UDP_Transport_Available" | |
159 | type="b" access="read"> | |
160 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
161 | <p>The same as <tp:member-ref>ICETransportAvailable</tp:member-ref>, | |
162 | but for raw UDP streaming as described by <a | |
163 | href="http://xmpp.org/extensions/xep-0177.html">XEP-0177</a>.</p> | |
164 | </tp:docstring> | |
165 | </property> | |
166 | ||
167 | <property name="GoogleP2PTransportAvailable" | |
168 | tp:name-for-bindings="Google_P2P_Transport_Available" | |
169 | type="b" access="read"> | |
170 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
171 | <p>The same as <tp:member-ref>ICETransportAvailable</tp:member-ref>, | |
172 | but for the variant of ICE used by the Google Talk peer-to-peer | |
173 | connectivity establishment mechanism (as implemented in libjingle | |
174 | 0.3).</p> | |
175 | </tp:docstring> | |
176 | </property> | |
177 | ||
178 | <property name="MSNTransportAvailable" | |
179 | tp:name-for-bindings="MSN_Transport_Available" | |
180 | type="b" access="read"> | |
181 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
182 | <p>The same as <tp:member-ref>ICETransportAvailable</tp:member-ref>, | |
183 | but for the variant of ICE used by MSN.</p> | |
184 | </tp:docstring> | |
185 | </property> | |
186 | ||
187 | </interface> | |
188 | </node> |
67 | 67 | </tp:docstring> |
68 | 68 | </property> |
69 | 69 | |
70 | <property name="Status" type="u" tp:type="Tube_Channel_State" access="read" | |
71 | tp:name-for-bindings="Status"> | |
70 | <property name="State" type="u" tp:type="Tube_Channel_State" access="read" | |
71 | tp:name-for-bindings="State"> | |
72 | 72 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
73 | <p>Status of the tube in this channel.</p> | |
73 | <p>State of the tube in this channel.</p> | |
74 | 74 | <p>When requesting a channel with |
75 | 75 | <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>, |
76 | 76 | this property MUST NOT be included in the request.</p> |
127 | 127 | For a multi-user (i.e. Handle_Type_Room) D-Bus tube, a mapping |
128 | 128 | between contact handles and their unique bus names on this tube. |
129 | 129 | For a peer-to-peer (i.e. Handle_Type_Contact) D-Bus tube, the empty |
130 | list. Change notification is via | |
130 | dictionary. Change notification is via | |
131 | 131 | <tp:member-ref>DBusNamesChanged</tp:member-ref>. |
132 | 132 | </tp:docstring> |
133 | 133 | </property> |
19 | 19 | </tp:license> |
20 | 20 | <interface name="org.freedesktop.Telepathy.Channel.Type.FileTransfer"> |
21 | 21 | <tp:requires interface="org.freedesktop.Telepathy.Channel"/> |
22 | <tp:added version="0.17.UNRELEASED">(as stable API)</tp:added> | |
22 | <tp:added version="0.17.18">(as stable API)</tp:added> | |
23 | 23 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
24 | 24 | <p>A channel type for transferring files. The |
25 | 25 | transmission of data between contacts is achieved by reading from |
207 | 207 | will be emitted with the |
208 | 208 | MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again |
209 | 209 | with the flag cleared when the remote end has replied.</p> |
210 | ||
211 | <p>If streams of the requested types have already been requested | |
212 | via this method or <tp:dbus-ref | |
213 | namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">FUTURE.InitialAudio</tp:dbus-ref>/<tp:dbus-ref | |
214 | namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">FUTURE.InitialVideo</tp:dbus-ref>, | |
215 | this method SHOULD return successfully.</p> | |
210 | 216 | </tp:docstring> |
211 | 217 | <tp:changed version="0.17.2"> |
212 | 218 | <p>It is valid to use a handle which is neither |
372 | 378 | |
373 | 379 | <p>In the past, several other patterns have been used to place outgoing |
374 | 380 | calls; see |
375 | <tt>http://telepathy.freedesktop.org/wiki/Requesting%20StreamedMedia%20channels</tt> | |
381 | <a href="http://telepathy.freedesktop.org/wiki/Requesting%20StreamedMedia%20channels">'Requesting StreamedMedia Channels' on the Telepathy wiki</a> | |
376 | 382 | for the details.</p> |
377 | 383 | |
378 | 384 | <p>In general this should be used in conjunction with the <tp:dbus-ref |
390 | 396 | The channel-type-specific capability flags used for |
391 | 397 | Channel.Type.StreamedMedia in the <tp:dbus-ref |
392 | 398 | namespace="org.freedesktop.Telepathy">Connection.Interface.Capabilities</tp:dbus-ref> |
393 | interface. | |
399 | interface. See the <tp:dbus-ref | |
400 | namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">FUTURE.InitialAudio</tp:dbus-ref> | |
401 | property for details of the mechanisms that will replace this. | |
394 | 402 | </tp:docstring> |
395 | 403 | <tp:flag suffix="Audio" value="1"> |
396 | 404 | <tp:docstring> |
0 | <?xml version="1.0" ?> | |
1 | <node name="/Channel_Type_Streamed_Media_Future" | |
2 | xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> | |
3 | <tp:copyright> Copyright (C) 2009 Collabora Limited </tp:copyright> | |
4 | <tp:copyright> Copyright (C) 2009 Nokia Corporation </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, | |
19 | USA.</p> | |
20 | </tp:license> | |
21 | <interface name="org.freedesktop.Telepathy.Channel.Type.StreamedMedia.FUTURE"> | |
22 | <tp:requires interface="org.freedesktop.Telepathy.Channel"/> | |
23 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.StreamedMedia"/> | |
24 | ||
25 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
26 | <p>This interface contains functionality which we intend to incorporate | |
27 | into the <tp:dbus-ref | |
28 | namespace="org.freedesktop.Telepathy">Channel.Type.StreamedMedia</tp:dbus-ref> | |
29 | interface in future. It should be considered to be conceptually part | |
30 | of the core StreamedMedia interface, but without API or ABI | |
31 | guarantees.</p> | |
32 | ||
33 | <tp:rationale> | |
34 | <p>The rationale is the same as for <tp:dbus-ref | |
35 | namespace="org.freedesktop.Telepathy">Channel.FUTURE</tp:dbus-ref>.</p> | |
36 | </tp:rationale> | |
37 | </tp:docstring> | |
38 | ||
39 | <property name="InitialAudio" tp:name-for-bindings="Initial_Audio" | |
40 | type="b" access="read"> | |
41 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
42 | <p>If set to true in a channel request that will create a new channel, | |
43 | the connection manager should immediately attempt to establish an | |
44 | audio stream to the remote contact, making it unnecessary for the | |
45 | client to call <tp:dbus-ref | |
46 | namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">RequestStreams</tp:dbus-ref>.</p> | |
47 | ||
48 | <p>If this property, or InitialVideo, is passed to EnsureChannel | |
49 | (as opposed to CreateChannel), the connection manager SHOULD ignore | |
50 | these properties when checking whether it can return an existing | |
51 | channel as suitable; these properties only become significant when | |
52 | the connection manager has decided to create a new channel.</p> | |
53 | ||
54 | <p>If true on a requested channel, this indicates that the audio | |
55 | stream has already been requested and the client does not need to | |
56 | call RequestStreams, although it MAY still do so.</p> | |
57 | ||
58 | <p>If true on an unrequested (incoming) channel, this indicates that | |
59 | the remote contact initially requested an audio stream; this does | |
60 | not imply that that audio stream is still active (as indicated by | |
61 | <tp:dbus-ref | |
62 | namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">ListStreams</tp:dbus-ref>).</p> | |
63 | ||
64 | <p>This property is immutable (cannot change), and therefore SHOULD | |
65 | appear wherever immutable properties are reported, e.g. <tp:dbus-ref | |
66 | namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">NewChannels</tp:dbus-ref> | |
67 | signals.</p> | |
68 | ||
69 | <tp:rationale><p>This reduces D-Bus round trips.</p></tp:rationale> | |
70 | ||
71 | <p>Connection managers capable of signalling audio calls to contacts | |
72 | SHOULD include a channel class in <tp:dbus-ref | |
73 | namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">RequestableChannelClasses</tp:dbus-ref> | |
74 | with <tp:dbus-ref | |
75 | namespace="org.freedesktop.Telepathy.Channel">ChannelType</tp:dbus-ref> | |
76 | = <tp:dbus-ref | |
77 | namespace="org.freedesktop.Telepathy.Channel.Type">StreamedMedia</tp:dbus-ref> | |
78 | and <tp:dbus-ref | |
79 | namespace="org.freedesktop.Telepathy.Channel">TargetHandleType</tp:dbus-ref> | |
80 | = Contact in the fixed properties dictionary, and InitialAudio | |
81 | (and also InitialVideo, if applicable) in the allowed properties | |
82 | list. Clients wishing to discover whether a connection manager | |
83 | can signal audio and/or video calls SHOULD use this information.</p> | |
84 | ||
85 | <tp:rationale> | |
86 | <p>Not all protocols support signalling video calls, and it would be | |
87 | possible (although unlikely) to have a protocol where only video, | |
88 | and not audio, could be signalled.</p> | |
89 | </tp:rationale> | |
90 | ||
91 | <p>Connection managers that support the <tp:dbus-ref | |
92 | namespace="org.freedesktop.Telepathy.Connection.Interface">ContactCapabilities.DRAFT</tp:dbus-ref> | |
93 | interface SHOULD represent the capabilities of receiving audio | |
94 | and/or video calls by including a channel class in | |
95 | a contact's capabilities with ChannelType = StreamedMedia | |
96 | in the fixed properties dictionary, and InitialAudio and/or | |
97 | InitialVideo in the allowed properties list. Clients wishing to | |
98 | discover whether a particular contact is likely to be able to | |
99 | receive audio and/or video calls SHOULD use this information.</p> | |
100 | ||
101 | <tp:rationale> | |
102 | <p>Not all clients support video calls, and it would also be | |
103 | possible (although unlikely) to have a client which could only | |
104 | stream video, not audio.</p> | |
105 | </tp:rationale> | |
106 | ||
107 | <p>Clients that are willing to receive audio and/or video calls | |
108 | SHOULD include the following filters if calling <tp:dbus-ref | |
109 | namespace="org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities.DRAFT">SetSelfCapabilities</tp:dbus-ref> | |
110 | (clients of a <tp:dbus-ref | |
111 | namespace="org.freedesktop.Telepathy">ChannelDispatcher.DRAFT</tp:dbus-ref> | |
112 | SHOULD instead arrange for the ChannelDispatcher to do this, | |
113 | by including the filters in their <tp:dbus-ref | |
114 | namespace="org.freedesktop.Telepathy.Client.Handler.DRAFT">HandlerChannelFilter</tp:dbus-ref> | |
115 | properties):</p> | |
116 | ||
117 | <ul> | |
118 | <li>{ ChannelType = StreamedMedia }</li> | |
119 | <li>{ ChannelType = StreamedMedia, InitialAudio = true } | |
120 | if receiving audio-only or audio+video calls is supported</li> | |
121 | <li>{ ChannelType = StreamedMedia, InitialVideo = true } | |
122 | if receiving video-only or audio+video calls is supported</li> | |
123 | </ul> | |
124 | ||
125 | <tp:rationale> | |
126 | <p>Connection managers for protocols with capability discovery, | |
127 | like XMPP, need this information to advertise the appropriate | |
128 | capabilities for their protocol.</p> | |
129 | </tp:rationale> | |
130 | ||
131 | <p>If { ChannelType = StreamedMedia } is passed to | |
132 | SetSelfCapabilities, but no more specific channel class for | |
133 | audio or video has been passed to that method (in the presence | |
134 | of a ChannelDispatcher, this would mean that there is at least one | |
135 | client with that channel class in its HandlerChannelFilter, but | |
136 | no installed client has the more specific channel classes in its | |
137 | HandlerChannelFilter), then the connection manager SHOULD advertise | |
138 | support for every content type (audio or video) that it | |
139 | supports.</p> | |
140 | ||
141 | <tp:rationale> | |
142 | <p>This lowers the "barrier to entry" by allowing a simple client | |
143 | to say merely that it supports streamed media at all.</p> | |
144 | </tp:rationale> | |
145 | </tp:docstring> | |
146 | </property> | |
147 | ||
148 | <property name="InitialVideo" tp:name-for-bindings="Initial_Video" | |
149 | type="b" access="read"> | |
150 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
151 | <p>The same as <tp:member-ref>InitialAudio</tp:member-ref>, but for | |
152 | a video stream. This property is immutable (cannot change).</p> | |
153 | ||
154 | <p>In particular, note that if this property is false, this does not | |
155 | imply that an active video stream has not been added, only that no | |
156 | video stream was active at the time the channel appeared.</p> | |
157 | ||
158 | <p>This property is the correct way to discover whether connection | |
159 | managers, contacts etc. support video calls; it appears in | |
160 | capabilities structures in the same way as InitialAudio.</p> | |
161 | </tp:docstring> | |
162 | </property> | |
163 | ||
164 | </interface> | |
165 | </node> |
491 | 491 | The requested channel type cannot be created with the given handle |
492 | 492 | </tp:docstring> |
493 | 493 | </tp:error> |
494 | <tp:error name="org.freedesktop.Telepathy.Error.NotCapable"> | |
495 | <tp:docstring> | |
496 | The requested channel cannot be created because contact doesn't | |
497 | have the required capabilities. | |
498 | </tp:docstring> | |
499 | </tp:error> | |
494 | 500 | <tp:error name="org.freedesktop.Telepathy.Error.Channel.Banned"/> |
495 | 501 | <tp:error name="org.freedesktop.Telepathy.Error.Channel.Full"/> |
496 | 502 | <tp:error name="org.freedesktop.Telepathy.Error.Channel.InviteOnly"/> |
632 | 638 | </tp:docstring> |
633 | 639 | </tp:enumvalue> |
634 | 640 | </tp:enum> |
641 | ||
635 | 642 | <tp:enum name="Connection_Status_Reason" type="u"> |
643 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
644 | <p>A reason why the status of the connection changed. Apart from | |
645 | Requested, the values of this enumeration only make sense as | |
646 | reasons why the status changed to Disconnected.</p> | |
647 | </tp:docstring> | |
648 | ||
636 | 649 | <tp:enumvalue suffix="None_Specified" value="0"> |
637 | <tp:docstring> | |
638 | There is no reason set for this state change. | |
639 | </tp:docstring> | |
640 | </tp:enumvalue> | |
650 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
651 | <p>There is no reason set for this state change. Unknown status | |
652 | reasons SHOULD be treated like this reason.</p> | |
653 | ||
654 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
655 | <code>org.freedesktop.Telepathy.Error.Disconnected</code>.</p> | |
656 | </tp:docstring> | |
657 | </tp:enumvalue> | |
658 | ||
641 | 659 | <tp:enumvalue suffix="Requested" value="1"> |
642 | <tp:docstring> | |
643 | The change is in response to a user request. | |
644 | </tp:docstring> | |
645 | </tp:enumvalue> | |
660 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
661 | <p>The change is in response to a user request. Changes to the | |
662 | Connecting or Connected status SHOULD always indicate this reason; | |
663 | changes to the Disconnected status SHOULD indicate this reason | |
664 | if and only if the disconnection was requested by the user.</p> | |
665 | ||
666 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
667 | <code>org.freedesktop.Telepathy.Error.Cancelled</code>.</p> | |
668 | </tp:docstring> | |
669 | </tp:enumvalue> | |
670 | ||
646 | 671 | <tp:enumvalue suffix="Network_Error" value="2"> |
647 | <tp:docstring> | |
648 | There was an error sending or receiving on the network socket. | |
649 | </tp:docstring> | |
650 | </tp:enumvalue> | |
672 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
673 | <p>There was an error sending or receiving on the network socket.</p> | |
674 | ||
675 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
676 | <code>org.freedesktop.Telepathy.Error.NetworkError</code>.</p> | |
677 | </tp:docstring> | |
678 | </tp:enumvalue> | |
679 | ||
651 | 680 | <tp:enumvalue suffix="Authentication_Failed" value="3"> |
652 | <tp:docstring> | |
653 | The username or password was invalid. | |
654 | </tp:docstring> | |
655 | </tp:enumvalue> | |
681 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
682 | <p>The username or password was invalid.</p> | |
683 | ||
684 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
685 | <code>org.freedesktop.Telepathy.Error.AuthenticationFailed</code>. | |
686 | </p> | |
687 | </tp:docstring> | |
688 | </tp:enumvalue> | |
689 | ||
656 | 690 | <tp:enumvalue suffix="Encryption_Error" value="4"> |
657 | <tp:docstring> | |
658 | There was an error negotiating SSL on this connection, or | |
691 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
692 | <p>There was an error negotiating SSL on this connection, or | |
659 | 693 | encryption was unavailable and require-encryption was set when the |
660 | connection was created. | |
661 | </tp:docstring> | |
662 | </tp:enumvalue> | |
694 | connection was created.</p> | |
695 | ||
696 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
697 | <code>org.freedesktop.Telepathy.Error.EncryptionNotAvailable</code> | |
698 | if encryption was not available at all, or | |
699 | <code>org.freedesktop.Telepathy.Error.EncryptionError</code> | |
700 | if encryption failed.</p> | |
701 | </tp:docstring> | |
702 | </tp:enumvalue> | |
703 | ||
663 | 704 | <tp:enumvalue suffix="Name_In_Use" value="5"> |
664 | <tp:docstring> | |
665 | Someone is already connected to the server using the name | |
666 | you are trying to connect with. | |
667 | </tp:docstring> | |
668 | </tp:enumvalue> | |
705 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
706 | <p>In general, this reason indicates that the requested account | |
707 | name or other identification could not be used due to conflict | |
708 | with another connection. It can be divided into three cases:</p> | |
709 | ||
710 | <ul> | |
711 | <li>If the status change is from Connecting to Disconnected | |
712 | and the 'register' parameter to RequestConnection was present | |
713 | and true, the requested account could not be created on the | |
714 | server because it already exists.</li> | |
715 | ||
716 | <li>If the status change is from Connecting to Disconnected | |
717 | but the 'register' parameter is absent or false, the connection | |
718 | manager could not connect to the specified account because | |
719 | a connection to that account already exists. | |
720 | ||
721 | <tp:rationale> | |
722 | In some protocols, like XMPP (when connecting with the same | |
723 | JID and resource as an existing connection), the existing | |
724 | connection "wins" and the new one fails to connect. | |
725 | </tp:rationale> | |
726 | </li> | |
727 | ||
728 | <li>If the status change is from Connected to Disconnected, | |
729 | the existing connection was automatically disconnected because | |
730 | a new connection to the same account (perhaps from a different | |
731 | client or location) was established. | |
732 | ||
733 | <tp:rationale> | |
734 | In some protocols, like MSNP (when connecting twice with the | |
735 | same Passport), the new connection "wins" and the | |
736 | existing one is automatically disconnected. | |
737 | </tp:rationale> | |
738 | </li> | |
739 | </ul> | |
740 | ||
741 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
742 | <code>org.freedesktop.Telepathy.Error.NotYours</code>. | |
743 | </p> | |
744 | ||
745 | <tp:rationale> | |
746 | These three errors are distinct but very similar, and can be | |
747 | distinguished by other factors. | |
748 | </tp:rationale> | |
749 | </tp:docstring> | |
750 | </tp:enumvalue> | |
751 | ||
669 | 752 | <tp:enumvalue suffix="Cert_Not_Provided" value="6"> |
670 | <tp:docstring> | |
671 | The server did not provide a SSL certificate. | |
672 | </tp:docstring> | |
673 | </tp:enumvalue> | |
753 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
754 | <p>The server did not provide a SSL certificate.</p> | |
755 | ||
756 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
757 | <code>org.freedesktop.Telepathy.Error.Cert.NotProvided</code>. | |
758 | </p> | |
759 | </tp:docstring> | |
760 | </tp:enumvalue> | |
761 | ||
674 | 762 | <tp:enumvalue suffix="Cert_Untrusted" value="7"> |
675 | <tp:docstring> | |
676 | The server's SSL certificate could not be trusted. | |
677 | </tp:docstring> | |
678 | </tp:enumvalue> | |
763 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
764 | <p>The server's SSL certificate is signed by an untrusted certifying | |
765 | authority. This error SHOULD NOT be used to represent a self-signed | |
766 | certificate: use the more specific Cert_Self_Signed reason for | |
767 | that.</p> | |
768 | ||
769 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
770 | <code>org.freedesktop.Telepathy.Error.Cert.Untrusted</code>. | |
771 | </p> | |
772 | </tp:docstring> | |
773 | </tp:enumvalue> | |
774 | ||
679 | 775 | <tp:enumvalue suffix="Cert_Expired" value="8"> |
680 | <tp:docstring> | |
681 | The server's SSL certificate has expired. | |
682 | </tp:docstring> | |
683 | </tp:enumvalue> | |
776 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
777 | <p>The server's SSL certificate has expired.</p> | |
778 | ||
779 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
780 | <code>org.freedesktop.Telepathy.Error.Cert.Expired</code>. | |
781 | </p> | |
782 | </tp:docstring> | |
783 | </tp:enumvalue> | |
784 | ||
684 | 785 | <tp:enumvalue suffix="Cert_Not_Activated" value="9"> |
685 | <tp:docstring> | |
686 | The server's SSL certificate is not yet valid. | |
687 | </tp:docstring> | |
688 | </tp:enumvalue> | |
786 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
787 | <p>The server's SSL certificate is not yet valid.</p> | |
788 | ||
789 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
790 | <code>org.freedesktop.Telepathy.Error.Cert.NotActivated</code>. | |
791 | </p> | |
792 | </tp:docstring> | |
793 | </tp:enumvalue> | |
794 | ||
689 | 795 | <tp:enumvalue suffix="Cert_Hostname_Mismatch" value="10"> |
690 | <tp:docstring> | |
691 | The server's SSL certificate did not match its hostname. | |
692 | </tp:docstring> | |
693 | </tp:enumvalue> | |
796 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
797 | <p>The server's SSL certificate did not match its hostname.</p> | |
798 | ||
799 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
800 | <code>org.freedesktop.Telepathy.Error.Cert.HostnameMismatch</code>. | |
801 | </p> | |
802 | </tp:docstring> | |
803 | </tp:enumvalue> | |
804 | ||
694 | 805 | <tp:enumvalue suffix="Cert_Fingerprint_Mismatch" value="11"> |
695 | <tp:docstring> | |
696 | The server's SSL certificate does not have the expected | |
697 | fingerprint. | |
698 | </tp:docstring> | |
699 | </tp:enumvalue> | |
806 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
807 | <p>The server's SSL certificate does not have the expected | |
808 | fingerprint.</p> | |
809 | ||
810 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
811 | <code>org.freedesktop.Telepathy.Error.Cert.FingerprintMismatch</code>. | |
812 | </p> | |
813 | </tp:docstring> | |
814 | </tp:enumvalue> | |
815 | ||
700 | 816 | <tp:enumvalue suffix="Cert_Self_Signed" value="12"> |
701 | <tp:docstring> | |
702 | The server's SSL certificate is self-signed. | |
703 | </tp:docstring> | |
704 | </tp:enumvalue> | |
817 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
818 | <p>The server's SSL certificate is self-signed.</p> | |
819 | ||
820 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
821 | <code>org.freedesktop.Telepathy.Error.Cert.HostnameMismatch</code>. | |
822 | </p> | |
823 | </tp:docstring> | |
824 | </tp:enumvalue> | |
825 | ||
705 | 826 | <tp:enumvalue suffix="Cert_Other_Error" value="13"> |
706 | <tp:docstring> | |
707 | There was some other error validating the server's SSL certificate. | |
827 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
828 | <p>There was some other error validating the server's SSL | |
829 | certificate.</p> | |
830 | ||
831 | <p>When disconnected for this reason, the equivalent D-Bus error is | |
832 | <code>org.freedesktop.Telepathy.Error.Cert.Invalid</code>. | |
833 | </p> | |
708 | 834 | </tp:docstring> |
709 | 835 | </tp:enumvalue> |
710 | 836 | </tp:enum> |
837 | ||
838 | <signal name="ConnectionError" tp:name-for-bindings="Connection_Error"> | |
839 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
840 | <p>Emitted when an error occurs that renders this connection unusable. | |
841 | </p> | |
842 | ||
843 | <p>Whenever this signal is emitted, it MUST immediately be followed by | |
844 | a <tp:member-ref>StatusChanged</tp:member-ref> signal with status | |
845 | Connection_Status_Reason_Disconnected and an appropriate reason | |
846 | code.</p> | |
847 | ||
848 | <p>Connection managers SHOULD emit this signal on disconnection, but | |
849 | need not do so. Clients MUST support connection managers that emit | |
850 | StatusChanged(Disconnected, ...) without first emitting | |
851 | ConnectionError.</p> | |
852 | ||
853 | <tp:rationale> | |
854 | <p>This signal provides additional information about the reason | |
855 | for disconnection. The reason for connection is always | |
856 | straightforward - it was requested - so it does not need further | |
857 | explanation. However, on errors, it can be useful to provide | |
858 | additional information.</p> | |
859 | ||
860 | <p>The <tp:type>Connection_Status_Reason</tp:type> is not given | |
861 | here, since it will be signalled in | |
862 | <tp:member-ref>StatusChanged</tp:member-ref>. A reasonable client | |
863 | implementation would be to store the information given by this | |
864 | signal until StatusChanged is received, at which point the | |
865 | information given by this signal can be used to supplement the | |
866 | StatusChanged signal.</p> | |
867 | </tp:rationale> | |
868 | </tp:docstring> | |
869 | ||
870 | <arg name="Error" type="s" tp:type="DBus_Error_Name"> | |
871 | <tp:docstring> | |
872 | The name of a D-Bus error describing the error that occurred, | |
873 | which may correspond to a | |
874 | <tp:type>Connection_Status_Reason</tp:type> or be a | |
875 | protocol-specific or connection-manager-specific error in a | |
876 | suitable namespace. | |
877 | ||
878 | <tp:rationale> | |
879 | For instance, a SIP connection manager could signal | |
880 | "402 Payment Required" as an error in a | |
881 | connection-manager-specific namespace, or a link-local | |
882 | XMPP implementation that used Avahi could provide the error | |
883 | given to it by the avahi-daemon. | |
884 | </tp:rationale> | |
885 | </tp:docstring> | |
886 | </arg> | |
887 | ||
888 | <arg name="Details" type="a{sv}" tp:type="String_Variant_Map"> | |
889 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
890 | <p>Additional information about the error, which may include | |
891 | the following well-known keys:</p> | |
892 | ||
893 | <dl> | |
894 | <dt>debug-message (s)</dt> | |
895 | <dd>Debugging information on the change, corresponding to the | |
896 | message part of a D-Bus error message, which SHOULD NOT be | |
897 | displayed to users under normal circumstances</dd> | |
898 | </dl> | |
899 | ||
900 | <tp:rationale> | |
901 | <p>This argument allows for future extensions. For instance, | |
902 | if indicating DNS lookup failure, we could define a key | |
903 | that indicates the hostname that could not be found.</p> | |
904 | </tp:rationale> | |
905 | </tp:docstring> | |
906 | </arg> | |
907 | ||
908 | </signal> | |
711 | 909 | |
712 | 910 | <signal name="StatusChanged" tp:name-for-bindings="Status_Changed"> |
713 | 911 | <arg name="Status" type="u" tp:type="Connection_Status"> |
18 | 18 | </tp:license> |
19 | 19 | <interface name="org.freedesktop.Telepathy.Connection.Interface.ContactInfo.DRAFT" |
20 | 20 | tp:causes-havoc="experimental"> |
21 | <tp:added version="0.17.UNRELEASED">(as a draft)</tp:added> | |
21 | <tp:added version="0.17.18">(as a draft)</tp:added> | |
22 | 22 | <tp:requires interface="org.freedesktop.Telepathy.Connection"/> |
23 | 23 | |
24 | 24 | <tp:struct name="Contact_Info_Field" array-name="Contact_Info_Field_List"> |
19 | 19 | </tp:license> |
20 | 20 | <interface name="org.freedesktop.Telepathy.Connection.Interface.Location.DRAFT" |
21 | 21 | tp:causes-havoc='experimental'> |
22 | <tp:added version="0.17.UNRELEASED">(as a draft)</tp:added> | |
22 | <tp:added version="0.17.18">(as a draft)</tp:added> | |
23 | 23 | <tp:requires interface="org.freedesktop.Telepathy.Connection"/> |
24 | 24 | |
25 | 25 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
210 | 210 | property provided was not a valid DNS name. |
211 | 211 | </tp:docstring> |
212 | 212 | </tp:error> |
213 | <tp:error name="org.freedesktop.Telepathy.Error.NotCapable"> | |
214 | <tp:docstring> | |
215 | The requested channel cannot be created because the requested | |
216 | contact is using a client that lacks a particular feature. | |
217 | </tp:docstring> | |
218 | </tp:error> | |
213 | 219 | <tp:error name="org.freedesktop.Telepathy.Error.NotAvailable"> |
214 | 220 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
215 | 221 | <p>The requested channel cannot be created, but in |
217 | 223 | For instance, this might be because:</p> |
218 | 224 | |
219 | 225 | <ul> |
220 | <li>the requested contact is using a client | |
221 | that lacks a particular feature</li> | |
222 | 226 | <li>a channel matching the request already exists and the |
223 | 227 | protocol requires that only one such channel can exist at a |
224 | 228 | time</li> |
345 | 349 | property provided was not a valid DNS name. |
346 | 350 | </tp:docstring> |
347 | 351 | </tp:error> |
352 | <tp:error name="org.freedesktop.Telepathy.Error.NotCapable"> | |
353 | <tp:docstring> | |
354 | The requested channel cannot be created because the requested | |
355 | contact is using a client that lacks a particular feature. | |
356 | </tp:docstring> | |
357 | </tp:error> | |
348 | 358 | <tp:error name="org.freedesktop.Telepathy.Error.NotAvailable"> |
349 | 359 | <tp:docstring> |
350 | 360 | The requested channel cannot be created, but in |
351 | principle, a similar request might succeed in future. For instance, | |
352 | this might be because the requested contact is using a client | |
353 | that lacks a particular feature. | |
361 | principle, a similar request might succeed in future. | |
354 | 362 | </tp:docstring> |
355 | 363 | </tp:error> |
356 | 364 | <tp:error name="org.freedesktop.Telepathy.Error.Channel.Banned"/> |
2 | 2 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
3 | 3 | |
4 | 4 | <tp:title>Telepathy D-Bus Interface Specification</tp:title> |
5 | <tp:version>0.17.18</tp:version> | |
5 | <tp:version>0.17.19</tp:version> | |
6 | 6 | |
7 | 7 | <tp:copyright>Copyright (C) 2005-2008 Collabora Limited</tp:copyright> |
8 | 8 | <tp:copyright>Copyright (C) 2005-2008 Nokia Corporation</tp:copyright> |
44 | 44 | <xi:include href="Channel_Future.xml"/> |
45 | 45 | <xi:include href="Channel_Type_Contact_List.xml"/> |
46 | 46 | <xi:include href="Channel_Type_Streamed_Media.xml"/> |
47 | <xi:include href="Channel_Type_Streamed_Media_Future.xml"/> | |
47 | 48 | <xi:include href="Channel_Type_Room_List.xml"/> |
48 | 49 | <xi:include href="Channel_Type_Text.xml"/> |
49 | 50 | <xi:include href="Channel_Type_Tubes.xml"/> |
61 | 62 | <xi:include href="Channel_Interface_HTML.xml"/> |
62 | 63 | <xi:include href="Channel_Interface_Password.xml"/> |
63 | 64 | <xi:include href="Channel_Interface_Media_Signalling.xml"/> |
65 | <xi:include href="Channel_Interface_Media_Signalling_Future.xml"/> | |
64 | 66 | <xi:include href="Channel_Interface_Messages.xml"/> |
65 | 67 | <xi:include href="Channel_Interface_Tube.xml"/> |
66 | 68 |
34 | 34 | |
35 | 35 | <tp:error name="Disconnected"> |
36 | 36 | <tp:docstring> |
37 | The connection is not currently connected and cannot be used. | |
37 | The connection is not currently connected and cannot be used. | |
38 | This error may also be raised when operations are performed on a | |
39 | Connection for which | |
40 | <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">StatusChanged</tp:dbus-ref> | |
41 | has signalled status Disconnected for reason None. | |
42 | ||
43 | <tp:rationale> | |
44 | The second usage corresponds to None in the | |
45 | <tp:type>Connection_Status_Reason</tp:type> enum; if a better reason | |
46 | is available, the corresponding error should be used instead. | |
47 | </tp:rationale> | |
38 | 48 | </tp:docstring> |
39 | 49 | </tp:error> |
40 | 50 | |
72 | 82 | <tp:error name="Cancelled"> |
73 | 83 | <tp:docstring> |
74 | 84 | Raised by an ongoing request if it is cancelled by user request before |
75 | it has completed. | |
85 | it has completed, or when operations are performed on an object which | |
86 | the user has asked to close (for instance, a Connection where the user | |
87 | has called Disconnect, or a Channel where the user has called Close). | |
88 | ||
89 | <tp:rationale> | |
90 | The second form can be used to correspond to the Requested member in | |
91 | the <tp:type>Connection_Status_Reason</tp:type> enum, or to | |
92 | to represent the situation where disconnecting a Connection, | |
93 | closing a Channel, etc. has been requested by the user but this | |
94 | request has not yet been acted on, for instance because the | |
95 | service will only act on the request when it has finished processing | |
96 | an event queue. | |
97 | </tp:rationale> | |
98 | </tp:docstring> | |
99 | </tp:error> | |
100 | ||
101 | <tp:error name="Authentication Failed"> | |
102 | <tp:docstring> | |
103 | Raised when authentication with a service was unsuccessful. | |
104 | <tp:rationale> | |
105 | This corresponds to Authentication_Failed in the | |
106 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
107 | </tp:rationale> | |
108 | </tp:docstring> | |
109 | </tp:error> | |
110 | ||
111 | <tp:error name="Encryption Not Available"> | |
112 | <tp:docstring> | |
113 | Raised if a user request insisted that encryption should be used, | |
114 | but encryption was not actually available. | |
115 | ||
116 | <tp:rationale> | |
117 | This corresponds to part of Encryption_Error in the | |
118 | <tp:type>Connection_Status_Reason</tp:type> enum. It's been separated | |
119 | into a distinct error here because the two concepts that were part | |
120 | of EncryptionError seem to be things that could reasonably appear | |
121 | differently in the UI. | |
122 | </tp:rationale> | |
123 | </tp:docstring> | |
124 | </tp:error> | |
125 | ||
126 | <tp:error name="Encryption Error"> | |
127 | <tp:docstring> | |
128 | Raised if encryption appears to be available, but could not actually be | |
129 | used (for instance if SSL/TLS negotiation fails). | |
130 | <tp:rationale> | |
131 | This corresponds to part of Encryption_Error in the | |
132 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
133 | </tp:rationale> | |
134 | </tp:docstring> | |
135 | </tp:error> | |
136 | ||
137 | <tp:error name="Cert.Not Provided"> | |
138 | <tp:docstring> | |
139 | Raised if the server did not provide a SSL/TLS certificate. This error | |
140 | MUST NOT be used to represent the absence of a client certificate | |
141 | provided by the Telepathy connection manager. | |
142 | <tp:rationale> | |
143 | This corresponds to Cert_Not_Provided in the | |
144 | <tp:type>Connection_Status_Reason</tp:type> enum. That error | |
145 | explicitly applied only to server SSL certificates, so this one | |
146 | is similarly limited; having the CM present a client certificate | |
147 | is a possible future feature, but it should have its own error | |
148 | handling. | |
149 | </tp:rationale> | |
150 | </tp:docstring> | |
151 | </tp:error> | |
152 | ||
153 | <tp:error name="Cert.Untrusted"> | |
154 | <tp:docstring> | |
155 | Raised if the server provided a SSL/TLS certificate signed by an | |
156 | untrusted certifying authority. This error SHOULD NOT be used to | |
157 | represent a self-signed certificate: see the Self Signed error for that. | |
158 | <tp:rationale> | |
159 | This corresponds to Cert_Untrusted in the | |
160 | <tp:type>Connection_Status_Reason</tp:type> enum, with a clarification | |
161 | to avoid ambiguity. | |
162 | </tp:rationale> | |
163 | </tp:docstring> | |
164 | </tp:error> | |
165 | ||
166 | <tp:error name="Cert.Expired"> | |
167 | <tp:docstring> | |
168 | Raised if the server provided an expired SSL/TLS certificate. | |
169 | <tp:rationale> | |
170 | This corresponds to Cert_Expired in the | |
171 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
172 | </tp:rationale> | |
173 | </tp:docstring> | |
174 | </tp:error> | |
175 | ||
176 | <tp:error name="Cert.Not Activated"> | |
177 | <tp:docstring> | |
178 | Raised if the server provided an SSL/TLS certificate that will become | |
179 | valid at some point in the future. | |
180 | <tp:rationale> | |
181 | This corresponds to Cert_Not_Activated in the | |
182 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
183 | </tp:rationale> | |
184 | </tp:docstring> | |
185 | </tp:error> | |
186 | ||
187 | <tp:error name="Cert.Fingerprint Mismatch"> | |
188 | <tp:docstring> | |
189 | Raised if the server provided an SSL/TLS certificate that did not have | |
190 | the expected fingerprint. | |
191 | <tp:rationale> | |
192 | This corresponds to Cert_Fingerprint_Mismatch in the | |
193 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
194 | </tp:rationale> | |
195 | </tp:docstring> | |
196 | </tp:error> | |
197 | ||
198 | <tp:error name="Cert.Hostname Mismatch"> | |
199 | <tp:docstring> | |
200 | Raised if the server provided an SSL/TLS certificate that did not match | |
201 | its hostname. | |
202 | <tp:rationale> | |
203 | This corresponds to Cert_Hostname_Mismatch in the | |
204 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
205 | </tp:rationale> | |
206 | </tp:docstring> | |
207 | </tp:error> | |
208 | ||
209 | <tp:error name="Cert.Self Signed"> | |
210 | <tp:docstring> | |
211 | Raised if the server provided an SSL/TLS certificate that is self-signed | |
212 | and untrusted. | |
213 | <tp:rationale> | |
214 | This corresponds to Cert_Hostname_Mismatch in the | |
215 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
216 | </tp:rationale> | |
217 | </tp:docstring> | |
218 | </tp:error> | |
219 | ||
220 | <tp:error name="Cert.Invalid"> | |
221 | <tp:docstring> | |
222 | Raised if the server provided an SSL/TLS certificate that is | |
223 | unacceptable in some way that does not have a more specific error. | |
224 | <tp:rationale> | |
225 | This corresponds to Cert_Other_Error in the | |
226 | <tp:type>Connection_Status_Reason</tp:type> enum. | |
227 | </tp:rationale> | |
228 | </tp:docstring> | |
229 | </tp:error> | |
230 | ||
231 | <tp:error name="Not Capable"> | |
232 | <tp:docstring> | |
233 | Raised when requested functionality is unavailable due to contact | |
234 | not having required capabilities. | |
235 | </tp:docstring> | |
236 | </tp:error> | |
237 | ||
238 | <tp:error name="Offline"> | |
239 | <tp:docstring> | |
240 | Raised when requested functionality is unavailable because a contact is | |
241 | offline. | |
242 | ||
243 | <tp:rationale> | |
244 | This corresponds to Offline in the | |
245 | <tp:type>Channel_Group_Change_Reason</tp:type> enum. | |
246 | </tp:rationale> | |
247 | </tp:docstring> | |
248 | </tp:error> | |
249 | ||
250 | <tp:error name="Channel.Kicked"> | |
251 | <tp:docstring> | |
252 | Used to represent a user being ejected from a channel by another user, | |
253 | for instance being kicked from a chatroom. | |
254 | ||
255 | <tp:rationale> | |
256 | This corresponds to Kicked in the | |
257 | <tp:type>Channel_Group_Change_Reason</tp:type> enum. | |
258 | </tp:rationale> | |
259 | </tp:docstring> | |
260 | </tp:error> | |
261 | ||
262 | <tp:error name="Busy"> | |
263 | <tp:docstring> | |
264 | Used to represent a user being removed from a channel because of a | |
265 | "busy" indication. | |
266 | ||
267 | <tp:rationale> | |
268 | This corresponds to Busy in the | |
269 | <tp:type>Channel_Group_Change_Reason</tp:type> enum. | |
270 | </tp:rationale> | |
271 | </tp:docstring> | |
272 | </tp:error> | |
273 | ||
274 | <tp:error name="No Answer"> | |
275 | <tp:docstring> | |
276 | Used to represent a user being removed from a channel because they did | |
277 | not respond, e.g. to a StreamedMedia call. | |
278 | ||
279 | <tp:rationale> | |
280 | This corresponds to No_Answer in the | |
281 | <tp:type>Channel_Group_Change_Reason</tp:type> enum. | |
282 | </tp:rationale> | |
283 | </tp:docstring> | |
284 | </tp:error> | |
285 | ||
286 | <tp:error name="Does Not Exist"> | |
287 | <tp:docstring> | |
288 | Raised when the requested user does not, in fact, exist. | |
289 | ||
290 | <tp:rationale> | |
291 | This corresponds to Invalid_Contact in the | |
292 | <tp:type>Channel_Group_Change_Reason</tp:type> enum, but can also be | |
293 | used to represent other things not existing (like chatrooms, perhaps). | |
294 | </tp:rationale> | |
76 | 295 | </tp:docstring> |
77 | 296 | </tp:error> |
78 | 297 |