Codebase list telepathy-spec / 2b1af50
Imported Upstream version 0.23.3 Jonny Lamb 12 years ago
16 changed file(s) with 246 addition(s) and 20 deletion(s). Raw diff Collapse all Expand all
+88
-0
ChangeLog less more
0 commit 134752a6e93b0c7d74482d1a0dc1a250c244c7f8
1 Author: Will Thompson <will.thompson@collabora.co.uk>
2 Date: Thu Jul 14 16:27:10 2011 +0100
3
4 Version 0.23.3
5
6 commit ea0b99467075338861dc4d546077dcacc76d6da5
7 Author: Will Thompson <will.thompson@collabora.co.uk>
8 Date: Thu Jul 14 16:26:35 2011 +0100
9
10 NEWS for 0.23.3
11
12 commit e9fa42cd452d504013cb9164e4624b33477ed271
13 Author: João Paulo Rechi Vita <jprvita@gmail.com>
14 Date: Sat Jun 4 19:35:53 2011 -0300
15
16 Adds UPLOAD_BRANCH_HOST command-line variable
17
18 This fixes upload-branch output.
19
20 Signed-off-by: Will Thompson <will.thompson@collabora.co.uk>
21
22 commit bf4b8aa9ebda7ba40ee907b09948c7ff739e34cc
23 Merge: 169dbed fc38a62
24 Author: Danielle Madeley <danielle.madeley@collabora.co.uk>
25 Date: Fri Jun 24 16:40:09 2011 +0800
26
27 Merge branch 'css-trivia'
28
29 commit 169dbedc698181b5d577a86fcc1217ccad0a06d6
30 Author: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk>
31 Date: Thu Jun 23 11:00:53 2011 +0200
32
33 Add a favicon to the generated HTML spec (#38594)
34
35 commit fc38a620798f1e03f318bf5a152d227f7bc3084c
36 Author: Danielle Madeley <danielle.madeley@collabora.co.uk>
37 Date: Tue Jun 21 20:18:53 2011 +0800
38
39 Fix CSS for anchors in WebKit
40
41 WebKit was ignoring the CSS to adjust the position of anchors for the fixed
42 title bar. The fix is to make the anchor a block element.
43
44 commit b68efdb1af6bccd466fed919c64190bad3677f47
45 Author: Danielle Madeley <danielle.madeley@collabora.co.uk>
46 Date: Mon Jun 13 15:32:13 2011 +0100
47
48 Add ChannelRequest hint ofdT.ChannelRequest.DelegateToPreferredHandler
49
50 Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=38240
51
52 commit 187fc7231eaa871db81466f70a99edfbdb95eed8
53 Author: Xavier Claessens <xclaesse@gmail.com>
54 Date: Mon May 30 09:43:35 2011 +0200
55
56 Set immutable and requestable tags on FileTransfer properties
57
58 commit fc63a2603b8c92b61d30398ce463e343353f7336
59 Author: Xavier Claessens <xclaesse@gmail.com>
60 Date: Sun May 29 17:49:58 2011 +0200
61
62 Approvers can set URI on FileTransfer channels
63
64 commit 13355a79437fb52b8e735b1f1fc7aa62ba24991c
65 Author: David Laban <david.laban@collabora.co.uk>
66 Date: Tue May 24 22:04:06 2011 -0400
67
68 Add original-message-{sent,received}
69
70 This is required by the logger, and also makes it unambiguous that
71 the message-{sent,received} of the Message refer to that of the the edit,
72 rather than that of the original message.
73
74 commit 02059b91d902edab8d1464dc26d8abc62e396ca9
75 Author: David Laban <david.laban@collabora.co.uk>
76 Date: Tue May 24 22:00:10 2011 -0400
77
78 Clarify the acceptable forms for supersedes
79
80 As discussed on fd.o#37413
81
82 commit 2eb580aed6ef088117041d2a1b4938a597b3e82b
83 Author: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk>
84 Date: Mon May 16 10:43:48 2011 +0200
85
86 bump
87
088 commit da539f3e06ba711004974d28c7c90411c7e2b8ad
189 Author: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk>
290 Date: Mon May 16 10:37:47 2011 +0200
+3
-2
Makefile less more
9090 rm -rf tmp/"$(DISTNAME)"
9191
9292 BRANCH = $(shell sh tools/git-which-branch.sh misc | tr -d '\n' | tr -C "[:alnum:]" _)
93 UPLOAD_BRANCH_TO = people.freedesktop.org:public_html/telepathy-spec
93 UPLOAD_BRANCH_HOST = people.freedesktop.org
94 UPLOAD_BRANCH_TO = $(UPLOAD_BRANCH_HOST):public_html/telepathy-spec
9495
9596 # Usage: make upload-branch BRANCH=discussion
9697 upload-branch: all
9798 rsync -rzvP --delete doc/spec \
9899 $(UPLOAD_BRANCH_TO)-$(BRANCH)/
99100 @echo Your spec branch might be at:
100 @echo ' ' http://people.freedesktop.org/~$$USER/telepathy-spec-$(BRANCH)/spec/
101 @echo ' ' http://$(UPLOAD_BRANCH_HOST)/~$$USER/telepathy-spec-$(BRANCH)/spec/
101102
102103 # automake requires these rules for anything that's in DIST_SUBDIRS
103104 distclean: clean
+31
-0
NEWS less more
00 This file contains the same edited highlights as the announcement emails.
11 For full details, see the ChangeLog in tarballs, or "git log" in Git
22 checkouts.
3
4 telepathy-spec 0.23.3 (2011-07-14)
5 ==================================
6
7 API additions and clarifications:
8
9 • The semantics of the 'supersedes' header in Messages have been clarified, and
10 'original-message-sent' and 'original-message-received' headers have been
11 defined to make the timestamps used for message edits unambiguous.
12 (fd.o#37413, David)
13
14 • A tonne of properties on FileTransfer have been marked as requestable and/or
15 immutable. Also, as a clarification, the spec now explicitly says that
16 approvers may set the URI property, and that handlers MUST obey this.
17 (Xavier)
18
19 • A new ChannelRequest hint, DelegateToPreferredHandler, has been added.
20 (fd.o#38240, Danni)
21
22 Spec HTML improvements:
23
24 • Jumping to anchors within the spec HTML will no longer move the text you're
25 looking for underneath the title bar with Webkit. Yay! (Danni (my heroine))
26
27 • The generated HTML spec now has a beautiful favicon. (fd.o#38594, Guillaume)
28
29 And for spec developers:
30
31 • `make upload-branch` now takes an optional UPLOAD_BRANCH_TO Makefile
32 variable, which allows you to override the default server, namely
33 “people.freedesktop.org” (João Paulo Rechi Vita)
334
435 telepathy-spec 0.23.2 (2011-05-16)
536 ==================================
+1
-0
doc/templates/errors.html less more
33 <head>
44 <title>Errors</title>
55 <link rel="stylesheet" href="style.css" type="text/css"/>
6 <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
67 </head>
78 <body>
89 <div class="header">
doc/templates/favicon.png less more
Binary diff not shown
+1
-0
doc/templates/fullindex.html less more
44 <head>
55 <title>Full Index</title>
66 <link rel="stylesheet" href="style.css" type="text/css"/>
7 <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
78 </head>
89
910 #set $star = []
+1
-0
doc/templates/generic-types.html less more
33 <head>
44 <title>Generic Types</title>
55 <link rel="stylesheet" href="style.css" type="text/css"/>
6 <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
67 </head>
78 <body>
89 <div class="header">
+1
-0
doc/templates/index.html less more
33 <head>
44 <title>$spec.title &mdash; v$spec.version</title>
55 <link rel="stylesheet" href="style.css" type="text/css"/>
6 <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
67 </head>
78 <body>
89 <div class="header">
+1
-0
doc/templates/interface.html less more
33 <head>
44 <title>$interface.really_short_name &mdash; $spec.title</title>
55 <link rel="stylesheet" href="style.css" type="text/css"/>
6 <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
67 <script src="jquery.min.js"></script>
78 <script src="magic.js"></script>
89 </head>
+1
-0
doc/templates/interfaces.html less more
33 <head>
44 <title>$spec.title &mdash; v$spec.version</title>
55 <link rel="stylesheet" href="style.css" type="text/css"/>
6 <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
67 </head>
78 <body>
89 <div class="header">
+2
-1
doc/templates/style.css less more
4848 }
4949
5050 div.main a[name] {
51 display: block;
5152 position: relative;
52 top: -4.5em;
53 top: -5em;
5354 }
5455
5556 div.outset {
+56
-5
spec/Channel_Interface_Messages.xml less more
598598
599599 <dt>supersedes (s – <tp:type>Protocol_Message_Token</tp:type>)</dt>
600600 <dd>If present, this message supersedes a previous message,
601 identified by its <tt>protocol-token</tt> or
602 <tt>message-token</tt> header. The user interface MAY, for
603 example, choose to replace the superseded message with this
604 message, or grey out the superseded message.
601 identified by its <tt>message-token</tt> header. The user
602 interface MAY, for example, choose to replace the superseded
603 message with this message, or grey out the superseded message.
605604
606605 <tp:rationale>Skype, for example, allows the user to amend
607606 messages they have already sent (to correct typos,
608607 etc.).</tp:rationale>
609 </dd>
608
609 Connection Managers SHOULD represent repeatedly edited messages
610 in the following form:
611 <pre>
612 message {token = a};
613 message {token = b, supersedes = a};
614 message {token = c, supersedes = a};
615 </pre>
616
617 <tp:rationale>The alternative form is:
618 <pre>
619 message {token = a};
620 message {token = b, supersedes = a};
621 message {token = c, supersedes = b};
622 </pre>
623 but it is more difficult to implement in UIs/loggers, and it
624 breaks irrecoverably if message b is lost. If a CM is forced
625 to use this form, it should be tested extensively for
626 interoperability with existing clients.
627 </tp:rationale>
628
629 Clients should deal gracefully if the original message gets
630 lost, but one or more corrections to it get through:
631 <pre>
632 message {token = x} gets lost;
633 message {token = y, supersedes = x};
634 message {token = z, supersedes = x};
635 </pre>
636
637 <tp:rationale>This is the form that CMs will use to mean "I know
638 that this message was edited, but I don't know what it
639 originally said." It is often in the interests of the
640 remote side for message x to be lost (e.g. to hide
641 embarassing mistakes or sensitive information) so it might not
642 be possible to retrieve it (even on protocols with reliable
643 message-delivery guarantees).</tp:rationale></dd>
644
645 <dt>original-message-sent (x - <tp:type>Unix_Timestamp64</tp:type>)</dt>
646 <dd>The <tt>message-sent</tt> header of the message that this
647 one supersedes.
648 This key should only be present if <tt>supersedes</tt> is also
649 present. It MAY be used as a hint to help clients locate the
650 original message in its logs. If present, comparing the tuple
651 (original-message-sent, supersedes) with (message-sent,
652 message-token) SHOULD be enough to uniquely
653 identify the original message.</dd>
654
655 <dt>original-message-received (x - <tp:type>Unix_Timestamp64</tp:type>)</dt>
656 <dd>The <tt>message-received</tt> header of the message that this
657 one supersedes.
658 This key should only be present if <tt>supersedes</tt> is also
659 present. It MAY be used as a hint in a similar way to
660 <tt>original-message-sent</tt>.</dd>
610661
611662 <dt>pending-message-id (u - <tp:type>Message_ID</tp:type>)</dt>
612663 <dd>The incoming message ID. This MUST NOT be present on outgoing
+43
-1
spec/Channel_Request.xml less more
217217 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
218218 <p>A dictionary of metadata provided by the channel
219219 requester, which the handler and other clients MAY choose to
220 interpret. Currently no standard keys are defined; clients MAY
220 interpret. Clients MAY
221221 choose to use platform-specific keys for their own purposes, but MUST
222222 ignore unknown keys and MUST cope with expected keys being
223223 missing. Clients SHOULD namespace hint names by having them
248248 namespace="ofdT.Client.Interface.Requests">AddRequest</tp:dbus-ref>
249249 by the <tp:dbus-ref
250250 namespace="org.freedesktop.Telepathy">ChannelDispatcher</tp:dbus-ref>.</p>
251 <p>The following standardised hints are defined:</p>
252
253 <dl>
254 <dt>org.freedesktop.Telepathy.ChannelRequest.DelegateToPreferredHandler - b</dt>
255 <dd>If present and True the client currently handling the channel
256 SHOULD pass the channel to the
257 <tp:member-ref>PreferredHandler</tp:member-ref> using
258 <tp:dbus-ref namespace="ofdT.ChannelDispatcher">DelegateChannels</tp:dbus-ref>.
259
260 <tp:rationale>
261 This hint allows the user to request a channel in their
262 preferred client in a situation where there are two chat
263 handlers (for example: requesting a channel in Empathy which is
264 currently being handled by gnome-shell).
265 </tp:rationale>
266
267 If the channel is currently unhandled, clients SHOULD ignore this
268 hint.
269
270 <tp:rationale>
271 It is assumed that Mission Control will correctly delegate an
272 unhandled channel to the preferred Handler. This allows
273 requesting clients to always include this hint in their channel
274 request.
275 </tp:rationale>
276
277 The Handler should check each
278 <tp:dbus-ref namespace="ofdT">ChannelRequest</tp:dbus-ref>
279 of the Requests_Satisfied parameter of
280 <tp:dbus-ref namespace="ofdT.Client.Handler">HandleChannels</tp:dbus-ref>
281 for the hint. The first request containing the hint SHOULD be used
282 and all further hints SHOULD be ignored.
283
284 <tp:rationale>
285 This covers the very unlikely case where
286 <tp:dbus-ref namespace="ofdT.Client.Handler">HandleChannels</tp:dbus-ref>
287 satisfies two separate requests which have different
288 <tp:member-ref>PreferredHandler</tp:member-ref>s.
289 </tp:rationale>
290 </dd>
291 </dl>
292
251293 </tp:docstring>
252294 </property>
253295
+15
-10
spec/Channel_Type_File_Transfer.xml less more
9595 </property>
9696
9797 <property name="ContentType" type="s" access="read"
98 tp:name-for-bindings="Content_Type">
98 tp:name-for-bindings="Content_Type" tp:immutable="yes" tp:requestable="yes">
9999 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
100100 <p>The file's MIME type. This cannot change once the channel has
101101 been created.</p>
108108 </property>
109109
110110 <property name="Filename" type="s" access="read"
111 tp:name-for-bindings="Filename">
111 tp:name-for-bindings="Filename" tp:immutable="yes" tp:requestable="yes">
112112 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
113113 <p>The name of the file on the sender's side. This is therefore given
114114 as a suggested filename for the receiver. This cannot change
125125 </property>
126126
127127 <property name="Size" type="t" access="read"
128 tp:name-for-bindings="Size">
128 tp:name-for-bindings="Size" tp:immutable="yes" tp:requestable="yes">
129129 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
130130 <p>The size of the file. If this property is set, then the file
131131 transfer is guaranteed to be this size. This cannot change once
144144 </property>
145145
146146 <property name="ContentHashType" type="u" tp:type="File_Hash_Type"
147 access="read" tp:name-for-bindings="Content_Hash_Type">
147 access="read" tp:name-for-bindings="Content_Hash_Type" tp:immutable="yes"
148 tp:requestable="yes">
148149 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
149150 <p>The type of the <tp:member-ref>ContentHash</tp:member-ref> property.</p>
150151
167168 </property>
168169
169170 <property name="ContentHash" type="s" access="read"
170 tp:name-for-bindings="Content_Hash">
171 tp:name-for-bindings="Content_Hash" tp:immutable="yes"
172 tp:requestable="yes">
171173 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
172174 <p>Hash of the contents of the file transfer, of type described
173175 in the value of the <tp:member-ref>ContentHashType</tp:member-ref>
183185 </property>
184186
185187 <property name="Description" type="s" access="read"
186 tp:name-for-bindings="Description">
188 tp:name-for-bindings="Description" tp:immutable="yes" tp:requestable="yes">
187189 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
188190 <p>Description of the file transfer. This cannot change once the
189191 channel has been created.</p>
196198 </property>
197199
198200 <property name="Date" type="x" access="read"
199 tp:type="Unix_Timestamp64" tp:name-for-bindings="Date">
201 tp:type="Unix_Timestamp64" tp:name-for-bindings="Date" tp:immutable="yes"
202 tp:requestable="yes">
200203 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
201204 <p>The last modification time of the file being transferred. This
202205 cannot change once the channel has been created</p>
209212
210213 <property name="AvailableSocketTypes" type="a{uau}"
211214 tp:type="Supported_Socket_Map" access="read"
212 tp:name-for-bindings="Available_Socket_Types">
215 tp:name-for-bindings="Available_Socket_Types"
216 tp:immutable="yes" tp:requestable="yes">
213217 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
214218 <p>A mapping from address types (members of Socket_Address_Type) to
215219 arrays of access-control type (members of Socket_Access_Control)
242246 </property>
243247
244248 <property name="InitialOffset" type="t" access="read"
245 tp:name-for-bindings="Initial_Offset">
249 tp:name-for-bindings="Initial_Offset" tp:requestable="yes">
246250 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
247251 <p>The offset in bytes from where the file should be sent. This MUST
248252 be respected by both the receiver and the sender after the state
275279
276280 <p>For incoming file transfers, this property MAY be set by the channel
277281 handler before calling <tp:member-ref>AcceptFile</tp:member-ref> to
278 inform observers where the incoming file will be saved.
282 inform observers where the incoming file will be saved. If set by an
283 approver, the handler MUST save the file to that location.
279284 Setting this property once <tp:member-ref>AcceptFile</tp:member-ref>
280285 has been called MUST fail. Once this property has been set
281286 <tp:member-ref>URIDefined</tp:member-ref> is emitted.</p>
+1
-1
spec/all.xml less more
22 xmlns:xi="http://www.w3.org/2001/XInclude">
33
44 <tp:title>Telepathy D-Bus Interface Specification</tp:title>
5 <tp:version>0.23.2</tp:version>
5 <tp:version>0.23.3</tp:version>
66
77 <tp:copyright>Copyright © 2005-2011 Collabora Limited</tp:copyright>
88 <tp:copyright>Copyright © 2005-2011 Nokia Corporation</tp:copyright>
+1
-0
tools/doc-generator.py less more
5757 'jquery.min.js',
5858 'ui-icons_222222_256x240.png',
5959 'magic.js',
60 'favicon.png'
6061 ]
6162 for s in static:
6263 shutil.copy(os.path.join(template_path, s), output_path)