Extensions: pulled in org.freedesktop.telepathy.Channel.Interface.CallState from telepathy spec 0.17.1.1

20080225163439-5b6ca-43a0172a32fa17ae959955d559fb36c4d2c5884b.gz

3 files changed, 99 insertions, 0 deletions

diff --git a/extensions/Channel_Interface_Call_State.xml b/extensions/Channel_Interface_Call_State.xml
new file mode 100644
index 0000000..424c119
--- /dev/null
+++ b/extensions/Channel_Interface_Call_State.xml
@@ -0,0 +1,97 @@
+<?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" type="u">
+      <tp:docstring>
+        A set of flags representing call states.
+
+        <tp:rationale>
+          While there is currently only one flag, more flags are likely to be
+          added later, for example for call-waiting.
+        </tp:rationale>
+      </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:flags>
+
+  </interface>
+</node>
+<!-- vim:set sw=2 sts=2 et ft=xml: -->
diff --git a/extensions/Makefile.am b/extensions/Makefile.am
index 97e0029..48f9dc2 100644
--- a/extensions/Makefile.am
+++ b/extensions/Makefile.am
@@ -9,6 +9,7 @@ AM_CFLAGS = \
 EXTRA_DIST = \
     all.xml \
     channel.xml \
+    Channel_Interface_Call_State.xml \
     Channel_Interface_Hold.xml
 
 noinst_LTLIBRARIES = libsip-extensions.la
diff --git a/extensions/channel.xml b/extensions/channel.xml
index d8ecf19..84abb22 100644
--- a/extensions/channel.xml
+++ b/extensions/channel.xml
@@ -4,6 +4,7 @@
 
 <tp:title>Channel extensions for telepathy-sofiasip</tp:title>
 
+<xi:include href="Channel_Interface_Call_State.xml"/>
 <xi:include href="Channel_Interface_Hold.xml"/>
 
 </tp:spec>