diff options
author | Robert McQueen <robert.mcqueen@collabora.co.uk> | 2007-05-31 14:21:19 +0000 |
---|---|---|
committer | Robert McQueen <robert.mcqueen@collabora.co.uk> | 2007-05-31 14:21:19 +0000 |
commit | b7853bd24e63d2fe099d336f1982fbc61745a68a (patch) | |
tree | cee00979eaae193d76356ee3bdbd49912e3f8b53 | |
parent | 78a30fce0e7706d2f815e157ec86517adeda9283 (diff) |
update spec to 0.15.4
23 files changed, 173 insertions, 117 deletions
diff --git a/spec/Channel.xml b/spec/Channel.xml index 7bccf27ea..524382416 100644 --- a/spec/Channel.xml +++ b/spec/Channel.xml @@ -52,7 +52,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="GetChannelType"> - <arg direction="out" type="s"> + <arg direction="out" type="s" tp:type="Interface"> <tp:docstring>The interface name</tp:docstring> </arg> <tp:docstring> @@ -60,13 +60,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </method> <method name="GetHandle"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Handle_Type"> <tp:docstring> The handle type, or zero if this channel does not correspond to any particular handle </tp:docstring> </arg> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Handle"> <tp:docstring> The handle, or zero if this channel does not correspond to any particular handle @@ -79,7 +79,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </method> <method name="GetInterfaces"> - <arg direction="out" type="as"> + <arg direction="out" type="as" tp:type="Interface[]"> <tp:docstring> An array of the D-Bus interface names </tp:docstring> diff --git a/spec/Channel_Interface_Chat_State.xml b/spec/Channel_Interface_Chat_State.xml index 6bd5529a7..e8b129e46 100644 --- a/spec/Channel_Interface_Chat_State.xml +++ b/spec/Channel_Interface_Chat_State.xml @@ -19,7 +19,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Channel.Interface.ChatState"> <tp:requires interface="org.freedesktop.Telepathy.Channel"/> <method name="SetChatState"> - <arg direction="in" name="state" type="u"> + <arg direction="in" name="state" type="u" tp:type="Channel_Chat_State"> <tp:docstring> The new state: one of the values of ChannelChatState. </tp:docstring> @@ -35,12 +35,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <signal name="ChatStateChanged"> - <arg name="contact" type="u"> + <arg name="contact" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer handle for the contact. </tp:docstring> </arg> - <arg name="state" type="u"> + <arg name="state" type="u" tp:type="Channel_Chat_State"> <tp:docstring> The new state of this contact: one of the values of ChannelChatState. </tp:docstring> @@ -86,9 +86,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <p>The Channel_Chat_State_Gone state is treated differently to other states:</p> <ul> - <li>It is not used for multi-user chats</li> - <li>It is implictly set when the channel is closed</li> - <li>It may not be explicitly set</li> + <li>It may not be used for multi-user chats</li> + <li>It may not be explicitly sent</li> + <li>It should be automatically sent when the channel is closed</li> + <li>It must not be sent to the peer if a channel is closed without being used</li> + <li>Receiving it must not cause a new channel to be opened</li> </ul> <p>The different states are defined by XEP-0085, but may be applied to any suitable protocol.</p> diff --git a/spec/Channel_Interface_DTMF.xml b/spec/Channel_Interface_DTMF.xml index d60d34730..2763b6ecc 100644 --- a/spec/Channel_Interface_DTMF.xml +++ b/spec/Channel_Interface_DTMF.xml @@ -24,7 +24,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <arg direction="in" name="stream_id" type="u"> <tp:docstring>A stream ID as defined in the StreamedMedia channel type.</tp:docstring> </arg> - <arg direction="in" name="event" type="y"> + <arg direction="in" name="event" type="y" tp:type="DTMF_Event"> <tp:docstring>A numeric event code from the DTMF_Event enum.</tp:docstring> </arg> <tp:docstring> diff --git a/spec/Channel_Interface_Group.xml b/spec/Channel_Interface_Group.xml index 21cdbdf20..0e18241dd 100644 --- a/spec/Channel_Interface_Group.xml +++ b/spec/Channel_Interface_Group.xml @@ -21,7 +21,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Channel.Interface.Group"> <tp:requires interface="org.freedesktop.Telepathy.Channel"/> <method name="AddMembers"> - <arg direction="in" name="contacts" type="au"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of contact handles to invite to the channel </tp:docstring> @@ -52,17 +52,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetAllMembers"> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Contact_Handle[]"> <tp:docstring> array of handles of current members </tp:docstring> </arg> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Contact_Handle[]"> <tp:docstring> array of handles of local pending members </tp:docstring> </arg> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Contact_Handle[]"> <tp:docstring> array of handles of remote pending members </tp:docstring> @@ -151,9 +151,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ this flag). </tp:docstring> </tp:flag> + <tp:flag suffix="Handle_Owners_Not_Available" value="1024"> + <tp:docstring> + In rooms with channel specific handles (ie Channel_Specific_Handles + flag is set), this flag indicates that none of the handle owners are + available, and that GetHandleOwners method will always return 0 for + channel members other than the self handle. + </tp:docstring> + </tp:flag> </tp:flags> <method name="GetGroupFlags"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Channel_Group_Flags"> <tp:docstring> The bitwise OR of zero or more values from ChannelGroupFlags </tp:docstring> @@ -169,12 +177,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetHandleOwners"> - <arg direction="in" name="handles" type="au"> + <arg direction="in" name="handles" type="au" tp:type="Contact_Handle[]"> <tp:docstring> A list of integer handles representing members of the channel </tp:docstring> </arg> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of integer handles representing the owner handles of the given room members, in the same order, or 0 if the @@ -208,7 +216,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetLocalPendingMembers"> - <arg direction="out" type="au"/> + <arg direction="out" type="au" tp:type="Contact_Handle[]"/> <tp:docstring> Returns an array of handles representing contacts requesting channel membership and awaiting local approval with AddMembers. @@ -223,7 +231,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <tp:docstring> Returns an array of structs containing handles representing contacts requesting channel membership and awaiting local approval with - AddMembers. + AddMembers. </tp:docstring> <arg direction="out" type="a(uuus)"> <tp:docstring> @@ -240,7 +248,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The reason for the request: one of the values of ChannelGroupChangeReason </li> - <li> + <li> A string message containing the reason for the request if any (or blank if none) </li> @@ -253,7 +261,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetMembers"> - <arg direction="out" type="au"/> + <arg direction="out" type="au" tp:type="Contact_Handle[]"/> <tp:docstring> Returns an array of handles for the members of this channel. </tp:docstring> @@ -263,7 +271,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetRemotePendingMembers"> - <arg direction="out" type="au"/> + <arg direction="out" type="au" tp:type="Contact_Handle[]"/> <tp:docstring> Returns an array of handles representing contacts who have been invited to the channel and are awaiting remote approval. @@ -274,7 +282,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetSelfHandle"> - <arg direction="out" type="u"/> + <arg direction="out" type="u" tp:type="Contact_Handle"/> <tp:docstring> Returns the handle for the user on this channel (which can also be a local or remote pending member) or 0 if the user not a member at all @@ -289,12 +297,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <signal name="GroupFlagsChanged"> - <arg name="added" type="u"> + <arg name="added" type="u" tp:type="Channel_Group_Flags"> <tp:docstring> A bitwise OR of the flags which have been set </tp:docstring> </arg> - <arg name="removed" type="u"> + <arg name="removed" type="u" tp:type="Channel_Group_Flags"> <tp:docstring> A bitwise OR of the flags which have been cleared </tp:docstring> @@ -359,6 +367,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ shortly before this MembersChanged signal is emitted. </tp:docstring> </tp:enumvalue> + <tp:enumvalue suffix="Permission_Denied" value="10"> + <tp:docstring> + The change is because there was no permission to contact the + requested handle. + </tp:docstring> + </tp:enumvalue> </tp:enum> <signal name="MembersChanged"> <arg name="message" type="s"> @@ -366,33 +380,33 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ A string message from the server, or blank if not </tp:docstring> </arg> - <arg name="added" type="au"> + <arg name="added" type="au" tp:type="Contact_Handle[]"> <tp:docstring> A list of members added to the channel </tp:docstring> </arg> - <arg name="removed" type="au"> + <arg name="removed" type="au" tp:type="Contact_Handle[]"> <tp:docstring> A list of members removed from the channel </tp:docstring> </arg> - <arg name="local_pending" type="au"> + <arg name="local_pending" type="au" tp:type="Contact_Handle[]"> <tp:docstring> A list of members who are pending local approval </tp:docstring> </arg> - <arg name="remote_pending" type="au"> + <arg name="remote_pending" type="au" tp:type="Contact_Handle[]"> <tp:docstring> A list of members who are pending remote approval </tp:docstring> </arg> - <arg name="actor" type="u"> + <arg name="actor" type="u" tp:type="Contact_Handle"> <tp:docstring> The contact handle of the person who made the change, or 0 if not known </tp:docstring> </arg> - <arg name="reason" type="u"> + <arg name="reason" type="u" tp:type="Channel_Group_Change_Reason"> <tp:docstring> A reason for the change: one of the values of ChannelGroupChangeReason @@ -407,7 +421,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="RemoveMembers"> - <arg direction="in" name="contacts" type="au"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of contact handles to remove from the channel </tp:docstring> @@ -435,6 +449,42 @@ 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="RemoveMembersWithReason"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> + <tp:docstring> + An array of contact handles to remove from the channel + </tp:docstring> + </arg> + <arg direction="in" name="message" type="s"> + <tp:docstring> + A string message, which can be blank if desired + </tp:docstring> + </arg> + <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 + </tp:docstring> + </arg> + <tp:docstring> + As RemoveMembers, 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> + <tp:possible-errors> + <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/> + <tp:error name="org.freedesktop.Telepathy.Error.NetworkError"/> + <tp:error name="org.freedesktop.Telepathy.Error.NotAvailable"/> + <tp:error name="org.freedesktop.Telepathy.Error.PermissionDenied"/> + <tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/> + <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"> + <tp:docstring> + The provided reason code was invalid. + </tp:docstring> + </tp:error> + </tp:possible-errors> + </method> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Interface for channels which have multiple members, and where the members of the channel can change during its lifetime. Your presence in the channel diff --git a/spec/Channel_Interface_Hold.xml b/spec/Channel_Interface_Hold.xml index c7616476e..24437782b 100644 --- a/spec/Channel_Interface_Hold.xml +++ b/spec/Channel_Interface_Hold.xml @@ -47,12 +47,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. <interface name="org.freedesktop.Telepathy.Channel.Interface.Hold"> <tp:requires interface="org.freedesktop.Telepathy.Channel"/> <method name="GetHoldState"> - <arg direction="in" name="member" type="u"> + <arg direction="in" name="member" type="u" tp:type="Contact_Handle"> <tp:docstring> The contact handle for a member of the channel </tp:docstring> </arg> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Channel_Hold_State"> <tp:docstring> The member's current hold state as one of the values of ChannelHoldState @@ -67,12 +67,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:possible-errors> </method> <signal name="HoldStateChanged"> - <arg name="member" type="u"> + <arg name="member" type="u" tp:type="Contact_Handle"> <tp:docstring> The integer handle of a member of the channel </tp:docstring> </arg> - <arg name="state" type="u"> + <arg name="state" type="u" tp:type="Channel_Hold_State"> <tp:docstring> An integer representing the new hold state </tp:docstring> @@ -86,7 +86,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:docstring> </signal> <method name="RequestHold"> - <arg direction="in" name="member" type="u"> + <arg direction="in" name="member" type="u" tp:type="Contact_Handle"> <tp:docstring> The contact handle for a member of the channel </tp:docstring> diff --git a/spec/Channel_Interface_Password.xml b/spec/Channel_Interface_Password.xml index 20aa55e13..4e4135fbf 100644 --- a/spec/Channel_Interface_Password.xml +++ b/spec/Channel_Interface_Password.xml @@ -31,7 +31,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:flag> </tp:flags> <method name="GetPasswordFlags"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Channel_Password_Flags"> <tp:docstring> An integer with the logical OR of all the flags set (values of ChannelPasswordFlags) @@ -48,12 +48,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:possible-errors> </method> <signal name="PasswordFlagsChanged"> - <arg name="added" type="u"> + <arg name="added" type="u" tp:type="Channel_Password_Flags"> <tp:docstring> A bitwise OR of the flags which have been set </tp:docstring> </arg> - <arg name="removed" type="u"> + <arg name="removed" type="u" tp:type="Channel_Password_Flags"> <tp:docstring> A bitwise OR of the flags which have been cleared </tp:docstring> diff --git a/spec/Channel_Interface_Transfer.xml b/spec/Channel_Interface_Transfer.xml index b32612b49..4089f7757 100644 --- a/spec/Channel_Interface_Transfer.xml +++ b/spec/Channel_Interface_Transfer.xml @@ -21,12 +21,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Channel.Interface.Transfer"> <tp:requires interface="org.freedesktop.Telepathy.Channel"/> <method name="Transfer"> - <arg direction="in" name="member" type="u"> + <arg direction="in" name="member" type="u" tp:type="Contact_Handle"> <tp:docstring> The handle of the member to transfer </tp:docstring> </arg> - <arg direction="in" name="destination" type="u"> + <arg direction="in" name="destination" type="u" tp:type="Contact_Handle"> <tp:docstring> The handle of the destination contact </tp:docstring> diff --git a/spec/Channel_Type_Contact_Search.xml b/spec/Channel_Type_Contact_Search.xml index 36b552029..b84f3c768 100644 --- a/spec/Channel_Type_Contact_Search.xml +++ b/spec/Channel_Type_Contact_Search.xml @@ -65,7 +65,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:enumvalue> </tp:enum> <method name="GetSearchState"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Channel_Contact_Search_State"> <tp:docstring>The search state represented as one of the values of ChannelContactSearchState</tp:docstring> </arg> @@ -91,7 +91,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <signal name="SearchResultReceived"> - <arg name="contact" type="u"> + <arg name="contact" type="u" tp:type="Contact_Handle"> <tp:docstring>An integer handle for the contact</tp:docstring> </arg> <arg name="values" type="a{sv}"> @@ -102,7 +102,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <signal name="SearchStateChanged"> - <arg name="state" type="u"> + <arg name="state" type="u" tp:type="Channel_Contact_Search_State"> <tp:docstring>An integer representing the new search state</tp:docstring> </arg> <tp:docstring> diff --git a/spec/Channel_Type_Room_List.xml b/spec/Channel_Type_Room_List.xml index 464994864..fddbc3e4f 100644 --- a/spec/Channel_Type_Room_List.xml +++ b/spec/Channel_Type_Room_List.xml @@ -51,8 +51,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ recommended for use where appropriate:</p> <dl> - <dt>s:name</dt><dd>The name of the room if different from the handle</dd> - <dt>s:subject</dt><dd>The subject of the room</dd> + <dt>s:handle-name</dt><dd>The string name of the room handle (as would be returned by InspectHandles)</dd> + <dt>s:name</dt><dd>The human-readable name of the room if different from the handle</dd> + <dt>s:description</dt><dd>A description of the room's overall purpose</dd> + <dt>s:subject</dt><dd>The current subject of conversation in the room</dd> <dt>u:members</dt><dd>The number of members of the room</dd> <dt>b:password</dt><dd>True if the room requires a password to enter</dd> <dt>b:invite-only</dt><dd>True if you cannot join the room, but must be invited</dd> diff --git a/spec/Channel_Type_Streamed_Media.xml b/spec/Channel_Type_Streamed_Media.xml index b51f90c70..8cfe07154 100644 --- a/spec/Channel_Type_Streamed_Media.xml +++ b/spec/Channel_Type_Streamed_Media.xml @@ -111,7 +111,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The stream identifier (as defined in ListStreams) </tp:docstring> </arg> - <arg direction="in" name="stream_direction" type="u"> + <arg direction="in" name="stream_direction" type="u" tp:type="Media_Stream_Direction"> <tp:docstring> The desired stream direction (a value of MediaStreamDirection) </tp:docstring> @@ -142,7 +142,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="RequestStreams"> - <arg direction="in" name="contact_handle" type="u"> + <arg direction="in" name="contact_handle" type="u" tp:type="Contact_Handle"> <tp:docstring> A contact handle with whom to establish the streams </tp:docstring> @@ -194,13 +194,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The stream identifier (as defined in ListStreams) </tp:docstring> </arg> - <arg name="contact_handle" type="u"> + <arg name="contact_handle" type="u" tp:type="Contact_Handle"> <tp:docstring> The contact handle who the stream is with (or 0 if it represents more than a single member) </tp:docstring> </arg> - <arg name="stream_type" type="u"> + <arg name="stream_type" type="u" tp:type="Media_Stream_Type"> <tp:docstring> The stream type (a value from MediaStreamType) </tp:docstring> @@ -215,12 +215,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The stream identifier (as defined in ListStreams) </tp:docstring> </arg> - <arg name="stream_direction" type="u"> + <arg name="stream_direction" type="u" tp:type="Media_Stream_Direction"> <tp:docstring> The new stream direction (as defined in ListStreams) </tp:docstring> </arg> - <arg name="pending_flags" type="u"> + <arg name="pending_flags" type="u" tp:type="Media_Stream_Pending_Send"> <tp:docstring> The new pending send flags (as defined in ListStreams) </tp:docstring> @@ -268,7 +268,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The stream identifier (as defined in ListStreams) </tp:docstring> </arg> - <arg name="stream_state" type="u"> + <arg name="stream_state" type="u" tp:type="Media_Stream_State"> <tp:docstring> The new stream state (as defined in ListStreams) </tp:docstring> diff --git a/spec/Channel_Type_Text.xml b/spec/Channel_Type_Text.xml index ac42e8f07..9cb037604 100644 --- a/spec/Channel_Type_Text.xml +++ b/spec/Channel_Type_Text.xml @@ -37,7 +37,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetMessageTypes"> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Channel_Text_Message_Type[]"> <tp:docstring> An array of integer message types (ChannelTextMessageType) </tp:docstring> @@ -84,23 +84,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ A numeric identifier for acknowledging the message </tp:docstring> </arg> - <arg name="timestamp" type="u"> + <arg name="timestamp" type="u" tp:type="Timestamp"> <tp:docstring> A Unix timestamp indicating when the message was received </tp:docstring> </arg> - <arg name="sender" type="u"> + <arg name="sender" type="u" tp:type="Contact_Handle"> <tp:docstring> The handle of the contact who sent the message </tp:docstring> </arg> - <arg name="type" type="u"> + <arg name="type" type="u" tp:type="Channel_Text_Message_Type"> <tp:docstring> The type of the message (normal, action, notice, etc), from ChannelTextMessageType </tp:docstring> </arg> - <arg name="flags" type="u"> + <arg name="flags" type="u" tp:type="Channel_Text_Message_Flags"> <tp:docstring> A bitwise OR of the message flags as defined by ChannelTextMessageFlags </tp:docstring> @@ -119,7 +119,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="Send"> - <arg direction="in" name="type" type="u"> + <arg direction="in" name="type" type="u" tp:type="Channel_Text_Message_Type"> <tp:docstring> An integer indicating the type of the message, from ChannelTextMessageType @@ -180,12 +180,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ One of the values of ChannelTextSendError </tp:docstring> </arg> - <arg name="timestamp" type="u"> + <arg name="timestamp" type="u" tp:type="Timestamp"> <tp:docstring> The Unix timestamp indicating when the message was sent </tp:docstring> </arg> - <arg name="type" type="u"> + <arg name="type" type="u" tp:type="Channel_Text_Message_Type"> <tp:docstring> The message type from ChannelTextMessageType </tp:docstring> @@ -201,12 +201,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <signal name="Sent"> - <arg name="timestamp" type="u"> + <arg name="timestamp" type="u" tp:type="Timestamp"> <tp:docstring> Unix timestamp indicating when the message was sent </tp:docstring> </arg> - <arg name="type" type="u"> + <arg name="type" type="u" tp:type="Channel_Text_Message_Type"> <tp:docstring> The message type (normal, action, notice, etc) from ChannelTextMessageType @@ -316,12 +316,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ the channel, similar to /topic in IRC. </tp:docstring> </tp:property> - <tp:property name="subject-contact" type="u"> + <tp:property name="subject-contact" type="u" tp:type="Contact_Handle"> <tp:docstring> A contact handle representing who last modified the subject. </tp:docstring> </tp:property> - <tp:property name="subject-timestamp" type="u"> + <tp:property name="subject-timestamp" type="u" tp:type="Timestamp"> <tp:docstring> A unix timestamp indicating when the subject was last modified. </tp:docstring> diff --git a/spec/Channel_Type_Tubes.xml b/spec/Channel_Type_Tubes.xml index 72b962a0e..6521bfff0 100644 --- a/spec/Channel_Type_Tubes.xml +++ b/spec/Channel_Type_Tubes.xml @@ -72,7 +72,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:enum> <method name="GetAvailableTubeTypes"> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Tube_Type[]"> <tp:docstring> An array of the available tube types, as defined by the Tube_Type enum. @@ -103,7 +103,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Offers a tube providing the service specified, over a tube of the specified type. </tp:docstring> - <arg direction="in" name="type" type="u"> + <arg direction="in" name="type" type="u" tp:type="Tube_Type"> <tp:docstring> The type of tube wanted, one of the values from the Tube_Type enum. @@ -135,12 +135,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. The ID of the new tube. </tp:docstring> </arg> - <arg name="initiator" type="u"> + <arg name="initiator" type="u" tp:type="Contact_Handle"> <tp:docstring> The handle of the contact who initiated the tube. </tp:docstring> </arg> - <arg name="type" type="u"> + <arg name="type" type="u" tp:type="Tube_Type"> <tp:docstring> The tube type, as defined by the Tube_Type enum. </tp:docstring> @@ -155,7 +155,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. The new tube's properties. </tp:docstring> </arg> - <arg name="state" type="u"> + <arg name="state" type="u" tp:type="Tube_State"> <tp:docstring> The new tube's state. </tp:docstring> @@ -164,8 +164,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. <method name="AcceptTube"> <tp:docstring> - Accept a tube that's in the "local pending" state. The tube becomes - open after this method is called. + Accept a tube that's in the "local pending" state. The connection + manager will attempt to open the tube. The tube remains in the + "local pending" state until the TubeStateChanged signal is emitted. </tp:docstring> <arg direction="in" name="id" type="u"> <tp:docstring> @@ -183,7 +184,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. The ID of the tube that changed state. </tp:docstring> </arg> - <arg name="state" type="u"> + <arg name="state" type="u" tp:type="Tube_State"> <tp:docstring> The new state of the tube; see the Tube_State enumeration. </tp:docstring> @@ -278,7 +279,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Array of handles and D-Bus names of new participants. </tp:docstring> </arg> - <arg name="removed" type="au"> + <arg name="removed" type="au" tp:type="Contact_Handle[]"> <tp:docstring> Array of handles of former participants. </tp:docstring> diff --git a/spec/Connection.xml b/spec/Connection.xml index 849875382..fb0856596 100644 --- a/spec/Connection.xml +++ b/spec/Connection.xml @@ -41,7 +41,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </method> <method name="GetInterfaces"> - <arg direction="out" type="as"> + <arg direction="out" type="as" tp:type="Interface[]"> <tp:docstring> An array of D-Bus interface names </tp:docstring> @@ -80,7 +80,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetStatus"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Connection_Status"> <tp:docstring> An integer representing the current status </tp:docstring> @@ -90,12 +90,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </method> <method name="HoldHandles"> - <arg direction="in" name="handle_type" type="u"> + <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> An integer handle type (as defined in HandleType) </tp:docstring> </arg> - <arg direction="in" name="handles" type="au"> + <arg direction="in" name="handles" type="au" tp:type="Handle[]"> <tp:docstring> A array of integer handles to hold </tp:docstring> @@ -128,12 +128,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="InspectHandles"> - <arg direction="in" name="handle_type" type="u"> + <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> An integer handle type (as defined in HandleType) </tp:docstring> </arg> - <arg direction="in" name="handles" type="au"> + <arg direction="in" name="handles" type="au" tp:type="Handle[]"> <tp:docstring> An array of integer handles of this type </tp:docstring> @@ -182,17 +182,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ A D-Bus object path for the channel object on this service </tp:docstring> </arg> - <arg name="channel_type" type="s"> + <arg name="channel_type" type="s" tp:type="Interface"> <tp:docstring> A D-Bus interface name representing the channel type </tp:docstring> </arg> - <arg name="handle_type" type="u"> + <arg name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> An integer representing the type of handle this channel communicates with, which is zero if no handle is specified </tp:docstring> </arg> - <arg name="handle" type="u"> + <arg name="handle" type="u" tp:type="Handle"> <tp:docstring> A handle indicating the specific contact, room or list this channel communicates with, or zero if it is an anonymous channel </tp:docstring> @@ -210,12 +210,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="ReleaseHandles"> - <arg direction="in" name="handle_type" type="u"> + <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> An integer handle type (as defined in RequestHandle) </tp:docstring> </arg> - <arg direction="in" name="handles" type="au"> + <arg direction="in" name="handles" type="au" tp:type="Handle[]"> <tp:docstring> An array of integer handles being held by the client </tp:docstring> @@ -240,17 +240,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="RequestChannel"> - <arg direction="in" name="type" type="s"> + <arg direction="in" name="type" type="s" tp:type="Interface"> <tp:docstring> A D-Bus interface name representing base channel type </tp:docstring> </arg> - <arg direction="in" name="handle_type" type="u"> + <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> An integer representing the handle type, or zero if no handle is being specified </tp:docstring> </arg> - <arg direction="in" name="handle" type="u"> + <arg direction="in" name="handle" type="u" tp:type="Handle"> <tp:docstring> A nonzero integer handle representing a contact, room, list etc. according to handle_type, or zero if the handle_type is zero @@ -350,7 +350,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:enumvalue> </tp:enum> <method name="RequestHandles"> - <arg direction="in" name="handle_type" type="u"> + <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> An integer handle type (as defined in HandleType) </tp:docstring> @@ -360,7 +360,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ An array of names of entities to request handles for </tp:docstring> </arg> - <arg direction="out" type="au"> + <arg direction="out" type="au" tp:type="Handle[]"> <tp:docstring> An array of integer handle numbers in the same order as the given strings </tp:docstring> @@ -482,12 +482,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:enumvalue> </tp:enum> <signal name="StatusChanged"> - <arg name="status" type="u"> + <arg name="status" type="u" tp:type="Connection_Status"> <tp:docstring> An integer indicating the new status, as defined by ConnectionStatus </tp:docstring> </arg> - <arg name="reason" type="u"> + <arg name="reason" type="u" tp:type="Connection_Status_Reason"> <tp:docstring> An integer indicating the reason for the status change, as defined by ConnectionStatusReason diff --git a/spec/Connection_Interface_Aliasing.xml b/spec/Connection_Interface_Aliasing.xml index 60a82d18e..6aa79d152 100644 --- a/spec/Connection_Interface_Aliasing.xml +++ b/spec/Connection_Interface_Aliasing.xml @@ -53,7 +53,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:flag> </tp:flags> <method name="GetAliasFlags"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Connection_Alias_Flags"> <tp:docstring> An integer with a bitwise OR of flags from ConnectionAliasFlags </tp:docstring> @@ -67,7 +67,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="RequestAliases"> - <arg direction="in" name="contacts" type="au"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of handles representing contacts </tp:docstring> diff --git a/spec/Connection_Interface_Avatars.xml b/spec/Connection_Interface_Avatars.xml index 9c467b082..bf36793c1 100644 --- a/spec/Connection_Interface_Avatars.xml +++ b/spec/Connection_Interface_Avatars.xml @@ -21,7 +21,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Connection.Interface.Avatars"> <tp:requires interface="org.freedesktop.Telepathy.Connection"/> <signal name="AvatarUpdated"> - <arg name="contact" type="u"> + <arg name="contact" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer handle for the contact whose avatar has changed </tp:docstring> @@ -106,7 +106,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetAvatarTokens"> - <arg direction="in" name="contacts" type="au"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of handles representing contacts </tp:docstring> @@ -132,7 +132,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="RequestAvatar"> - <arg direction="in" name="contact" type="u"> + <arg direction="in" name="contact" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer handle for the contact to request the avatar for </tp:docstring> diff --git a/spec/Connection_Interface_Capabilities.xml b/spec/Connection_Interface_Capabilities.xml index 587983624..db370c224 100644 --- a/spec/Connection_Interface_Capabilities.xml +++ b/spec/Connection_Interface_Capabilities.xml @@ -30,7 +30,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </ul> </tp:docstring> </arg> - <arg direction="in" name="remove" type="as"> + <arg direction="in" name="remove" type="as" tp:type="Interface[]"> <tp:docstring> An array of D-Bus interface names of channel types to remove </tp:docstring> @@ -88,7 +88,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="GetCapabilities"> - <arg direction="in" name="handles" type="au"> + <arg direction="in" name="handles" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of contact handles for this connection, or zero to query capabilities available on the connection itself </tp:docstring> diff --git a/spec/Connection_Interface_Contact_Info.xml b/spec/Connection_Interface_Contact_Info.xml index cdd686d8e..2c160aa81 100644 --- a/spec/Connection_Interface_Contact_Info.xml +++ b/spec/Connection_Interface_Contact_Info.xml @@ -21,7 +21,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Connection.Interface.ContactInfo"> <tp:requires interface="org.freedesktop.Telepathy.Connection"/> <signal name="GotContactInfo"> - <arg name="contact" type="u"> + <arg name="contact" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer handle of the contact ID on the server </tp:docstring> @@ -37,7 +37,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="RequestContactInfo"> - <arg direction="in" name="contact" type="u"> + <arg direction="in" name="contact" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer handle for the contact to request info for </tp:docstring> diff --git a/spec/Connection_Interface_Forwarding.xml b/spec/Connection_Interface_Forwarding.xml index f185b0122..c36751a3d 100644 --- a/spec/Connection_Interface_Forwarding.xml +++ b/spec/Connection_Interface_Forwarding.xml @@ -21,7 +21,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Connection.Interface.Forwarding"> <tp:requires interface="org.freedesktop.Telepathy.Connection"/> <signal name="ForwardingChanged"> - <arg name="forward_to" type="u"> + <arg name="forward_to" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer contact handle to forward communication to </tp:docstring> @@ -32,7 +32,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="GetForwardingHandle"> - <arg direction="out" type="u"> + <arg direction="out" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer contact handle to whom incoming communication is forwarded </tp:docstring> @@ -47,7 +47,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="SetForwardingHandle"> - <arg direction="in" name="forward_to" type="u"> + <arg direction="in" name="forward_to" type="u" tp:type="Contact_Handle"> <tp:docstring> An integer contact handle to forward incoming communications to </tp:docstring> diff --git a/spec/Connection_Interface_Presence.xml b/spec/Connection_Interface_Presence.xml index e27a42026..9523ff8ac 100644 --- a/spec/Connection_Interface_Presence.xml +++ b/spec/Connection_Interface_Presence.xml @@ -64,7 +64,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="GetPresence"> - <arg direction="in" name="contacts" type="au"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of the contacts whose presence should be obtained </tp:docstring> @@ -149,7 +149,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="RequestPresence"> - <arg direction="in" name="contacts" type="au"> + <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]"> <tp:docstring> An array of the contacts whose presence should be obtained </tp:docstring> @@ -174,7 +174,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="SetLastActivityTime"> - <arg direction="in" name="time" type="u"> + <arg direction="in" name="time" type="u" tp:type="Timestamp"> <tp:docstring> A UNIX timestamp of the user's last activity time (in UTC) </tp:docstring> diff --git a/spec/Connection_Interface_Renaming.xml b/spec/Connection_Interface_Renaming.xml index bed7c6c98..7d944513e 100644 --- a/spec/Connection_Interface_Renaming.xml +++ b/spec/Connection_Interface_Renaming.xml @@ -21,12 +21,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <interface name="org.freedesktop.Telepathy.Connection.Interface.Renaming"> <tp:requires interface="org.freedesktop.Telepathy.Connection"/> <signal name="Renamed"> - <arg name="original" type="u"> + <arg name="original" type="u" tp:type="Contact_Handle"> <tp:docstring> The handle of the original identifier </tp:docstring> </arg> - <arg name="new" type="u"> + <arg name="new" type="u" tp:type="Contact_Handle"> <tp:docstring> The handle of the new identifier </tp:docstring> diff --git a/spec/Media_Session_Handler.xml b/spec/Media_Session_Handler.xml index 14cc01592..b90b9829e 100644 --- a/spec/Media_Session_Handler.xml +++ b/spec/Media_Session_Handler.xml @@ -42,13 +42,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ The unique ID of the new stream </tp:docstring> </arg> - <arg name="media_type" type="u"> + <arg name="media_type" type="u" tp:type="Media_Stream_Type"> <tp:docstring> Enum for type of media that this stream should handle (a value from MediaStreamType) </tp:docstring> </arg> - <arg name="direction" type="u"> + <arg name="direction" type="u" tp:type="Media_Stream_Direction"> <tp:docstring> Enum for direction of this stream (a value from MediaStreamDirection) diff --git a/spec/Media_Stream_Handler.xml b/spec/Media_Stream_Handler.xml index c33abc33a..d0f59505e 100644 --- a/spec/Media_Stream_Handler.xml +++ b/spec/Media_Stream_Handler.xml @@ -49,7 +49,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </method> <method name="Error"> - <arg direction="in" name="errno" type="u"> + <arg direction="in" name="errno" type="u" tp:type="Media_Stream_Error"> <tp:docstring> ID of error, from the MediaStreamError enumeration </tp:docstring> @@ -219,7 +219,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <signal name="SetStreamSending"> - <arg name="playing" type="b"/> + <arg name="sending" type="b"/> <tp:docstring> Signal emitted when the connection manager wishes to set whether or not the stream sends to the remote end. @@ -243,7 +243,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </signal> <method name="StreamState"> - <arg direction="in" name="state" type="u"/> + <arg direction="in" name="state" type="u" tp:type="Media_Stream_State"/> <tp:docstring> Informs the connection manager of the stream's current state, as as specified in Channel.Type.StreamedMedia::ListStreams. diff --git a/spec/all.xml b/spec/all.xml index c7552c88d..cd5749596 100644 --- a/spec/all.xml +++ b/spec/all.xml @@ -2,7 +2,8 @@ xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" xmlns:xi="http://www.w3.org/2001/XInclude"> -<tp:version>0.15.3</tp:version> +<tp:title>Telepathy D-Bus Interface Specification</tp:title> +<tp:version>0.15.4</tp:version> <tp:copyright>Copyright (C) 2005, 2006, 2007 Collabora Limited</tp:copyright> <tp:copyright>Copyright (C) 2005, 2006, 2007 Nokia Corporation</tp:copyright> |