Imported Upstream version 0.25.0
Jonny Lamb
12 years ago
0 | commit 526bc0f841f452bf745c339b512bb2e10af963d8 | |
1 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
2 | Date: Thu Nov 10 17:18:45 2011 +0000 | |
3 | ||
4 | version 0.25.0 | |
5 | ||
6 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
7 | ||
8 | commit af3080ddd94a9653abcb989ad945d2b2bd7c7a9a | |
9 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
10 | Date: Thu Nov 10 17:12:53 2011 +0000 | |
11 | ||
12 | Mark changes as changed in 0.25.0 | |
13 | ||
14 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
15 | ||
16 | commit 6100bb16a3ff3111c5efd5e3cd9771ef942ecfe0 | |
17 | Merge: f0b729d 190ff93 | |
18 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
19 | Date: Thu Nov 10 17:05:35 2011 +0000 | |
20 | ||
21 | Merge branch 'ft-metadata' | |
22 | ||
23 | commit 190ff931a85ffc8191dfac27c922f55d8ff284d7 | |
24 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
25 | Date: Thu Nov 10 17:03:38 2011 +0000 | |
26 | ||
27 | Chan.I.FT.Metadata: improve tp:rationale for a{sas} | |
28 | ||
29 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
30 | ||
31 | commit c29b1e356a47212b61aae5476f9b058379474f07 | |
32 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
33 | Date: Thu Nov 10 13:59:04 2011 +0000 | |
34 | ||
35 | specparser: complain if tp:mapping's specified type is a lie | |
36 | ||
37 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
38 | ||
39 | commit e37c5871ef6c4ed254e2b6ec046eb5afe20dce93 | |
40 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
41 | Date: Thu Nov 10 13:58:38 2011 +0000 | |
42 | ||
43 | Chan.I.FT.Metadata: improve Metadata docs | |
44 | ||
45 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
46 | ||
47 | commit 367a65bf7acc5f923467ea5d4f1cc5775798fb43 | |
48 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
49 | Date: Wed Nov 9 17:50:54 2011 +0000 | |
50 | ||
51 | Chan.I.FT.Metadata: change Metadata property to a{sas} | |
52 | ||
53 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
54 | ||
55 | commit f0b729d4790f8b7eef4f92575e333ce75259ed94 | |
56 | Author: Xavier Claessens <xclaesse@gmail.com> | |
57 | Date: Mon Nov 7 16:25:03 2011 +0100 | |
58 | ||
59 | Call1: Add contact identifiers for CallMembers and RemoteMembers | |
60 | ||
61 | commit 3620d2d2bb7100a050b2092e6e520ea9e5d6c372 | |
62 | Author: Xavier Claessens <xclaesse@gmail.com> | |
63 | Date: Mon Nov 7 16:07:31 2011 +0100 | |
64 | ||
65 | Call1: Add rational explaining why Content could have multiple streams | |
66 | ||
67 | commit fc1e0e904dec17d47ccf4fbf2d8be4213fe291d3 | |
68 | Merge: cf3f009 be8d970 | |
69 | Author: Xavier Claessens <xclaesse@gmail.com> | |
70 | Date: Mon Nov 7 16:29:59 2011 +0100 | |
71 | ||
72 | Merge branch 'call1-mute' | |
73 | ||
74 | commit be8d9703007fd13f56392dedc7ecae206cb9a4ad | |
75 | Author: Xavier Claessens <xclaesse@gmail.com> | |
76 | Date: Mon Nov 7 15:54:17 2011 +0100 | |
77 | ||
78 | Call1: Clarify interfaces that may implement Mute iface | |
79 | ||
80 | commit cf3f00997befb2f4658dff79939ac7673e8912c1 | |
81 | Merge: d919bdc 80c1bfc | |
82 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
83 | Date: Mon Nov 7 22:28:57 2011 +1100 | |
84 | ||
85 | Merge branch 'roomconfig-42653' | |
86 | ||
87 | commit d919bdce7eb7f9f1f0e90e31236bd4c886d35df8 | |
88 | Author: Xavier Claessens <xclaesse@gmail.com> | |
89 | Date: Mon Nov 7 10:28:08 2011 +0100 | |
90 | ||
91 | Deprecate Channel.Type.ContactList | |
92 | ||
93 | They have been replaced by Connection.Interface.ContactList | |
94 | ||
95 | commit 80c1bfc227072b288a48559b988d9eddc4060eb5 | |
96 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
97 | Date: Mon Nov 7 20:49:11 2011 +1100 | |
98 | ||
99 | Document how no-data is represented in the Avatar type | |
100 | ||
101 | Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=42653 | |
102 | ||
103 | commit 9df40694cc7926ec5cf6cb2a89efa5df42504b40 | |
104 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
105 | Date: Mon Nov 7 17:41:30 2011 +1100 | |
106 | ||
107 | New iface: Channel.Interface.Picture | |
108 | ||
109 | Lets the users set/get the picture for a chatroom. | |
110 | ||
111 | Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=42653 | |
112 | ||
113 | commit 10043f3bc298294294cc28993d973862f96e7b0a | |
114 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
115 | Date: Mon Nov 7 17:08:45 2011 +1100 | |
116 | ||
117 | Room: Creator, CreatorHandle and CreationTimestamp | |
118 | ||
119 | These properties indicate who and when the room was created. | |
120 | ||
121 | Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=42653 | |
122 | ||
123 | commit c7b8ba61ecc9f0102d8bc49c7fda1e65c8631e74 | |
124 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
125 | Date: Mon Nov 7 16:58:33 2011 +1100 | |
126 | ||
127 | RoomConfig.PasswordHint | |
128 | ||
129 | A hint for the room password. | |
130 | ||
131 | Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=42653 | |
132 | ||
133 | commit 13df0c069f64c229224f56ca2edc236b4f719c51 | |
134 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
135 | Date: Mon Nov 7 16:21:28 2011 +1100 | |
136 | ||
137 | Chan.I.Subject: remove a white lie | |
138 | ||
139 | Skype does not permit subjects on 1:1 chats. However, XMPP does, e.g. GMail | |
140 | will include a 'subject' node when you click "Reply to Will by chat". | |
141 | ||
142 | commit b58a83f27d9c2a14a4eb0545574c56f396fb0a65 | |
143 | Author: Danielle Madeley <danielle.madeley@collabora.co.uk> | |
144 | Date: Mon Nov 7 16:10:55 2011 +1100 | |
145 | ||
146 | Chan.I.Subject: add values for when properties are unknown | |
147 | ||
148 | Specifically ActorHandle and Timestamp. | |
149 | ||
150 | https://bugs.freedesktop.org/show_bug.cgi?id=42652 | |
151 | ||
152 | commit 23901acdb065a082f0d244cd527ba08aad3b622a | |
153 | Author: Xavier Claessens <xclaesse@gmail.com> | |
154 | Date: Wed Nov 2 17:11:42 2011 +0100 | |
155 | ||
156 | Add windows-live to known Account services | |
157 | ||
158 | commit 13699997cf38faa9fb13cfe176b7386171a8a4ac | |
159 | Author: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
160 | Date: Wed Oct 26 19:04:59 2011 +0100 | |
161 | ||
162 | Chan.Iface.FileTransfer.Metadata: add initial version | |
163 | ||
164 | Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk> | |
165 | ||
166 | commit 925eaeaefbe4ce83540cfbdb4ba531fc6fdfa63f | |
167 | Author: Will Thompson <will.thompson@collabora.co.uk> | |
168 | Date: Mon Oct 10 11:23:49 2011 +0100 | |
169 | ||
170 | Bump nano-version | |
171 | ||
0 | 172 | commit 82a0472e5b37c36e9879f87d152bd7725ac4ecfd |
1 | 173 | Author: Will Thompson <will.thompson@collabora.co.uk> |
2 | 174 | Date: Mon Oct 10 11:22:11 2011 +0100 |
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.25.0 (2011-11-10) | |
5 | ================================== | |
6 | ||
7 | API additions and clarifications: | |
8 | ||
9 | • Channel.Interface.FileTransfer.Metdata has been added. | |
10 | ||
11 | • Channel.Interface.Picture has been added. | |
12 | ||
13 | • "windows-live" has been added as a known account service name. | |
14 | ||
15 | • Channel.Interface.Subject: clarify default values for properties in | |
16 | the unknown case. | |
17 | ||
18 | • RoomConfig: add a PasswordHint property which does what you think it | |
19 | does. | |
20 | ||
21 | • Room: add Creator, CreatorHandle and CreationTimestamp properties. | |
22 | ||
23 | • Channel.Type.ContactList has been deprecated. | |
3 | 24 | |
4 | 25 | telepathy-spec 0.24.0 (2011-10-10) |
5 | 26 | ================================== |
271 | 271 | <li><tt>lj-talk</tt> (for <a |
272 | 272 | href="http://www.livejournal.com/chat/">LiveJournal's IM |
273 | 273 | service</a>)</li> |
274 | <li><tt>windows-live</tt> (for <a | |
275 | href="http://live.com">Windows Live Messenger IM service</a>)</li> | |
274 | 276 | |
275 | 277 | </ul> |
276 | 278 |
39 | 39 | <tp:struct name="Avatar"> |
40 | 40 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
41 | 41 | <p>A struct containing avatar data marked with its MIME type.</p> |
42 | ||
43 | <p>May be set to an empty byte-array and an empty string, indicating | |
44 | no avatar.</p> | |
42 | 45 | </tp:docstring> |
43 | 46 | <tp:member type="ay" name="Avatar_Data"/> |
44 | 47 | <tp:member type="s" name="MIME_Type"/> |
22 | 22 | <interface name="org.freedesktop.Telepathy.Call1.Content" |
23 | 23 | tp:causes-havoc="experimental"> |
24 | 24 | <tp:added version="0.19.0">(draft 1)</tp:added> |
25 | <tp:requires | |
26 | interface="org.freedesktop.Telepathy.Call1.Interface.Mute"/> | |
27 | 25 | |
28 | 26 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
29 | This object represents one Content inside a <tp:dbus-ref | |
27 | <p>This object represents one Content inside a <tp:dbus-ref | |
30 | 28 | namespace="ofdT.Channel.Type">Call1</tp:dbus-ref>. For |
31 | 29 | example, in an audio/video call there would be one audio content |
32 | 30 | and one video content. Each content has one or more <tp:dbus-ref |
33 | 31 | namespace="ofdT.Call1">Stream</tp:dbus-ref> objects which |
34 | represent the actual transport to one or more remote contacts. | |
32 | represent the actual transport to one or more remote contacts.</p> | |
33 | <tp:rationale> | |
34 | There are two cases where multiple streams may happen: | |
35 | <ul> | |
36 | <li>Calls with more than two participants, if the protocol does not | |
37 | support multicast, and does not have mixer proxy.</li> | |
38 | <li>With jingle, when calling a contact connected from multiple | |
39 | resources, a stream is created for each resource. Once the remote | |
40 | contact answered from one of its resources, all other streams get | |
41 | removed.</li> | |
42 | </ul> | |
43 | </tp:rationale> | |
44 | <p>For protocols that support muting all streams of a given content | |
45 | separately, this object MAY also implement the <tp:dbus-ref | |
46 | namespace="ofdT.Call1.Interface">Mute</tp:dbus-ref> interface</p> | |
35 | 47 | </tp:docstring> |
36 | 48 | |
37 | 49 | <method name="Remove" tp:name-for-bindings="Remove"> |
19 | 19 | |
20 | 20 | <interface name="org.freedesktop.Telepathy.Call1.Interface.Mute" tp:causes-havoc="experimental"> |
21 | 21 | <tp:added version="0.19.6">(draft version, not API-stable)</tp:added> |
22 | <tp:xor-requires interface="org.freedesktop.Telepathy.Channel.Type.Call1"/> | |
23 | <tp:xor-requires interface="org.freedesktop.Telepathy.Call1.Content"/> | |
24 | <tp:xor-requires interface="org.freedesktop.Telepathy.Call1.Stream"/> | |
22 | <tp:xor-requires> | |
23 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.Call1"/> | |
24 | <tp:requires interface="org.freedesktop.Telepathy.Call1.Content"/> | |
25 | <tp:requires interface="org.freedesktop.Telepathy.Call1.Stream"/> | |
26 | </tp:xor-requires> | |
25 | 27 | |
26 | 28 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
27 | 29 | <p>Interface for calls which may be muted. This only makes sense |
24 | 24 | <tp:added version="0.19.0">(draft 1)</tp:added> |
25 | 25 | |
26 | 26 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
27 | One stream inside a <tp:dbus-ref | |
27 | <p>One stream inside a <tp:dbus-ref | |
28 | 28 | namespace="ofdT.Call1">Content</tp:dbus-ref>. A stream is |
29 | 29 | a single flow of packets to and from a single remote endpoint. |
30 | 30 | If your call connects to multiple people, you could have |
31 | multiple streams. | |
31 | multiple streams.</p> | |
32 | <p>For protocols that support muting streams separately, this object MAY | |
33 | also implement the <tp:dbus-ref | |
34 | namespace="ofdT.Call1.Interface">Mute</tp:dbus-ref> interface</p> | |
32 | 35 | </tp:docstring> |
33 | 36 | |
34 | 37 | <method name="SetSending" tp:name-for-bindings="Set_Sending"> |
117 | 120 | and the members whose states changed. |
118 | 121 | </tp:docstring> |
119 | 122 | </arg> |
123 | <arg name="Identifiers" type="a{us}" tp:type="Handle_Identifier_Map"> | |
124 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
125 | The identifiers of the contacts in the <var>Updates</var> map. | |
126 | </tp:docstring> | |
127 | </arg> | |
120 | 128 | <arg name="Removed" type="au" tp:type="Contact_Handle[]"> |
121 | 129 | <tp:docstring> |
122 | 130 | The channel-specific handles that were removed from the keys |
235 | 243 | <tp:dbus-ref namespace="ofdT.Call1.Content.Interface.Media" |
236 | 244 | >RemoteMediaDescriptions</tp:dbus-ref>. This use-case should not |
237 | 245 | affect anything that does not handle media streaming.</p> |
246 | </tp:docstring> | |
247 | </property> | |
248 | ||
249 | <property name="RemoteMemberIdentifiers" type="a{us}" tp:type="Handle_Identifier_Map" | |
250 | access="read" tp:name-for-bindings="Remote_Member_Identifiers"> | |
251 | <tp:docstring> | |
252 | The string identifiers for handles mentioned in | |
253 | <tp:member-ref>RemoteMembers</tp:member-ref>, to | |
254 | give clients the minimal information necessary to create contacts | |
255 | without waiting for round-trips. | |
238 | 256 | </tp:docstring> |
239 | 257 | </property> |
240 | 258 |
0 | <?xml version="1.0" ?> | |
1 | <node name="/Channel_Interface_File_Transfer_Metadata" | |
2 | xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> | |
3 | <tp:copyright>Copyright (C) 2011 Collabora Ltd.</tp:copyright> | |
4 | ||
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 | ||
22 | <interface | |
23 | name="org.freedesktop.Telepathy.Channel.Interface.FileTransfer.Metadata"> | |
24 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.FileTransfer"/> | |
25 | <tp:added version="0.25.0"/> | |
26 | ||
27 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
28 | <p>This interface exists to provide a mechanism to include | |
29 | arbitrary additional information in file transfers. For | |
30 | example, one might want to send a document and include the | |
31 | number of times the character P appeared in the file, so would | |
32 | add <tt>NumberOfPs=42</tt> to the | |
33 | <tp:member-ref>Metadata</tp:member-ref> property.</p> | |
34 | ||
35 | <p><tp:member-ref>ServiceName</tp:member-ref> living in its own | |
36 | property makes it easier for specific applications to send | |
37 | files to each other, bypassing the standard handler. For | |
38 | example, the Banshee Telepathy plugin handler could match on | |
39 | <tp:member-ref>ServiceName</tp:member-ref> so the Empathy file | |
40 | transfer is not used instead.</p> | |
41 | </tp:docstring> | |
42 | ||
43 | <property name="ServiceName" tp:name-for-bindings="Service_Name" | |
44 | type="s" access="readwrite" tp:immutable="sì" | |
45 | tp:requestable="naturalmente"> | |
46 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
47 | <p>A string representing the service name that will be used | |
48 | over the file transfer channel. This property is equivalent | |
49 | to the <tp:dbus-ref | |
50 | namespace="ofdT">Channel.Type.DBusTube.ServiceName</tp:dbus-ref> | |
51 | and <tp:dbus-ref | |
52 | namespace="ofdT">Channel.Type.StreamTube.Service</tp:dbus-ref> | |
53 | properties. If no service name is given then this property | |
54 | will be the empty string.</p> | |
55 | </tp:docstring> | |
56 | </property> | |
57 | ||
58 | <property name="Metadata" tp:name-for-bindings="Metadata" | |
59 | type="a{sas}" tp:type="Metadata" access="readwrite" | |
60 | tp:immutable="sì" tp:requestable="naturalmente"> | |
61 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
62 | <p>Additional information about the file transfer set by the | |
63 | channel initiator. If no additional information is given then | |
64 | this property will be empty.</p> | |
65 | </tp:docstring> | |
66 | </property> | |
67 | ||
68 | <tp:mapping name="Metadata" type="a{sas}"> | |
69 | <tp:docstring> | |
70 | A mapping from string key to a list of strings, used in the | |
71 | <tp:member-ref>Metadata</tp:member-ref> property. To emulate a | |
72 | simple string → string hash table one should have exactly one | |
73 | member in the value string list. | |
74 | ||
75 | <tp:rationale> | |
76 | This property is an a{sas} primarily because this maps | |
77 | easily to <a | |
78 | href="http://xmpp.org/extensions/xep-0004.html">XEP-0004 | |
79 | Data Forms</a>, and allows more structured metadata than | |
80 | a{ss} would. (For instance, a list of RDF triples could be | |
81 | expressed as one long array of strings, or as three-element | |
82 | values for a series of dummy key names, rather than as one | |
83 | big string blob.) | |
84 | ||
85 | While it might be convenient for applications to allow keys | |
86 | of arbitrary types, the added convenience would be | |
87 | outweighed by having to define the XMPP representation | |
88 | </tp:rationale> | |
89 | </tp:docstring> | |
90 | ||
91 | <tp:member name="Key" type="s"/> | |
92 | <tp:member name="Values" type="as"/> | |
93 | </tp:mapping> | |
94 | ||
95 | </interface> | |
96 | </node> | |
97 | <!-- vim:set sw=2 sts=2 et ft=xml: --> |
26 | 26 | <tp:docstring> |
27 | 27 | The <tp:member-ref>ProvidePassword</tp:member-ref> method must be |
28 | 28 | called now for the user to join the channel |
29 | </tp:docstring> | |
30 | </tp:flag> | |
31 | <tp:flag suffix="Hint" value="4"> | |
32 | <tp:added version="0.25.0"/> | |
33 | <tp:docstring> | |
34 | The <tp:dbus-ref namespace="ofdT.Channel.Interface">RoomConfig1.PasswordHint</tp:dbus-ref> | |
35 | contains a hint for the password. | |
29 | 36 | </tp:docstring> |
30 | 37 | </tp:flag> |
31 | 38 | </tp:flags> |
0 | <?xml version="1.0" ?> | |
1 | <node name="/Channel_Interface_Picture" | |
2 | xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> | |
3 | ||
4 | <tp:copyright>Copyright © 2010–2011 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 | |
19 | 02110-1301, USA.</p> | |
20 | </tp:license> | |
21 | ||
22 | <interface name="org.freedesktop.Telepathy.Channel.Interface.Picture1" | |
23 | tp:causes-havoc="draft"> | |
24 | <tp:requires interface="org.freedesktop.Telepathy.Channel"/> | |
25 | <tp:added version="0.25.0"/> | |
26 | <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" | |
27 | value="true"/> | |
28 | ||
29 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
30 | <p>An interface channels can implement to support a picture. Most | |
31 | of the time this will be implemented by channels implementing | |
32 | the <tp:dbus-ref | |
33 | namespace="ofdT.Channel.Interface">Room2</tp:dbus-ref> | |
34 | interface. Note that this interface is not restricted to | |
35 | Text channels, and can also be used on Call channels.</p> | |
36 | ||
37 | <tp:rationale> | |
38 | This is a separate interface from | |
39 | <tp:dbus-ref namespace="ofdT.Channel.Interface">RoomConfig1</tp:dbus-ref> | |
40 | because (a) it's possible some protocol might support pictures for | |
41 | 1:1 chats; and (b) it avoids downloading an unwanted picture in a | |
42 | GetAll request. | |
43 | </tp:rationale> | |
44 | </tp:docstring> | |
45 | ||
46 | <method name="SetPicture" tp:name-for-bindings="Set_Picture"> | |
47 | <arg direction="in" type="ay" name="Picture"> | |
48 | <tp:docstring>The new picture.</tp:docstring> | |
49 | </arg> | |
50 | <arg direction="in" type="s" name="MIME_Type"> | |
51 | <tp:docstring>The MIME type.</tp:docstring> | |
52 | </arg> | |
53 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
54 | <p>Set the room's picture. Clients SHOULD look at the picture | |
55 | flags before calling this method as the user might not have | |
56 | permission to set the picture.</p> | |
57 | ||
58 | <p>A successful return of this method indicates a successful | |
59 | change in picture, but clients should still listen for changes | |
60 | to the <tp:member-ref>Picture</tp:member-ref> property for | |
61 | further changes by other users or the server.</p> | |
62 | </tp:docstring> | |
63 | <tp:possible-errors> | |
64 | <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"/> | |
65 | <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"> | |
66 | <tp:docstring> | |
67 | Picture is somehow invalid: e.g. unsupported MIME type, | |
68 | too big, etc. | |
69 | </tp:docstring> | |
70 | </tp:error> | |
71 | <tp:error name="org.freedesktop.Telepathy.Error.PermissionDenied"/> | |
72 | </tp:possible-errors> | |
73 | </method> | |
74 | ||
75 | <property name="Picture" tp:name-for-bindings="Picture" | |
76 | type="(ays)" tp:type="Avatar" access="read"> | |
77 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
78 | <p>The picture representing this channel.</p> | |
79 | ||
80 | <p>This property may change during the lifetime of the channel and | |
81 | MUST not be included in a channel request.</p> | |
82 | </tp:docstring> | |
83 | </property> | |
84 | ||
85 | <property name="Actor" tp:name-for-bindings="Actor" | |
86 | type="s" access="read"> | |
87 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
88 | <p>The normalized contact ID representing who last modified | |
89 | the picture, or the empty string if it is not known.</p> | |
90 | </tp:docstring> | |
91 | </property> | |
92 | ||
93 | <property name="ActorHandle" tp:name-for-bindings="Actor_Handle" | |
94 | type="u" tp:type="Contact_Handle" access="read"> | |
95 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
96 | <p>The handle corresponding to <tp:member-ref>Actor</tp:member-ref>, | |
97 | or 0 if the <tp:member-ref>Actor</tp:member-ref> is unknown.</p> | |
98 | </tp:docstring> | |
99 | </property> | |
100 | ||
101 | <property name="Timestamp" tp:name-for-bindings="Timestamp" | |
102 | type="x" tp:type="Unix_Timestamp64" access="read"> | |
103 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
104 | <p>A unix timestamp indicating when the picture was last | |
105 | modified, or <code>INT_MAX64</code> if unknown.</p> | |
106 | </tp:docstring> | |
107 | </property> | |
108 | ||
109 | <property name="CanSet" tp:name-for-bindings="Can_Set" | |
110 | type="b" access="read"> | |
111 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
112 | <p>TRUE if the <tp:member-ref>Picture</tp:member-ref> property | |
113 | can be set by the user by calling | |
114 | <tp:member-ref>SetPicture</tp:member-ref>, otherwise | |
115 | FALSE.</p> | |
116 | ||
117 | <p>If implementations are unsure of what this value should be | |
118 | it SHOULD still be set to what it believes the value | |
119 | is. As a result, clients should be aware that | |
120 | <tp:member-ref>SetPicture</tp:member-ref> can still fail | |
121 | even with this property set to TRUE.</p> | |
122 | </tp:docstring> | |
123 | </property> | |
124 | ||
125 | <property name="SupportedMIMETypes" | |
126 | tp:name-for-bindings="Supported_MIME_Types" | |
127 | type="as" access="read" tp:immutable="yes"> | |
128 | <tp:docstring> | |
129 | An array of supported MIME types (e.g. "image/jpeg"). | |
130 | Clients MAY assume that the first type in this array is preferred. | |
131 | </tp:docstring> | |
132 | </property> | |
133 | ||
134 | <property name="MinimumHeight" | |
135 | tp:name-for-bindings="Minimum_Height" | |
136 | type="u" access="read" tp:immutable="yes"> | |
137 | <tp:docstring> | |
138 | The minimum height in pixels of the picture, which MAY be 0. | |
139 | </tp:docstring> | |
140 | </property> | |
141 | ||
142 | <property name="MinimumWidth" | |
143 | tp:name-for-bindings="Minimum_Width" | |
144 | type="u" access="read" tp:immutable="yes"> | |
145 | <tp:docstring> | |
146 | The minimum width in pixels of the picture, which MAY be 0. | |
147 | </tp:docstring> | |
148 | </property> | |
149 | ||
150 | <property name="RecommendedHeight" | |
151 | tp:name-for-bindings="Recommended_Height" | |
152 | type="u" access="read" tp:immutable="yes"> | |
153 | <tp:docstring> | |
154 | The recommended height in pixels of the picture, or 0 if | |
155 | there is no preferred height. | |
156 | </tp:docstring> | |
157 | </property> | |
158 | ||
159 | <property name="RecommendedWidth" | |
160 | tp:name-for-bindings="Recommended_Width" | |
161 | type="u" access="read" tp:immutable="yes"> | |
162 | <tp:docstring> | |
163 | The recommended width in pixels of the picture, or 0 if | |
164 | there is no preferred width. | |
165 | </tp:docstring> | |
166 | </property> | |
167 | ||
168 | <property name="MaximumHeight" | |
169 | tp:name-for-bindings="Maximum_Height" | |
170 | type="u" access="read" tp:immutable="yes"> | |
171 | <tp:docstring> | |
172 | The maximum height in pixels of the picture, or 0 if | |
173 | there is no limit. | |
174 | </tp:docstring> | |
175 | </property> | |
176 | ||
177 | <property name="MaximumWidth" | |
178 | tp:name-for-bindings="Maximum_Width" | |
179 | type="u" access="read" tp:immutable="yes"> | |
180 | <tp:docstring> | |
181 | The maximum width in pixels of the picture, or 0 if | |
182 | there is no limit. | |
183 | </tp:docstring> | |
184 | </property> | |
185 | ||
186 | <property name="MaximumBytes" | |
187 | tp:name-for-bindings="Maximum_Bytes" | |
188 | type="u" access="read" tp:immutable="yes"> | |
189 | <tp:docstring> | |
190 | The maximum size in bytes of the picture, or 0 if | |
191 | there is no limit. | |
192 | </tp:docstring> | |
193 | </property> | |
194 | ||
195 | </interface> | |
196 | </node> | |
197 | <!-- vim:set sw=2 sts=2 et ft=xml: --> |
331 | 331 | and only if non-empty values are supported.</p> |
332 | 332 | </tp:docstring> |
333 | 333 | </property> |
334 | ||
335 | <property name="Creator" tp:name-for-bindings="Creator" | |
336 | type="s" access="read" tp:immutable="yes"> | |
337 | <tp:added version="0.25.0"/> | |
338 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
339 | The normalized contact ID representing who created the room; or | |
340 | the empty string if unknown. | |
341 | </tp:docstring> | |
342 | </property> | |
343 | ||
344 | <property name="CreatorHandle" tp:name-for-bindings="Creator_Handle" | |
345 | type="u" tp:type="Contact_Handle" access="read" | |
346 | tp:immutable="yes"> | |
347 | <tp:added version="0.25.0"/> | |
348 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
349 | The handle corresponding to <tp:member-ref>Creator</tp:member-ref>; | |
350 | or 0 if <tp:member-ref>Creator</tp:member-ref> is unknown. | |
351 | </tp:docstring> | |
352 | </property> | |
353 | ||
354 | <property name="CreationTimestamp" | |
355 | tp:name-for-bindings="Creation_Timestamp" | |
356 | type="x" tp:type="Unix_Timestamp64" access="read" | |
357 | tp:immutable="yes"> | |
358 | <tp:added version="0.25.0"/> | |
359 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
360 | A unix timestamp indicating when the room was created; or | |
361 | <code>INT_MAX64</code> if unknown. | |
362 | </tp:docstring> | |
363 | </property> | |
364 | ||
334 | 365 | </interface> |
335 | 366 | </node> |
336 | 367 | <!-- vim:set sw=2 sts=2 et ft=xml: --> |
131 | 131 | </tp:docstring> |
132 | 132 | </property> |
133 | 133 | |
134 | <property name="PasswordHint" tp:name-for-bindings="Password_Hint" | |
135 | type="s" access="read"> | |
136 | <tp:added version="0.25.0"/> | |
137 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
138 | <p>If <tp:member-ref>PasswordProtected</tp:member-ref> is | |
139 | <code>True</code>, an optional hint for the password.</p> | |
140 | ||
141 | <p>On protocols supporting PasswordHint (indicated by its presence | |
142 | in <tp:member-ref>MutableProperties</tp:member-ref>), | |
143 | <tp:member-ref>Password</tp:member-ref> and PasswordHint MUST be | |
144 | set in a single call to | |
145 | <tp:member-ref>UpdateConfiguration</tp:member-ref>.</p> | |
146 | ||
147 | <tp:rationale> | |
148 | Skype requires that the password and its hint be supplied together. | |
149 | </tp:rationale> | |
150 | </tp:docstring> | |
151 | </property> | |
152 | ||
134 | 153 | <property name="CanUpdateConfiguration" type="b" access="read" |
135 | 154 | tp:name-for-bindings="Can_Update_Configuration"> |
136 | 155 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
31 | 31 | the <tp:dbus-ref |
32 | 32 | namespace="ofdT.Channel.Interface">Room2</tp:dbus-ref> |
33 | 33 | interface, but some protocols support subjects in 1-to-1 chats |
34 | (such as Skype). Note that this interface is not restricted to | |
34 | (such as XMPP). Note that this interface is not restricted to | |
35 | 35 | Text channels, and can also be used on Call channels.</p> |
36 | 36 | </tp:docstring> |
37 | 37 | |
85 | 85 | <property name="ActorHandle" tp:name-for-bindings="Actor_Handle" |
86 | 86 | type="u" tp:type="Contact_Handle" access="read"> |
87 | 87 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
88 | <p>The handle corresponding to <tp:member-ref>Actor</tp:member-ref>.</p> | |
88 | <p>The handle corresponding to <tp:member-ref>Actor</tp:member-ref>, | |
89 | or 0 if the <tp:member-ref>Actor</tp:member-ref> is unknown.</p> | |
89 | 90 | </tp:docstring> |
90 | 91 | </property> |
91 | 92 | |
93 | 94 | type="x" tp:type="Unix_Timestamp64" access="read"> |
94 | 95 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
95 | 96 | <p>A unix timestamp indicating when the subject was last |
96 | modified.</p> | |
97 | modified, or <code>INT_MAX64</code> if unknown.</p> | |
97 | 98 | |
98 | 99 | <tp:rationale>This property replaces the subject-timestamp |
99 | 100 | Telepathy property of Text channels, as Telepathy properties |
1265 | 1265 | flags have changed. |
1266 | 1266 | </tp:docstring> |
1267 | 1267 | </arg> |
1268 | <arg name="Identifiers" type="a{us}" tp:type="Handle_Identifier_Map"> | |
1269 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> | |
1270 | The identifiers of the contacts in the <var>Flags_Changed</var> map. | |
1271 | </tp:docstring> | |
1272 | </arg> | |
1268 | 1273 | <arg name="Removed" type="au" tp:type="Contact_Handle[]"> |
1269 | 1274 | <tp:docstring> |
1270 | 1275 | A list of members who have left the call, i.e. keys to be removed |
1297 | 1302 | |
1298 | 1303 | <p>Anonymous members are exposed as channel-specific handles |
1299 | 1304 | with no owner.</p> |
1305 | </tp:docstring> | |
1306 | </property> | |
1307 | ||
1308 | <property name="MemberIdentifiers" type="a{us}" tp:type="Handle_Identifier_Map" | |
1309 | access="read" tp:name-for-bindings="Member_Identifiers"> | |
1310 | <tp:docstring> | |
1311 | The string identifiers for handles mentioned in | |
1312 | <tp:member-ref>CallMembers</tp:member-ref>, to | |
1313 | give clients the minimal information necessary to create contacts | |
1314 | without waiting for round-trips. | |
1300 | 1315 | </tp:docstring> |
1301 | 1316 | </property> |
1302 | 1317 |
20 | 20 | <interface name="org.freedesktop.Telepathy.Channel.Type.ContactList"> |
21 | 21 | <tp:requires interface="org.freedesktop.Telepathy.Channel"/> |
22 | 22 | <tp:requires interface="org.freedesktop.Telepathy.Channel.Interface.Group"/> |
23 | <tp:deprecated version="0.25.0">Replaced by <tp:dbus-ref | |
24 | namespace="org.freedesktop.Telepathy">Connection.Interface.ContactList</tp:dbus-ref> | |
25 | </tp:deprecated> | |
23 | 26 | |
24 | 27 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> |
25 | 28 | <p>A channel type for representing a list of people on the server which is |
594 | 594 | </tp:docstring> |
595 | 595 | </tp:enumvalue> |
596 | 596 | <tp:enumvalue suffix="List" value="3"> |
597 | <tp:deprecated version="0.25.0">Replaced by <tp:dbus-ref | |
598 | namespace="org.freedesktop.Telepathy">Connection.Interface.ContactList</tp:dbus-ref> | |
599 | </tp:deprecated> | |
597 | 600 | <tp:docstring> |
598 | 601 | A server-generated contact list (see Channel.Interface.Group) |
599 | 602 | </tp:docstring> |
600 | 603 | </tp:enumvalue> |
601 | 604 | <tp:enumvalue suffix="Group" value="4"> |
605 | <tp:deprecated version="0.25.0">Replaced by <tp:dbus-ref | |
606 | namespace="org.freedesktop.Telepathy">Connection.Interface.ContactList</tp:dbus-ref> | |
607 | </tp:deprecated> | |
602 | 608 | <tp:docstring> |
603 | 609 | A user-defined contact list (see Channel.Interface.Group) |
604 | 610 | </tp:docstring> |
624 | 630 | |
625 | 631 | <tp:simple-type name="List_Handle" type="u" |
626 | 632 | array-name="List_Handle_List"> |
633 | <tp:deprecated version="0.25.0">Replaced by <tp:dbus-ref | |
634 | namespace="org.freedesktop.Telepathy">Connection.Interface.ContactList</tp:dbus-ref> | |
635 | </tp:deprecated> | |
627 | 636 | <tp:docstring>An unsigned 32-bit integer representing a handle of type |
628 | 637 | Handle_Type_List</tp:docstring> |
629 | 638 | </tp:simple-type> |
630 | 639 | |
631 | 640 | <tp:simple-type name="Group_Handle" type="u" |
632 | 641 | array-name="Group_Handle_List"> |
642 | <tp:deprecated version="0.25.0">Replaced by <tp:dbus-ref | |
643 | namespace="org.freedesktop.Telepathy">Connection.Interface.ContactList</tp:dbus-ref> | |
644 | </tp:deprecated> | |
633 | 645 | <tp:docstring>An unsigned 32-bit integer representing a handle of type |
634 | 646 | Handle_Type_Group</tp:docstring> |
635 | 647 | </tp:simple-type> |
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.24.0</tp:version> | |
5 | <tp:version>0.25.0</tp:version> | |
6 | 6 | |
7 | 7 | <tp:copyright>Copyright © 2005-2011 Collabora Limited</tp:copyright> |
8 | 8 | <tp:copyright>Copyright © 2005-2011 Nokia Corporation</tp:copyright> |
161 | 161 | <xi:include href="Channel_Interface_Addressing.xml"/> |
162 | 162 | <xi:include href="Channel_Interface_Anonymity.xml"/> |
163 | 163 | <xi:include href="Channel_Interface_Destroyable.xml"/> |
164 | <xi:include href="Channel_Interface_File_Transfer_Metadata.xml"/> | |
164 | 165 | <xi:include href="Channel_Interface_Group.xml"/> |
165 | 166 | <xi:include href="Channel_Interface_Password.xml"/> |
166 | 167 | <xi:include href="Channel_Interface_Room.xml"/> |
170 | 171 | <xi:include href="Channel_Interface_Securable.xml"/> |
171 | 172 | <xi:include href="Channel_Interface_Service_Point.xml"/> |
172 | 173 | <xi:include href="Channel_Interface_Subject.xml"/> |
174 | <xi:include href="Channel_Interface_Picture.xml"/> | |
173 | 175 | <xi:include href="Channel_Interface_Tube.xml"/> |
174 | 176 | |
175 | 177 | <tp:section name="Text-specific interfaces"> |
1056 | 1056 | # rewrite the D-Bus type |
1057 | 1057 | self.dbus_type = 'a{%s}' % ''.join(map(lambda m: m.dbus_type, self.members)) |
1058 | 1058 | |
1059 | # not sure why tp:mapping sometimes has a type attribute, but | |
1060 | # make sure it's right. | |
1061 | t = dom.getAttribute('type') | |
1062 | if t and self.dbus_type != t: | |
1063 | raise TypeMismatch('%r reports type is %s but actual type is %s' | |
1064 | % (self, t, self.dbus_type)) | |
1065 | ||
1059 | 1066 | class Struct(StructLike): |
1060 | 1067 | |
1061 | 1068 | devhelp_name = "struct" |