[Telepathy-commits] [telepathy-spec/master] Connection stable API: name all remaining 'out' arguments
Simon McVittie
simon.mcvittie at collabora.co.uk
Mon Jan 19 04:03:58 PST 2009
---
spec/Connection.xml | 21 +++++++++++++--------
spec/Connection_Interface_Aliasing.xml | 7 ++++---
spec/Connection_Interface_Avatars.xml | 16 ++++++++--------
spec/Connection_Interface_Capabilities.xml | 6 ++++--
spec/Connection_Interface_Presence.xml | 3 ++-
5 files changed, 31 insertions(+), 22 deletions(-)
diff --git a/spec/Connection.xml b/spec/Connection.xml
index 9516196..313b7fe 100644
--- a/spec/Connection.xml
+++ b/spec/Connection.xml
@@ -67,7 +67,8 @@ USA.</p>
</method>
<method name="GetInterfaces" tp:name-for-bindings="Get_Interfaces">
- <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 D-Bus interface names
</tp:docstring>
@@ -110,7 +111,7 @@ USA.</p>
</method>
<method name="GetProtocol" tp:name-for-bindings="Get_Protocol">
- <arg direction="out" type="s" tp:type="Protocol">
+ <arg direction="out" type="s" tp:type="Protocol" name="Protocol">
<tp:docstring>
A string identifier for the protocol
</tp:docstring>
@@ -157,7 +158,8 @@ USA.</p>
</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>
The value of the <tp:member-ref>SelfHandle</tp:member-ref> property
</tp:docstring>
@@ -177,7 +179,8 @@ USA.</p>
</method>
<method name="GetStatus" tp:name-for-bindings="Get_Status">
- <arg direction="out" type="u" tp:type="Connection_Status">
+ <arg direction="out" type="u" tp:type="Connection_Status"
+ name="Status">
<tp:docstring>
An integer representing the current status
</tp:docstring>
@@ -246,7 +249,7 @@ USA.</p>
</tp:docstring>
</arg>
- <arg direction="out" type="as">
+ <arg direction="out" type="as" name="Identifiers">
<tp:docstring>
An array of handle names in the same order as the given numbers
</tp:docstring>
@@ -269,7 +272,8 @@ USA.</p>
</method>
<method name="ListChannels" tp:name-for-bindings="List_Channels">
- <arg direction="out" type="a(osuu)" tp:type="Channel_Info[]">
+ <arg direction="out" type="a(osuu)" tp:type="Channel_Info[]"
+ name="Channel_Info">
<tp:docstring>
An array of structs representing channels.
</tp:docstring>
@@ -429,7 +433,7 @@ USA.</p>
</tp:docstring>
</arg>
- <arg direction="out" type="o">
+ <arg direction="out" type="o" name="Object_Path">
<tp:docstring>
The D-Bus object path for the channel created or retrieved
</tp:docstring>
@@ -562,7 +566,8 @@ USA.</p>
</tp:docstring>
</arg>
- <arg direction="out" type="au" tp:type="Handle[]">
+ <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
</tp:docstring>
diff --git a/spec/Connection_Interface_Aliasing.xml b/spec/Connection_Interface_Aliasing.xml
index 652ed01..a599436 100644
--- a/spec/Connection_Interface_Aliasing.xml
+++ b/spec/Connection_Interface_Aliasing.xml
@@ -71,7 +71,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:flag>
</tp:flags>
<method name="GetAliasFlags" tp:name-for-bindings="Get_Alias_Flags">
- <arg direction="out" type="u" tp:type="Connection_Alias_Flags">
+ <arg direction="out" type="u" tp:type="Connection_Alias_Flags"
+ name="Alias_Flags">
<tp:docstring>
An integer with a bitwise OR of flags from ConnectionAliasFlags
</tp:docstring>
@@ -90,7 +91,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
An array of handles representing contacts
</tp:docstring>
</arg>
- <arg direction="out" type="as">
+ <arg direction="out" type="as" name="Aliases">
<tp:docstring>
A list of aliases in the same order as the contact handles
</tp:docstring>
@@ -111,7 +112,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
An array of handles representing contacts
</tp:docstring>
</arg>
- <arg direction="out" type="a{us}" tp:type="Alias_Map">
+ <arg direction="out" type="a{us}" tp:type="Alias_Map" name="Aliases">
<tp:docstring>
A dictionary mapping contact handles to aliases
</tp:docstring>
diff --git a/spec/Connection_Interface_Avatars.xml b/spec/Connection_Interface_Avatars.xml
index 27c77b9..7ef26af 100644
--- a/spec/Connection_Interface_Avatars.xml
+++ b/spec/Connection_Interface_Avatars.xml
@@ -126,32 +126,32 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<method name="GetAvatarRequirements"
tp:name-for-bindings="Get_Avatar_Requirements">
- <arg direction="out" type="as">
+ <arg direction="out" type="as" name="MIME_Types">
<tp:docstring>
An array of supported MIME types (eg image/jpeg)
</tp:docstring>
</arg>
- <arg direction="out" type="q">
+ <arg direction="out" type="q" name="Min_Width">
<tp:docstring>
The minimum image width in pixels
</tp:docstring>
</arg>
- <arg direction="out" type="q">
+ <arg direction="out" type="q" name="Min_Height">
<tp:docstring>
The minimum image height in pixels
</tp:docstring>
</arg>
- <arg direction="out" type="q">
+ <arg direction="out" type="q" name="Max_Width">
<tp:docstring>
The maximum image width in pixels, or 0 if there is no limit
</tp:docstring>
</arg>
- <arg direction="out" type="q">
+ <arg direction="out" type="q" name="Max_Height">
<tp:docstring>
The maximum image height in pixels, or 0 if there is no limit
</tp:docstring>
</arg>
- <arg direction="out" type="u">
+ <arg direction="out" type="u" name="Max_Bytes">
<tp:docstring>
The maximum image size in bytes, or 0 if there is no limit
</tp:docstring>
@@ -233,12 +233,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
An integer handle for the contact to request the avatar for
</tp:docstring>
</arg>
- <arg direction="out" type="ay">
+ <arg direction="out" type="ay" name="Data">
<tp:docstring>
An array of bytes containing the image data
</tp:docstring>
</arg>
- <arg direction="out" type="s">
+ <arg direction="out" type="s" name="MIME_Type">
<tp:docstring>
A string containing the image MIME type (eg image/jpeg), or empty if
unknown
diff --git a/spec/Connection_Interface_Capabilities.xml b/spec/Connection_Interface_Capabilities.xml
index 7d0c14a..4e58d02 100644
--- a/spec/Connection_Interface_Capabilities.xml
+++ b/spec/Connection_Interface_Capabilities.xml
@@ -130,7 +130,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
An array of D-Bus interface names of channel types to remove
</tp:docstring>
</arg>
- <arg direction="out" type="a(su)" tp:type="Capability_Pair[]">
+ <arg direction="out" type="a(su)" tp:type="Capability_Pair[]"
+ name="Self_Capabilities">
<tp:docstring>
An array of structures describing the current capabilities containing:
<ul>
@@ -203,7 +204,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
list.</p>
</tp:docstring>
</arg>
- <arg direction="out" type="a(usuu)" tp:type="Contact_Capability[]">
+ <arg direction="out" type="a(usuu)" tp:type="Contact_Capability[]"
+ name="Contact_Capabilities">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
An array of structures containing:
<ul>
diff --git a/spec/Connection_Interface_Presence.xml b/spec/Connection_Interface_Presence.xml
index 8f34c81..b15b5a1 100644
--- a/spec/Connection_Interface_Presence.xml
+++ b/spec/Connection_Interface_Presence.xml
@@ -131,7 +131,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</tp:possible-errors>
</method>
<method name="GetStatuses" tp:name-for-bindings="Get_Statuses">
- <arg direction="out" type="a{s(ubba{ss})}" tp:type="Status_Spec_Map">
+ <arg direction="out" type="a{s(ubba{ss})}" tp:type="Status_Spec_Map"
+ name="Available_Statuses">
<tp:docstring>
A dictionary of string identifiers mapped to a struct for each status, containing:
<ul>
--
1.5.6.5
More information about the Telepathy-commits
mailing list