[next] telepathy-spec: Remove RequestHandles
Xavier Claessens
xclaesse at kemper.freedesktop.org
Thu Jun 7 07:24:04 PDT 2012
Module: telepathy-spec
Branch: next
Commit: e0e70eb6b76b637518d8a1a0c7e292e6a1615ec0
URL: http://cgit.freedesktop.org/telepathy/telepathy-spec/commit/?id=e0e70eb6b76b637518d8a1a0c7e292e6a1615ec0
Author: Xavier Claessens <xavier.claessens at collabora.co.uk>
Date: Thu May 31 15:15:04 2012 +0200
Remove RequestHandles
Getting an handle isn't a goal in itself, real operations can be done
directly using the ID nowadays (GetContactByID and TargetID for
channel requests)
---
spec/Channel.xml | 7 +---
spec/Connection.xml | 54 --------------------------------
spec/Connection_Interface_Contacts.xml | 3 +-
spec/Protocol.xml | 7 ++--
4 files changed, 6 insertions(+), 65 deletions(-)
diff --git a/spec/Channel.xml b/spec/Channel.xml
index 194f596..b688397 100644
--- a/spec/Channel.xml
+++ b/spec/Channel.xml
@@ -132,17 +132,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
present. Properties from
<tp:dbus-ref namespace="im.telepathy1.Channel.Interface">Addressing1</tp:dbus-ref>
MUST NOT be present.The request MUST fail with error InvalidHandle,
- without side-effects, if the requested TargetID would not be
- accepted by
- <tp:dbus-ref namespace="im.telepathy1.Connection">RequestHandles</tp:dbus-ref>.</p>
+ without side-effects, if the requested TargetID is invalid.</p>
<p>The returned channel must be related to the handle corresponding
to the given identifier, in the same way as if TargetHandle
had been part of the request instead.</p>
<tp:rationale>
- <p>Requesting channels with a string identifier saves a round-trip
- (the call to RequestHandles). It also allows the channel
+ <p>Requesting channels with a string identifier allows the channel
dispatcher to accept a channel request for an account that is not
yet connected (and thus has no valid handles), bring the account
online, and pass on the same parameters to the new connection's
diff --git a/spec/Connection.xml b/spec/Connection.xml
index b412ec3..a20d9f2 100644
--- a/spec/Connection.xml
+++ b/spec/Connection.xml
@@ -221,60 +221,6 @@ USA.</p>
Handle_Type_Room</tp:docstring>
</tp:simple-type>
- <method name="RequestHandles" tp:name-for-bindings="Request_Handles">
- <arg direction="in" name="Handle_Type" type="u" tp:type="Handle_Type">
- <tp:docstring>
- The type of handle required
- </tp:docstring>
- </arg>
-
- <arg direction="in" name="Identifiers" type="as">
- <tp:docstring>
- An array of identifiers of entities to request handles for
- </tp:docstring>
- </arg>
-
- <arg direction="out" type="au" tp:type="Handle[]"
- name="Handles">
- <tp:docstring>
- An array of integer handle numbers in the same order as the given identifiers.
- </tp:docstring>
- </arg>
-
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Request several handles from the connection manager which represent a
- number of contacts, rooms or server-stored lists on the service.</p>
- </tp:docstring>
-
- <tp:possible-errors>
- <tp:error name="im.telepathy1.Error.Disconnected"/>
- <tp:error name="im.telepathy1.Error.InvalidHandle">
- <tp:docstring>
- The given identifier does not identify a valid entity of the given
- type.
-
- <tp:rationale>
- For instance, an XMPP connection would raise this error for
- identifiers with type Handle_Type_Room that do not contain
- exactly one '@' character, that contain spaces, and so on.
- </tp:rationale>
- </tp:docstring>
- </tp:error>
- <tp:error name="im.telepathy1.Error.NotImplemented">
- <tp:docstring>
- The given handle type is not valid, or is not implemented on this
- connection.
-
- <tp:rationale>
- For instance, a connection to a protocol that doesn't have
- chat rooms would raise this error for room handles, and all CMs
- would raise this error for Handle_Type_None.
- </tp:rationale>
- </tp:docstring>
- </tp:error>
- </tp:possible-errors>
- </method>
-
<tp:enum name="Connection_Status" plural="Connection_Statuses" type="u">
<tp:enumvalue suffix="Connected" value="0">
<tp:docstring>
diff --git a/spec/Connection_Interface_Contacts.xml b/spec/Connection_Interface_Contacts.xml
index e777620..f105045 100644
--- a/spec/Connection_Interface_Contacts.xml
+++ b/spec/Connection_Interface_Contacts.xml
@@ -204,8 +204,7 @@
<arg direction="out" name="Handle" type="u" tp:type="Contact_Handle">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>The contact's handle, as returned by <tp:dbus-ref
- namespace="imt1.Connection">RequestHandles</tp:dbus-ref></p>
+ <p>The contact's handle</p>
</tp:docstring>
</arg>
diff --git a/spec/Protocol.xml b/spec/Protocol.xml
index 7197b81..9c91c1c 100644
--- a/spec/Protocol.xml
+++ b/spec/Protocol.xml
@@ -372,10 +372,9 @@ allowed=im.telepathy1.Channel.TargetHandle;im.telepathy1.Channel.TargetID;im.tel
tp:name-for-bindings="Normalize_Contact">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Attempt to normalize the given contact ID. Where possible, this
- SHOULD return the same thing that would be returned by
- InspectHandles(RequestHandles(CONTACT, [Contact_ID])) on a connected
- <tp:dbus-ref namespace="im.telepathy1"
- >Connection</tp:dbus-ref>.</p>
+ SHOULD return the same thing that would be returned by GetContactByID
+ on a connected <tp:dbus-ref namespace="im.telepathy1"
+ >Connection</tp:dbus-ref>.</p>
<p>If full normalization requires network activity or is otherwise
impossible to do without a <tp:dbus-ref
More information about the telepathy-commits
mailing list