[telepathy-spec/master] Uniformize to use Identifier everywhere (fd.o #23301)
Olivier Le Thanh Duong
olivier at lethanh.be
Thu Aug 13 14:54:52 PDT 2009
The spec was a bit inconsistent for naming the string corresponding
to a handle.
---
spec/Channel_Type_Room_List.xml | 2 +-
spec/Channel_Type_Text.xml | 4 ++--
spec/Connection.xml | 22 ++++++++++++----------
spec/Connection_Interface_Aliasing.xml | 7 ++++---
spec/Connection_Interface_Renaming.xml | 2 +-
spec/errors.xml | 2 +-
6 files changed, 21 insertions(+), 18 deletions(-)
diff --git a/spec/Channel_Type_Room_List.xml b/spec/Channel_Type_Room_List.xml
index 93ea777..6d6ce31 100644
--- a/spec/Channel_Type_Room_List.xml
+++ b/spec/Channel_Type_Room_List.xml
@@ -74,7 +74,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<dl>
<dt>handle-name (s)</dt>
- <dd>The string name of the room handle (as would be returned by
+ <dd>The identifier of the room (as would be returned by
<tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">InspectHandles</tp:dbus-ref>)</dd>
<dt>name (s)</dt>
diff --git a/spec/Channel_Type_Text.xml b/spec/Channel_Type_Text.xml
index 7d6e314..5315a55 100644
--- a/spec/Channel_Type_Text.xml
+++ b/spec/Channel_Type_Text.xml
@@ -419,8 +419,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:property>
<tp:property name="name" type="s">
<tp:docstring>
- A human-visible name for the channel, if it differs from the string
- version of the channel's handle.
+ A human-visible name for the channel, if it differs from the channel's
+ <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">TargetID</tp:dbus-ref>.
</tp:docstring>
</tp:property>
<tp:property name="description" type="s">
diff --git a/spec/Connection.xml b/spec/Connection.xml
index f321363..5ff5c2b 100644
--- a/spec/Connection.xml
+++ b/spec/Connection.xml
@@ -251,7 +251,7 @@ USA.</p>
<arg direction="out" type="as" name="Identifiers">
<tp:docstring>
- An array of handle names in the same order as the given numbers
+ An array of identifiers corresponding to the given handles, in the same order.
</tp:docstring>
</arg>
@@ -591,16 +591,16 @@ USA.</p>
</tp:docstring>
</arg>
- <arg direction="in" name="Names" type="as">
+ <arg direction="in" name="Identifiers" type="as">
<tp:docstring>
- An array of names of entities to request handles for
+ 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 strings
+ An array of integer handle numbers in the same order as the given identifiers.
</tp:docstring>
</arg>
@@ -611,16 +611,18 @@ USA.</p>
client who invokes this method, and must not deallocate the handles
until the client disconnects from the bus or calls the
<tp:member-ref>ReleaseHandles</tp:member-ref>
- method. Where the name refers to an entity that already has a handle
- in this connection manager, this handle should be returned instead.
- The handle number 0 must not be returned by the connection manager.
+ method. Where the identifier refers to an entity that already has a
+ handle in this connection manager, this handle should be returned
+ instead. The handle number 0 must not be returned by the connection
+ manager.
</tp:docstring>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
<tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle">
<tp:docstring>
- The given name does not identify a valid entity of the given type.
+ 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
@@ -1030,9 +1032,9 @@ USA.</p>
ambiguous. Connection manager implementations should reference count these
handles to determine if they are in use either by any active clients or any
open channels, and may deallocate them when this ceases to be true. Clients
- may request handles of a given type and name with the
+ may request handles of a given type and identifier with the
<tp:member-ref>RequestHandles</tp:member-ref> method, inspect the entity
- name of handles with the <tp:member-ref>InspectHandles</tp:member-ref>
+ identifier with the <tp:member-ref>InspectHandles</tp:member-ref>
method, keep handles from being released with
<tp:member-ref>HoldHandles</tp:member-ref>, and notify that they are no
longer storing handles with
diff --git a/spec/Connection_Interface_Aliasing.xml b/spec/Connection_Interface_Aliasing.xml
index a599436..dc639d9 100644
--- a/spec/Connection_Interface_Aliasing.xml
+++ b/spec/Connection_Interface_Aliasing.xml
@@ -119,9 +119,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</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 signalled by
+ only return cached aliases, falling back on the contact identifier
+ (i.e. the string corresponding to the handle) if none is present. Also
+ if there was no cached alias, a request SHOULD be started of which the
+ result is later signalled by
<tp:member-ref>AliasesChanged</tp:member-ref>.
</tp:docstring>
<tp:possible-errors>
diff --git a/spec/Connection_Interface_Renaming.xml b/spec/Connection_Interface_Renaming.xml
index c81d7ed..d08b748 100644
--- a/spec/Connection_Interface_Renaming.xml
+++ b/spec/Connection_Interface_Renaming.xml
@@ -65,7 +65,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
</signal>
<method name="RequestRename" tp:name-for-bindings="Request_Rename">
- <arg direction="in" name="Name" type="s">
+ <arg direction="in" name="Identifier" type="s">
<tp:docstring>
The desired identifier
</tp:docstring>
diff --git a/spec/errors.xml b/spec/errors.xml
index f32acea..22a629b 100644
--- a/spec/errors.xml
+++ b/spec/errors.xml
@@ -48,7 +48,7 @@
<tp:error name="Invalid Handle">
<tp:docstring>
- The contact name specified is unknown on this channel or connection.
+ The handle specified is unknown on this channel or connection.
</tp:docstring>
</tp:error>
--
1.5.6.5
More information about the telepathy-commits
mailing list