diff options
author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2007-11-13 14:05:03 +0000 |
---|---|---|
committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2007-11-13 14:05:03 +0000 |
commit | 9c4ca82db7479238fdd1f00863925f621e51f638 (patch) | |
tree | 86627c97135f681648528f34433b67cff0517559 /spec/Connection.xml | |
parent | f8d1ebc3f935a893499b7518486963bb68b8ef09 (diff) | |
download | telepathy-glib-9c4ca82db7479238fdd1f00863925f621e51f638.tar.gz |
Update spec/ to current telepathy-spec HEAD
20071113140503-53eee-178e466d1831fdfd00e9d5a34b0e50ad4e4387cc.gz
Diffstat (limited to 'spec/Connection.xml')
-rw-r--r-- | spec/Connection.xml | 45 |
1 files changed, 30 insertions, 15 deletions
diff --git a/spec/Connection.xml b/spec/Connection.xml index fb0856596..bfa33f476 100644 --- a/spec/Connection.xml +++ b/spec/Connection.xml @@ -21,6 +21,27 @@ License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p> </tp:license> <interface name="org.freedesktop.Telepathy.Connection"> + + <tp:struct name="Channel_Info" array-name="Channel_Info_List"> + <tp:docstring>A struct representing a channel, as returned by + ListChannels on the Connection interface.</tp:docstring> + <tp:member type="o" name="Channel"> + <tp:docstring>The object path of the channel, which is on the + same bus name as the connection</tp:docstring> + </tp:member> + <tp:member type="s" tp:type="DBus_Interface" name="Channel_Type"> + <tp:docstring>The channel's type</tp:docstring> + </tp:member> + <tp:member type="u" tp:type="Handle_Type" name="Handle_Type"> + <tp:docstring>The type of the handle that the channel communicates + with, or 0 if there is no associated handle</tp:docstring> + </tp:member> + <tp:member type="u" tp:type="Handle" name="Handle"> + <tp:docstring>The handle that the channel communicates with, + or 0 if there is no associated handle</tp:docstring> + </tp:member> + </tp:struct> + <method name="Connect"> <tp:docstring> Request that the connection be established. This will be done @@ -41,7 +62,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </method> <method name="GetInterfaces"> - <arg direction="out" type="as" tp:type="Interface[]"> + <arg direction="out" type="as" tp:type="DBus_Interface[]"> <tp:docstring> An array of D-Bus interface names </tp:docstring> @@ -92,7 +113,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <method name="HoldHandles"> <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> - An integer handle type (as defined in HandleType) + The type of handle to be held </tp:docstring> </arg> <arg direction="in" name="handles" type="au" tp:type="Handle[]"> @@ -130,7 +151,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <method name="InspectHandles"> <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> - An integer handle type (as defined in HandleType) + The type of handle to be inspected </tp:docstring> </arg> <arg direction="in" name="handles" type="au" tp:type="Handle[]"> @@ -158,15 +179,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:possible-errors> </method> <method name="ListChannels"> - <arg direction="out" type="a(osuu)"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>An array of structs containing:</p> - <ul> - <li>a D-Bus object path for the channel object on this service</li> - <li>a D-Bus interface name representing the channel type</li> - <li>an integer representing the handle type this channel communicates with, or zero</li> - <li>an integer handle representing the contact, room or list this channel communicates with, or zero</li> - </ul> + <arg direction="out" type="a(osuu)" tp:type="Channel_Info[]"> + <tp:docstring> + An array of structs representing channels. </tp:docstring> </arg> <tp:docstring> @@ -182,7 +197,7 @@ 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" tp:type="Interface"> + <arg name="channel_type" type="s" tp:type="DBus_Interface"> <tp:docstring> A D-Bus interface name representing the channel type </tp:docstring> @@ -240,7 +255,7 @@ 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" tp:type="Interface"> + <arg direction="in" name="type" type="s" tp:type="DBus_Interface"> <tp:docstring> A D-Bus interface name representing base channel type </tp:docstring> @@ -352,7 +367,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <method name="RequestHandles"> <arg direction="in" name="handle_type" type="u" tp:type="Handle_Type"> <tp:docstring> - An integer handle type (as defined in HandleType) + The type of handle required </tp:docstring> </arg> <arg direction="in" name="names" type="as"> |