[Telepathy-commits] [telepathy-spec/master] Group: add cross-references
Will Thompson
will.thompson at collabora.co.uk
Fri Nov 21 04:35:29 PST 2008
---
spec/Channel_Interface_Group.xml | 138 ++++++++++++++++++++++++--------------
1 files changed, 88 insertions(+), 50 deletions(-)
diff --git a/spec/Channel_Interface_Group.xml b/spec/Channel_Interface_Group.xml
index 4e69b88..08fa461 100644
--- a/spec/Channel_Interface_Group.xml
+++ b/spec/Channel_Interface_Group.xml
@@ -24,7 +24,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:struct name="Local_Pending_Info" array-name="Local_Pending_Info_List">
<tp:docstring>A structure representing a contact whose attempt to
join a group is to be confirmed by the local user using
- AddMembers.</tp:docstring>
+ <tp:member-ref>AddMembers</tp:member-ref>.</tp:docstring>
<tp:member type="u" tp:type="Contact_Handle" name="To_Be_Added">
<tp:docstring>
The contact to be added to the group
@@ -65,7 +65,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>A message may be provided along with the request, which will be sent
to the server if supported. See the CHANNEL_GROUP_FLAG_MESSAGE_ADD and
- CHANNEL_GROUP_FLAG_MESSAGE_ACCEPT flags to see in which cases this
+ CHANNEL_GROUP_FLAG_MESSAGE_ACCEPT
+ <tp:member-ref>GroupFlags</tp:member-ref> to see in which cases this
message should be provided.</p>
<p>Attempting to add contacts who are already members is allowed;
@@ -118,49 +119,57 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:flags name="Channel_Group_Flags" value-prefix="Channel_Group_Flag" type="u">
<tp:flag suffix="Can_Add" value="1">
<tp:docstring>
- The AddMembers method can be used to add or invite members who are
+ The <tp:member-ref>AddMembers</tp:member-ref> method can be used to
+ add or invite members who are
not already in the local pending list (which is always valid).
</tp:docstring>
</tp:flag>
<tp:flag suffix="Can_Remove" value="2">
<tp:docstring>
- The RemoveMembers method can be used to remove channel members
+ The <tp:member-ref>RemoveMembers</tp:member-ref> method can be used
+ to remove channel members
(removing those on the pending local list is always valid).
</tp:docstring>
</tp:flag>
<tp:flag suffix="Can_Rescind" value="4">
<tp:docstring>
- The RemoveMembers method can be used on people on the remote
+ The <tp:member-ref>RemoveMembers</tp:member-ref> method can be used
+ on people on the remote
pending list.
</tp:docstring>
</tp:flag>
<tp:flag suffix="Message_Add" value="8">
<tp:docstring>
- A message may be sent to the server when calling AddMembers on
+ A message may be sent to the server when calling
+ <tp:member-ref>AddMembers</tp:member-ref> on
contacts who are not currently pending members.
</tp:docstring>
</tp:flag>
<tp:flag suffix="Message_Remove" value="16">
<tp:docstring>
- A message may be sent to the server when calling RemoveMembers on
+ A message may be sent to the server when calling
+ <tp:member-ref>RemoveMembers</tp:member-ref> on
contacts who are currently channel members.
</tp:docstring>
</tp:flag>
<tp:flag suffix="Message_Accept" value="32">
<tp:docstring>
- A message may be sent to the server when calling AddMembers on
+ A message may be sent to the server when calling
+ <tp:member-ref>AddMembers</tp:member-ref> on
contacts who are locally pending.
</tp:docstring>
</tp:flag>
<tp:flag suffix="Message_Reject" value="64">
<tp:docstring>
- A message may be sent to the server when calling RemoveMembers on
+ A message may be sent to the server when calling
+ <tp:member-ref>RemoveMembers</tp:member-ref> on
contacts who are locally pending.
</tp:docstring>
</tp:flag>
<tp:flag suffix="Message_Rescind" value="128">
<tp:docstring>
- A message may be sent to the server when calling RemoveMembers on
+ A message may be sent to the server when calling
+ <tp:member-ref>RemoveMembers</tp:member-ref> on
contacts who are remote pending.
</tp:docstring>
</tp:flag>
@@ -170,9 +179,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
The members of this group have handles which are specific to
this channel, and are not valid as general-purpose handles on
the connection. Depending on the channel, it may be possible to
- call GetHandleOwners to find the owners of these handles, which
- should be done if you wish to eg subscribe to the contact's
- presence.
+ check the <tp:member-ref>HandleOwners</tp:member-ref> property or
+ call <tp:member-ref>GetHandleOwners</tp:member-ref> to find the
+ owners of these handles, which should be done if you wish to (e.g.)
+ subscribe to the contact's presence.
</p>
<p>
@@ -194,12 +204,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring>
In rooms with channel specific handles (ie Channel_Specific_Handles
flag is set), this flag indicates that no handle owners are
- available, apart from the owner of the SelfHandle.
+ available, apart from the owner of the
+ <tp:member-ref>SelfHandle</tp:member-ref>.
<tp:rationale>
This used to be an important optimization to avoid repeated
- GetHandleOwners calls, before we introduced the HandleOwner
- property and HandleOwnerChanged signal.
+ GetHandleOwners calls, before we introduced the
+ <tp:member-ref>HandleOwners</tp:member-ref> property and
+ <tp:member-ref>HandleOwnersChanged</tp:member-ref> signal.
</tp:rationale>
</tp:docstring>
</tp:flag>
@@ -217,7 +229,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
An integer representing the bitwise-OR of flags on this
channel. The user interface can use this to present information about
which operations are currently valid. Change notification is via
- the GroupFlagsChanged signal.
+ the <tp:member-ref>GroupFlagsChanged</tp:member-ref> signal.
</tp:docstring>
<tp:added version="0.17.6">For backwards compatibility,
clients should fall back to calling GetGroupFlags if
@@ -231,7 +243,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
</arg>
<tp:docstring>
- Returns the value of the GroupFlags property.
+ Returns the value of the <tp:member-ref>GroupFlags</tp:member-ref> property.
</tp:docstring>
<tp:deprecated version="0.17.6">Use GetAll on the D-Bus
Properties D-Bus interface to get properties including GroupFlags
@@ -273,7 +285,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
the keys of this mapping is not channel-specific in this channel.
Handles which are channel-specific, but for which the owner is
unknown, MUST appear in this mapping with 0 as owner. Change
- notification is via the HandleOwnersChanged signal.
+ notification is via the
+ <tp:member-ref>HandleOwnersChanged</tp:member-ref> signal.
</tp:docstring>
<tp:added version="0.17.6"/>
</property>
@@ -281,7 +294,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<signal name="HandleOwnersChanged"
tp:name-for-bindings="Handle_Owners_Changed">
<tp:docstring>
- Emitted whenever the HandleOwners property changes.
+ Emitted whenever the <tp:member-ref>HandleOwners</tp:member-ref>
+ property changes.
</tp:docstring>
<tp:added version="0.17.6">This signal should not be relied on
unless Channel_Group_Flag_Properties is present.</tp:added>
@@ -298,7 +312,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring>
The channel-specific handles that were removed from the keys of the
HandleOwners property, as a result of the contact leaving this group
- in a previous MembersChanged signal
+ in a previous <tp:member-ref>MembersChanged</tp:member-ref> signal
</tp:docstring>
</arg>
</signal>
@@ -351,7 +365,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<arg direction="out" type="au" tp:type="Contact_Handle[]"/>
<tp:docstring>
Returns the To_Be_Added handle (only) for each structure in the
- LocalPendingMembers property.
+ <tp:member-ref>LocalPendingMembers</tp:member-ref> property.
</tp:docstring>
<tp:deprecated version="0.17.6">Use the LocalPendingMembers
property, if Channel_Group_Flag_Properties is present.</tp:deprecated>
@@ -365,7 +379,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
tp:name-for-bindings="Get_Local_Pending_Members_With_Info">
<tp:added version="0.15.0" />
<tp:docstring>
- Returns the LocalPendingMembers property.
+ Returns the <tp:member-ref>LocalPendingMembers</tp:member-ref> property.
</tp:docstring>
<tp:deprecated version="0.17.6">Use the LocalPendingMembers
property, if Channel_Group_Flag_Properties is present.</tp:deprecated>
@@ -382,7 +396,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</li>
<li>
The reason for the request: one of the values of
- ChannelGroupChangeReason
+ <tp:type>Channel_Group_Change_Reason</tp:type>
</li>
<li>
A string message containing the reason for the request if any (or
@@ -403,7 +417,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring>
An array of structs containing handles representing contacts
requesting channel membership and awaiting local approval with
- AddMembers.
+ <tp:member-ref>AddMembers</tp:member-ref>.
</tp:docstring>
<tp:added version="0.17.6">If Channel_Group_Flag_Properties is
not present, clients should fall back to using the
@@ -423,7 +437,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetMembers" tp:name-for-bindings="Get_Members">
<arg direction="out" type="au" tp:type="Contact_Handle[]"/>
<tp:docstring>
- Returns the Members property.
+ Returns the <tp:member-ref>Members</tp:member-ref> property.
</tp:docstring>
<tp:deprecated version="0.17.6">Use the Members
property, if Channel_Group_Flag_Properties is present.</tp:deprecated>
@@ -450,7 +464,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
Returns an array of handles representing contacts who have been
invited to the channel and are awaiting remote approval.
</tp:docstring>
- <tp:deprecated version="0.17.6">Use the RemotePendingMembers
+ <tp:deprecated version="0.17.6">Use the
+ <tp:member-ref>RemotePendingMembers</tp:member-ref>
property, if Channel_Group_Flag_Properties is present.</tp:deprecated>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
@@ -460,7 +475,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<signal name="SelfHandleChanged" tp:name-for-bindings="Self_Handle_Changed">
<tp:docstring>
- Emitted whenever the SelfHandle property changes.
+ Emitted whenever the <tp:member-ref>SelfHandle</tp:member-ref> property
+ changes.
</tp:docstring>
<tp:added version="0.17.6">This signal should not be relied on
unless Channel_Group_Flag_Properties is present.</tp:added>
@@ -477,9 +493,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring>
The handle for the user on this channel (which can also be a
local or remote pending member), or 0 if the user is not a member at
- all (which is likely to be the case, for instance, on ContactList
- channels). Note that this is different from the connection
- GetSelfHandle on some protocols, so the value of this handle should
+ all (which is likely to be the case, for instance, on <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Channel.Type">ContactList</tp:dbus-ref>
+ channels). Note that this is different from the result of
+ <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy">Connection.GetSelfHandle</tp:dbus-ref>
+ on some protocols, so the value of this handle should
always be used with the methods of this interface.
</tp:docstring>
<tp:added version="0.17.6">For backwards compatibility,
@@ -490,7 +509,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetSelfHandle" tp:name-for-bindings="Get_Self_Handle">
<arg direction="out" type="u" tp:type="Contact_Handle"/>
<tp:docstring>
- Returns the value of the SelfHandle property.
+ Returns the value of the <tp:member-ref>SelfHandle</tp:member-ref>
+ property.
</tp:docstring>
<tp:deprecated version="0.17.6">Clients should retrieve the
SelfHandle property using GetAll instead,
@@ -513,7 +533,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
</arg>
<tp:docstring>
- Emitted when the flags as returned by GetGroupFlags are changed.
+ Emitted when the flags as returned by
+ <tp:member-ref>GetGroupFlags</tp:member-ref> are changed.
The user interface should be updated as appropriate.
</tp:docstring>
</signal>
@@ -569,9 +590,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:docstring>
The change is because a contact's unique identifier changed.
There must be exactly one handle in the removed set and exactly
- one handle in one of the added sets. The Renamed signal on the
- Renaming interface will have been emitted for the same handles,
- shortly before this MembersChanged signal is emitted.
+ one handle in one of the added sets. The <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Connection.Interface.Renaming">Renamed</tp:dbus-ref>
+ signal on the
+ <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Connection.Interface">Renaming</tp:dbus-ref>
+ interface will have been emitted for the same handles,
+ shortly before this <tp:member-ref>MembersChanged</tp:member-ref> signal is emitted.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Permission_Denied" value="10">
@@ -590,7 +615,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<p>
If members are added with this reason code, the change is because
unconnected parts of the group have rejoined. If this channel
- carries messages (e.g. Text or Tubes channels) applications must
+ carries messages (e.g. <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Channel.Type">Text</tp:dbus-ref>
+ or <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy.Channel.Type">Tubes</tp:dbus-ref>
+ channels) applications must
assume that the contacts being added are likely to have missed some
messages as a result of the separation, and that the contacts
in the group are likely to have missed some messages from the
@@ -640,8 +669,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</arg>
<arg name="Reason" type="u" tp:type="Channel_Group_Change_Reason">
<tp:docstring>
- A reason for the change: one of the values of
- ChannelGroupChangeReason
+ A reason for the change
</tp:docstring>
</arg>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
@@ -651,8 +679,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
which may be displayed to the user if desired.</p>
<p>All channel-specific handles that are mentioned in this signal
- MUST be represented in the value of the HandleOwners property.
- In practice, this will mean that HandleOwnersChanged is
+ MUST be represented in the value of the
+ <tp:member-ref>HandleOwners</tp:member-ref> property.
+ In practice, this will mean that
+ <tp:member-ref>HandleOwnersChanged</tp:member-ref> is
emitted <em>before</em> emitting a MembersChanged signal in which
channel-specific handles are added, but that it is emitted
<em>after</em> emitting a MembersChanged signal in which
@@ -678,7 +708,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
with the request, which will be sent to the server if supported. See
the CHANNEL_GROUP_FLAG_MESSAGE_REMOVE,
CHANNEL_GROUP_FLAG_MESSAGE_REJECT and
- CHANNEL_GROUP_FLAG_MESSAGE_RESCIND flags to see in which cases this
+ CHANNEL_GROUP_FLAG_MESSAGE_RESCIND
+ <tp:member-ref>GroupFlags</tp:member-ref> to see in which cases this
message should be provided.
</tp:docstring>
<tp:possible-errors>
@@ -705,12 +736,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<arg direction="in" name="Reason" type="u"
tp:type="Channel_Group_Change_Reason">
<tp:docstring>
- A reason for the change: one of the values of
- ChannelGroupChangeReason
+ A reason for the change
</tp:docstring>
</arg>
<tp:docstring>
- As RemoveMembers, but a reason code may be provided where
+ As <tp:member-ref>RemoveMembers</tp:member-ref>, but a reason code may
+ be provided where
appropriate. The reason code may be ignored if the underlying
protocol is unable to represent the given reason.
</tp:docstring>
@@ -734,17 +765,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
cannot be presumed by the channel's existence (for example, a channel you
may request membership of but your request may not be granted).</p>
- <p>This interface implements three lists: a list of current members, and two
- lists of local pending and remote pending members. Contacts on the remote
+ <p>This interface implements three lists: a list of current members
+ (<tp:member-ref>Members</tp:member-ref>), and two lists of local pending
+ and remote pending members
+ (<tp:member-ref>LocalPendingMembers</tp:member-ref> and
+ <tp:member-ref>RemotePendingMembers</tp:member-ref>, respectively).
+ Contacts on the remote
pending list have been invited to the channel, but the remote user has not
accepted the invitation. Contacts on the local pending list have requested
membership of the channel, but the local user of the framework must accept
their request before they may join. A single contact should never appear on
more than one of the three lists. The lists are empty when the channel is
- created, and the MembersChanged signal should be emitted when information
+ created, and the <tp:member-ref>MembersChanged</tp:member-ref> signal
+ should be emitted when information
is retrieved from the server, or changes occur.</p>
- <p>Addition of members to the channel may be requested by using AddMembers. If
+ <p>Addition of members to the channel may be requested by using
+ <tp:member-ref>AddMembers</tp:member-ref>. If
remote acknowledgement is required, use of the AddMembers method will cause
users to appear on the remote pending list. If no acknowledgement is
required, AddMembers will add contacts to the member list directly. If a
@@ -752,7 +789,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
will grant their membership request.</p>
<p>Removal of contacts from the channel may be requested by using
- RemoveMembers. If a contact is awaiting authorisation on the local pending
+ <tp:member-ref>RemoveMembers</tp:member-ref>. If a contact is awaiting
+ authorisation on the local pending
list, RemoveMembers will refuse their membership request. If a contact is
on the remote pending list but has not yet accepted the invitation,
RemoveMembers will rescind the request if possible.</p>
--
1.5.6.5
More information about the Telepathy-commits
mailing list