summaryrefslogtreecommitdiff
path: root/spec/Channel_Interface_Splittable1.xml
blob: a27cfd6098f32bd80bfb8eaafe4ca3b8af8d0131 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?xml version="1.0" ?>
<node name="/Channel_Interface_Splittable1"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright>Copyright © 2009 Collabora Limited</tp:copyright>
  <tp:copyright>Copyright © 2009 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="im.telepathy.v1.Channel.Interface.Splittable1"
    tp:causes-havoc="experimental">
    <!-- https://bugs.freedesktop.org/show_bug.cgi?id=31660 -->
    <tp:added version="0.19.0">(draft 1)</tp:added>
    <tp:requires interface="im.telepathy.v1.Channel"/>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>An interface for channels that can be made conceptually part of a
        <tp:dbus-ref namespace="im.telepathy.v1.Channel.Interface"
          >Conference1</tp:dbus-ref>, and can then be detached from that
        conference.</p>

      <tp:rationale>
        <p>This interface addresses part of freedesktop.org <a
            href="http://bugs.freedesktop.org/show_bug.cgi?id=24906">bug
            #24906</a> (GSM-compatible conference calls). GSM is currently
          the only protocol known to implement this; PBXs might implement
          it too.</p>
      </tp:rationale>
    </tp:docstring>

    <method name="Split"
      tp:name-for-bindings="Split">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Request that this channel is removed from any
        <tp:dbus-ref namespace="im.telepathy.v1.Channel.Interface"
          >Conference1</tp:dbus-ref> of which it is a part.</p>

        <p>This implies that the media streams within the conference are put on
          hold and the media streams within the member channel leaving the
          conference are unheld.</p>
      </tp:docstring>

      <tp:possible-errors>
        <tp:error name="im.telepathy.v1.Error.InvalidArgument">
          <tp:docstring>
            This channel isn't in a conference.
          </tp:docstring>
        </tp:error>
        <tp:error name="im.telepathy.v1.Error.NotAvailable">
          <tp:docstring>
            This channel is in a conference but can't currently be split away
            from it.
          </tp:docstring>
        </tp:error>
      </tp:possible-errors>
    </method>

  </interface>
</node>