diff options
author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2008-03-06 15:00:44 +0000 |
---|---|---|
committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2008-03-06 15:00:44 +0000 |
commit | 8f86f0964dfed29a6aae300b090d5133df713d06 (patch) | |
tree | 8768883a812b78148d3707cb3b018429424bf4e3 /spec/Channel_Interface_Call_State.xml | |
parent | f3a29ab1eefd2c5bb81b3821044521b384f4e27b (diff) | |
download | telepathy-glib-8f86f0964dfed29a6aae300b090d5133df713d06.tar.gz |
Add new files from spec 0.17.2
20080306150044-53eee-d81ca429fa421b0100978c91bb791ff18edaa1e0.gz
Diffstat (limited to 'spec/Channel_Interface_Call_State.xml')
-rw-r--r-- | spec/Channel_Interface_Call_State.xml | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/spec/Channel_Interface_Call_State.xml b/spec/Channel_Interface_Call_State.xml new file mode 100644 index 000000000..b0faa42e5 --- /dev/null +++ b/spec/Channel_Interface_Call_State.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" ?> +<node name="/Channel_Interface_Call_State" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <tp:copyright> Copyright (C) 2008 Collabora Limited </tp:copyright> + <tp:copyright> Copyright (C) 2008 Nokia Corporation </tp:copyright> + <tp:license xmlns="http://www.w3.org/1999/xhtml"> + <p>This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version.</p> + +<p>This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details.</p> + +<p>You should have received a copy of the GNU Lesser General Public +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.Channel.Interface.CallState"> + <tp:requires interface="org.freedesktop.Telepathy.Channel.Type.StreamedMedia"/> + + <tp:docstring> + An interface for streamed media channels that can indicate call + progress or call states. The presence of this interface is no guarantee + that call states will actually be signalled (for instance, SIP + implementations are not guaranteed to generate status 180 Ringing, + so a call can be accepted without the Ringing flag ever having been set). + </tp:docstring> + + <method name="GetCallStates"> + <tp:docstring> + Get the current call states for all contacts involved in this call. + </tp:docstring> + + <arg tp:type="Channel_Call_State_Map" name="States" direction="out" + type="a{uu}"> + <tp:docstring> + The current call states. Participants where the call state flags + would be 0 (all unset) may be omitted from this mapping. + </tp:docstring> + </arg> + </method> + + <signal name="CallStateChanged"> + <tp:docstring> + Emitted when the state of a member of the channel has changed. + </tp:docstring> + + <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" tp:type="Channel_Call_State_Flags"> + <tp:docstring> + The new state for this contact. + </tp:docstring> + </arg> + </signal> + + <tp:mapping name="Channel_Call_State_Map"> + <tp:docstring> + A map from contacts to call states. + </tp:docstring> + + <tp:member name="Contact" type="u" tp:type="Contact_Handle"> + <tp:docstring>A contact involved in this call.</tp:docstring> + </tp:member> + + <tp:member name="State" type="u" tp:type="Channel_Call_State_Flags"> + <tp:docstring>State flags for the given contact.</tp:docstring> + </tp:member> + </tp:mapping> + + <tp:flags name="Channel_Call_State_Flags" value-prefix="Channel_Call_State" type="u"> + <tp:docstring> + A set of flags representing call states. + </tp:docstring> + + <tp:flag suffix="Ringing" value="1"> + <tp:docstring> + The contact has been alerted about the call but has not responded + (e.g. 180 Ringing in SIP). + </tp:docstring> + </tp:flag> + + <tp:flag suffix="Queued" value="2"> + <tp:docstring> + The contact is temporarily unavailable, and the call has been placed + in a queue (e.g. 182 Queued in SIP, or call-waiting in telephony). + </tp:docstring> + </tp:flag> + </tp:flags> + + </interface> +</node> +<!-- vim:set sw=2 sts=2 et ft=xml: --> |