[Telepathy-commits] [telepathy-glib/master] Update to the latest spec draft
sjoerd at luon.net
sjoerd at luon.net
Mon Aug 11 11:22:07 PDT 2008
20080811182207-be0f2-f4593f8b81097256b10bacc1d832acf341904102.gz
---
spec/Connection.xml | 7 ++---
spec/Connection_Interface_Aliasing.xml | 23 +++++++++++++++++
spec/Connection_Interface_Capabilities.xml | 2 +-
spec/Connection_Interface_Contacts.xml | 36 ++++++++++++++++-----------
spec/Connection_Interface_Presence.xml | 4 +-
spec/Connection_Manager.xml | 2 +-
6 files changed, 51 insertions(+), 23 deletions(-)
diff --git a/spec/Connection.xml b/spec/Connection.xml
index b350f14..f5d914e 100644
--- a/spec/Connection.xml
+++ b/spec/Connection.xml
@@ -100,7 +100,7 @@ USA.</p>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected">
<tp:docstring>
- Before version 0.17.UNRELEASED calling GetInterfaces while
+ Before version 0.17.8 calling GetInterfaces while
on a connection that is not yet CONNECTED wasn't allowed. If a
CM returns this error, its list of interfaces should be regarded
as empty until it becomes CONNECTED.
@@ -657,9 +657,8 @@ USA.</p>
functionality, such as the Connection.Interface.Presence for receiving and
reporting presence information, and Connection.Interface.Aliasing for
connections where contacts may set and change an alias for themselves.
- These interfaces can be discovered using GetInterfaces after the
- connection, has been established and must not change subsequently at
- runtime.</p>
+ These interfaces can be discovered using the
+ <tp:member-ref>GetInterfaces</tp:member-ref> method.</p>
<p>Contacts, rooms, and server-stored lists (such as subscribed contacts,
block lists, or allow lists) on a service are all represented by
diff --git a/spec/Connection_Interface_Aliasing.xml b/spec/Connection_Interface_Aliasing.xml
index c975adf..5f3a7df 100644
--- a/spec/Connection_Interface_Aliasing.xml
+++ b/spec/Connection_Interface_Aliasing.xml
@@ -103,6 +103,29 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
</tp:possible-errors>
</method>
+ <method name="GetAliases">
+ <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]">
+ <tp:docstring>
+ An array of handles representing contacts
+ </tp:docstring>
+ </arg>
+ <arg direction="out" type="a{us}" tp:type="Alias_Map">
+ <tp:docstring>
+ A dictionary mapping contact handles to aliases
+ </tp:docstring>
+ </arg>
+ <tp:docstring>
+ Request the value of several contacts' aliases at once. This SHOULD
+ only return cached aliases, falling back on the handle name if none is
+ present. Also if there was no cached alias, a request SHOULD be started
+ of which the result is later signal by
+ <tp:member-ref>AliasesChanged</tp:member-ref>.
+ </tp:docstring>
+ <tp:possible-errors>
+ <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
+ <tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
+ </tp:possible-errors>
+ </method>
<method name="SetAliases">
<arg direction="in" name="aliases" type="a{us}" tp:type="Alias_Map">
<tp:docstring>
diff --git a/spec/Connection_Interface_Capabilities.xml b/spec/Connection_Interface_Capabilities.xml
index 3e84c6b..95fbaaf 100644
--- a/spec/Connection_Interface_Capabilities.xml
+++ b/spec/Connection_Interface_Capabilities.xml
@@ -47,7 +47,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
to them which are implemented by available client processes.</p>
</tp:docstring>
- <tp:changed version="0.17.UNRELEASED">Previously, this interface
+ <tp:changed version="0.17.8">Previously, this interface
also expressed capabilities of the connection itself, indicating what
sorts of channels could be requested (for instance, the ability to
open chatroom lists or chatrooms). However, this was never very
diff --git a/spec/Connection_Interface_Contacts.xml b/spec/Connection_Interface_Contacts.xml
index 9c9af7b..69eea92 100644
--- a/spec/Connection_Interface_Contacts.xml
+++ b/spec/Connection_Interface_Contacts.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" ?>
-<node name="/Connection_Interface_Contacts" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<node name="/Connection_Interface_Contact" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<tp:copyright> Copyright (C) 2005-2008 Collabora Limited </tp:copyright>
<tp:copyright> Copyright (C) 2005, 2006 Nokia Corporation </tp:copyright>
<tp:copyright> Copyright (C) 2006 INdT </tp:copyright>
@@ -18,7 +18,8 @@
along with this library; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
</tp:license>
- <interface name="org.freedesktop.Telepathy.Connection.Interface.Contacts">
+ <interface name="org.freedesktop.Telepathy.Connection.Interface.Contacts.DRAFT"
+ tp:causes-havoc="experimental">
<tp:requires interface="org.freedesktop.Telepathy.Connection"/>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
@@ -37,25 +38,29 @@
<dl>
<dt>org.freedesktop.Telepathy.Connection/contact-id
(type s)</dt>
- <dd>The same string that would be returned by <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Connection">InspectHandles</tp:dbus-ref>
+ <dd>The same string that would be returned by
+ <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">InspectHandles</tp:dbus-ref>
(always present in the result)
</dd>
<dt>org.freedesktop.Telepathy.Connection.Interface.Aliasing/alias
(type s)</dt>
- <dd>The contact's alias as defined by the <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Connection.Interface">Aliasing</tp:dbus-ref>
- interface (always present with some value, possibly the
+ <dd>The same string that would be returned by <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Connection.Interface.Aliasing">GetAliases</tp:dbus-ref>
+ (always present with some value, possibly the
same as Connection/contact-id, if information from the
Aliasing interface was requested)
</dd>
<dt>org.freedesktop.Telepathy.Connection.Interface.Avatars/token
(type s</dt>
<dd>The same string that would be returned by <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Connection.Interface.Avatars">GetAvatarTokens</tp:dbus-ref>
+ namespace="org.freedesktop.Telepathy.Connection.Interface.Avatars">GetKnownAvatarTokens</tp:dbus-ref>
(omitted from the result if the contact's avatar token is not known,
present as an empty string if the contact is known not to have
- an avatar)
+ an avatar). Unlike in the <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Connection.Interface.Avatars">GetKnownAvatarTokens</tp:dbus-ref>
+ method, the avatar tokens for the self handle aren't required to be
+ present. This attribute should not be used to determine whether or
+ not the Avatar needs to be set.
</dd>
<dt>org.freedesktop.Telepathy.Connection.Interface.SimplePresence/presence
(type (uss), <tp:type>Simple_Presence</tp:type>)</dt>
@@ -108,7 +113,7 @@
</tp:mapping>
<tp:mapping name="Contact_Attributes_Map">
- <tp:docstring>Mapping returned by InspectContacts, representing a
+ <tp:docstring>Mapping returned by GetContactAttributes, representing a
collection of Contacts and their requested attributes.</tp:docstring>
<tp:member type="u" tp:type="Contact_Handle" name="Contact">
@@ -125,16 +130,16 @@
</tp:member>
</tp:mapping>
- <property name="InspectableInterfaces" access="read" type="as"
+ <property name="ContactAttributeInterfaces" access="read" type="as"
tp:type="DBus_Interface[]">
<tp:docstring>
A list of D-Bus interfaces for which
- <tp:member-ref>InspectContacts</tp:member-ref> is expected to work.
+ <tp:member-ref>GetContactAttributes</tp:member-ref> is expected to work.
This cannot change during the lifetime of the Connection.
</tp:docstring>
</property>
- <method name="InspectContacts">
+ <method name="GetContactAttributes">
<tp:docstring>
Return any number of contact attributes for the given handles.
</tp:docstring>
@@ -155,7 +160,8 @@
<p>It is an error to request interfaces that are not supported by
this Connection (i.e. mentioned in the
- <tp:member-ref>InspectableInterfaces</tp:member-ref> property).</p>
+ <tp:member-ref>ContactAttributeInterfaces</tp:member-ref>
+ property).</p>
<tp:rationale>
<p>This makes it possible to distinguish between interfaces for
@@ -214,7 +220,7 @@
<tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument">
<tp:docstring>
One of the requested interfaces is not supported (mentioned in
- <tp:member-ref>InspectableInterfaces</tp:member-ref>).
+ <tp:member-ref>ContactAttributeInterfaces</tp:member-ref>).
</tp:docstring>
</tp:error>
</tp:possible-errors>
diff --git a/spec/Connection_Interface_Presence.xml b/spec/Connection_Interface_Presence.xml
index 489ac23..4ba59b6 100644
--- a/spec/Connection_Interface_Presence.xml
+++ b/spec/Connection_Interface_Presence.xml
@@ -367,14 +367,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Unknown" value="7">
- <tp:added version="0.17.UNRELEASED"/>
+ <tp:added version="0.17.8"/>
<tp:docstring>
Unknown, unable to determine presence for this contact, for example
if the protocol only allows presence of subscribed contacts.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Error" value="8">
- <tp:added version="0.17.UNRELEASED"/>
+ <tp:added version="0.17.8"/>
<tp:docstring>
Error, an error occurred while trying to determine presence. The
message, if set, is an error from the server.
diff --git a/spec/Connection_Manager.xml b/spec/Connection_Manager.xml
index 760e574..33f1ede 100644
--- a/spec/Connection_Manager.xml
+++ b/spec/Connection_Manager.xml
@@ -334,7 +334,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
this property fails, clients SHOULD assume that its value is
an empty list.</p>
</tp:docstring>
- <tp:added version="0.17.UNRELEASED"/>
+ <tp:added version="0.17.8"/>
</property>
<!-- FIXME: One thing we could perhaps use Interfaces for would be a
--
1.5.6.3
More information about the Telepathy-commits
mailing list