[Telepathy-commits] [telepathy-spec/master] Channel stable API: name all remaining 'out' arguments
Simon McVittie
simon.mcvittie at collabora.co.uk
Mon Jan 19 04:02:47 PST 2009
---
spec/Channel.xml | 11 ++++++---
spec/Channel_Interface_Group.xml | 29 +++++++++++++++++---------
spec/Channel_Interface_Media_Signalling.xml | 3 +-
spec/Channel_Interface_Messages.xml | 3 +-
spec/Channel_Interface_Password.xml | 5 ++-
spec/Channel_Type_Room_List.xml | 2 +-
spec/Channel_Type_Streamed_Media.xml | 6 +++-
spec/Channel_Type_Text.xml | 6 +++-
spec/Channel_Type_Tubes.xml | 18 ++++++++++------
9 files changed, 53 insertions(+), 30 deletions(-)
diff --git a/spec/Channel.xml b/spec/Channel.xml
index 5a40f2f..7b4a7ad 100644
--- a/spec/Channel.xml
+++ b/spec/Channel.xml
@@ -220,7 +220,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetChannelType" tp:name-for-bindings="Get_Channel_Type">
<tp:deprecated version="0.17.7">Use the ChannelType
property if possible.</tp:deprecated>
- <arg direction="out" type="s" tp:type="DBus_Interface">
+ <arg direction="out" type="s" tp:type="DBus_Interface"
+ name="Channel_Type">
<tp:docstring>The interface name</tp:docstring>
</arg>
<tp:docstring>
@@ -238,12 +239,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetHandle" tp:name-for-bindings="Get_Handle">
<tp:deprecated version="0.17.7">Use the TargetHandleType
and TargetHandle properties if possible.</tp:deprecated>
- <arg direction="out" type="u" tp:type="Handle_Type">
+ <arg direction="out" type="u" tp:type="Handle_Type"
+ name="Target_Handle_Type">
<tp:docstring>
The same as TargetHandleType.
</tp:docstring>
</arg>
- <arg direction="out" type="u" tp:type="Handle">
+ <arg direction="out" type="u" tp:type="Handle" name="Target_Handle">
<tp:docstring>
The same as TargetHandle.
</tp:docstring>
@@ -266,7 +268,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetInterfaces" tp:name-for-bindings="Get_Interfaces">
<tp:deprecated version="0.17.7">Use the Interfaces
property if possible.</tp:deprecated>
- <arg direction="out" type="as" tp:type="DBus_Interface[]">
+ <arg direction="out" type="as" tp:type="DBus_Interface[]"
+ name="Interfaces">
<tp:docstring>
An array of the D-Bus interface names
</tp:docstring>
diff --git a/spec/Channel_Interface_Group.xml b/spec/Channel_Interface_Group.xml
index ffa0115..019e848 100644
--- a/spec/Channel_Interface_Group.xml
+++ b/spec/Channel_Interface_Group.xml
@@ -91,17 +91,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
this method and GetLocalPendingMembersWithInfo if necessary.
</tp:deprecated>
- <arg direction="out" type="au" tp:type="Contact_Handle[]">
+ <arg direction="out" type="au" tp:type="Contact_Handle[]"
+ name="Members">
<tp:docstring>
array of handles of current members
</tp:docstring>
</arg>
- <arg direction="out" type="au" tp:type="Contact_Handle[]">
+ <arg direction="out" type="au" tp:type="Contact_Handle[]"
+ name="Local_Pending">
<tp:docstring>
array of handles of local pending members
</tp:docstring>
</arg>
- <arg direction="out" type="au" tp:type="Contact_Handle[]">
+ <arg direction="out" type="au" tp:type="Contact_Handle[]"
+ name="Remote_Pending">
<tp:docstring>
array of handles of remote pending members
</tp:docstring>
@@ -254,7 +257,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</property>
<method name="GetGroupFlags" tp:name-for-bindings="Get_Group_Flags">
- <arg direction="out" type="u" tp:type="Channel_Group_Flags">
+ <arg direction="out" type="u" tp:type="Channel_Group_Flags"
+ name="Group_Flags">
<tp:docstring>
The value of the GroupFlags property
</tp:docstring>
@@ -340,7 +344,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
A list of integer handles representing members of the channel
</tp:docstring>
</arg>
- <arg direction="out" type="au" tp:type="Contact_Handle[]">
+ <arg direction="out" type="au" tp:type="Contact_Handle[]" name="Owners">
<tp:docstring>
An array of integer handles representing the owner handles of
the given room members, in the same order, or 0 if the
@@ -379,7 +383,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetLocalPendingMembers"
tp:name-for-bindings="Get_Local_Pending_Members">
- <arg direction="out" type="au" tp:type="Contact_Handle[]"/>
+ <arg direction="out" type="au" tp:type="Contact_Handle[]"
+ name="Handles"/>
<tp:docstring>
Returns the To_Be_Added handle (only) for each structure in the
<tp:member-ref>LocalPendingMembers</tp:member-ref> property.
@@ -400,7 +405,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:docstring>
<tp:deprecated version="0.17.6">Use the LocalPendingMembers
property, if Channel_Group_Flag_Properties is present.</tp:deprecated>
- <arg direction="out" type="a(uuus)" tp:type="Local_Pending_Info[]">
+ <arg direction="out" type="a(uuus)" tp:type="Local_Pending_Info[]"
+ name="Info">
<tp:docstring>
An array of structs containing:
<ul>
@@ -452,7 +458,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</property>
<method name="GetMembers" tp:name-for-bindings="Get_Members">
- <arg direction="out" type="au" tp:type="Contact_Handle[]"/>
+ <arg direction="out" type="au" tp:type="Contact_Handle[]"
+ name="Handles"/>
<tp:docstring>
Returns the <tp:member-ref>Members</tp:member-ref> property.
</tp:docstring>
@@ -476,7 +483,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetRemotePendingMembers"
tp:name-for-bindings="Get_Remote_Pending_Members">
- <arg direction="out" type="au" tp:type="Contact_Handle[]"/>
+ <arg direction="out" type="au" tp:type="Contact_Handle[]"
+ name="Handles"/>
<tp:docstring>
Returns an array of handles representing contacts who have been
invited to the channel and are awaiting remote approval.
@@ -524,7 +532,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</property>
<method name="GetSelfHandle" tp:name-for-bindings="Get_Self_Handle">
- <arg direction="out" type="u" tp:type="Contact_Handle"/>
+ <arg direction="out" type="u" tp:type="Contact_Handle"
+ name="Self_Handle"/>
<tp:docstring>
Returns the value of the <tp:member-ref>SelfHandle</tp:member-ref>
property.
diff --git a/spec/Channel_Interface_Media_Signalling.xml b/spec/Channel_Interface_Media_Signalling.xml
index acbe747..05b618b 100644
--- a/spec/Channel_Interface_Media_Signalling.xml
+++ b/spec/Channel_Interface_Media_Signalling.xml
@@ -41,7 +41,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetSessionHandlers"
tp:name-for-bindings="Get_Session_Handlers">
- <arg direction="out" type="a(os)" tp:type="Media_Session_Handler_Info[]"/>
+ <arg direction="out" type="a(os)" tp:type="Media_Session_Handler_Info[]"
+ name="Session_Handlers"/>
<tp:docstring>
Returns all currently active session handlers on this channel
as a list of (session_handler_path, type).
diff --git a/spec/Channel_Interface_Messages.xml b/spec/Channel_Interface_Messages.xml
index 463aed1..8cdee3c 100644
--- a/spec/Channel_Interface_Messages.xml
+++ b/spec/Channel_Interface_Messages.xml
@@ -797,7 +797,8 @@ USA.</p>
</tp:docstring>
</arg>
- <arg direction="out" type="s" tp:type="Sent_Message_Token">
+ <arg direction="out" type="s" tp:type="Sent_Message_Token"
+ name="Token">
<tp:docstring>
An opaque token used to match any incoming delivery or failure
reports against this message, or an empty string if the message
diff --git a/spec/Channel_Interface_Password.xml b/spec/Channel_Interface_Password.xml
index bfc617a..720849a 100644
--- a/spec/Channel_Interface_Password.xml
+++ b/spec/Channel_Interface_Password.xml
@@ -31,7 +31,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</tp:flag>
</tp:flags>
<method name="GetPasswordFlags" tp:name-for-bindings="Get_Password_Flags">
- <arg direction="out" type="u" tp:type="Channel_Password_Flags">
+ <arg direction="out" type="u" tp:type="Channel_Password_Flags"
+ name="Password_Flags">
<tp:docstring>
An integer with the logical OR of all the flags set
(values of ChannelPasswordFlags)
@@ -71,7 +72,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
The password
</tp:docstring>
</arg>
- <arg direction="out" type="b">
+ <arg direction="out" type="b" name="Correct">
A boolean indicating whether or not the password was correct
</arg>
<tp:docstring>
diff --git a/spec/Channel_Type_Room_List.xml b/spec/Channel_Type_Room_List.xml
index d2403bb..10ccac6 100644
--- a/spec/Channel_Type_Room_List.xml
+++ b/spec/Channel_Type_Room_List.xml
@@ -40,7 +40,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</property>
<method name="GetListingRooms" tp:name-for-bindings="Get_Listing_Rooms">
- <arg direction="out" type="b">
+ <arg direction="out" type="b" name="In_Progress">
<tp:docstring>
A boolean indicating if room listing is in progress
</tp:docstring>
diff --git a/spec/Channel_Type_Streamed_Media.xml b/spec/Channel_Type_Streamed_Media.xml
index f4615ab..599fe16 100644
--- a/spec/Channel_Type_Streamed_Media.xml
+++ b/spec/Channel_Type_Streamed_Media.xml
@@ -89,7 +89,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<tp:simple-type name="Stream_ID" type="u"/>
<method name="ListStreams" tp:name-for-bindings="List_Streams">
- <arg direction="out" type="a(uuuuuu)" tp:type="Media_Stream_Info[]">
+ <arg direction="out" type="a(uuuuuu)" tp:type="Media_Stream_Info[]"
+ name="Streams">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
An array of structs containing:
<ul>
@@ -180,7 +181,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
An array of stream types (values of MediaStreamType)
</tp:docstring>
</arg>
- <arg direction="out" type="a(uuuuuu)" tp:type="Media_Stream_Info[]">
+ <arg direction="out" type="a(uuuuuu)" tp:type="Media_Stream_Info[]"
+ name="Streams">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
An array of structs (in the same order as the given stream types)
containing:
diff --git a/spec/Channel_Type_Text.xml b/spec/Channel_Type_Text.xml
index f32382d..5c28dce 100644
--- a/spec/Channel_Type_Text.xml
+++ b/spec/Channel_Type_Text.xml
@@ -67,7 +67,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</method>
<method name="GetMessageTypes" tp:name-for-bindings="Get_Message_Types">
- <arg direction="out" type="au" tp:type="Channel_Text_Message_Type[]">
+ <arg direction="out" type="au" tp:type="Channel_Text_Message_Type[]"
+ name="Available_Types">
<tp:docstring>
An array of integer message types (ChannelTextMessageType)
</tp:docstring>
@@ -92,7 +93,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
acknowledge messages after they have actually stored them, which is
impossible if this flag is true.</tp:deprecated>
</arg>
- <arg direction="out" type="a(uuuuus)" tp:type="Pending_Text_Message[]">
+ <arg direction="out" type="a(uuuuus)" tp:type="Pending_Text_Message[]"
+ name="Pending_Messages">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
An array of structs representing the pending queue. Each contains:
<ul>
diff --git a/spec/Channel_Type_Tubes.xml b/spec/Channel_Type_Tubes.xml
index df98ac7..1c776ea 100644
--- a/spec/Channel_Type_Tubes.xml
+++ b/spec/Channel_Type_Tubes.xml
@@ -252,7 +252,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
tp:name-for-bindings="Get_Available_Stream_Tube_Types">
<tp:docstring>List the available address types and access-control types
for stream tubes.</tp:docstring>
- <arg direction="out" type="a{uau}" tp:type="Supported_Socket_Map">
+ <arg direction="out" type="a{uau}" tp:type="Supported_Socket_Map"
+ name="Available_Stream_Tube_Types">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A mapping from address types (members of Socket_Address_Type) to
arrays of access-control type (members of Socket_Access_Control)
@@ -280,7 +281,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<method name="GetAvailableTubeTypes"
tp:name-for-bindings="Get_Available_Tube_Types">
- <arg direction="out" type="au" tp:type="Tube_Type[]">
+ <arg direction="out" type="au" tp:type="Tube_Type[]"
+ name="Available_Tube_Types">
<tp:docstring>
An array of the available tube types, as defined by the Tube_Type
enum.
@@ -289,7 +291,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</method>
<method name="ListTubes" tp:name-for-bindings="List_Tubes">
- <arg direction="out" type="a(uuusa{sv}u)" tp:type="Tube_Info[]">
+ <arg direction="out" type="a(uuusa{sv}u)" tp:type="Tube_Info[]"
+ name="Tubes">
<tp:docstring>
Return an array of tuples, each representing a tube, with the
following members:
@@ -327,7 +330,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
D-Bus type, or a byte array 'ay'.
</tp:docstring>
</arg>
- <arg direction="out" type="u" tp:type="Tube_ID">
+ <arg direction="out" type="u" tp:type="Tube_ID" name="Tube_ID">
<tp:docstring>
The ID of the new tube.
</tp:docstring>
@@ -400,7 +403,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
specified in the documentation for the Socket_Access_Control enum.
</tp:docstring>
</arg>
- <arg direction="out" type="u" tp:type="Tube_ID">
+ <arg direction="out" type="u" tp:type="Tube_ID" name="Tube_ID">
<tp:docstring>
The ID of the new tube.
</tp:docstring>
@@ -591,7 +594,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
The ID of the tube to get an address for.
</tp:docstring>
</arg>
- <arg direction="out" type="s">
+ <arg direction="out" type="s" name="Address">
<tp:docstring>
The bus address.
</tp:docstring>
@@ -620,7 +623,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
The ID of the tube to get names for.
</tp:docstring>
</arg>
- <arg direction="out" type="a(us)" tp:type="DBus_Tube_Member[]">
+ <arg direction="out" type="a(us)" tp:type="DBus_Tube_Member[]"
+ name="DBus_Names">
<tp:docstring>
An array of structures, each containing a contact handle and a D-Bus
bus name.
--
1.5.6.5
More information about the Telepathy-commits
mailing list