summaryrefslogtreecommitdiff
path: root/spec/Channel_Request_Future.xml
blob: d75c7e0ce5281f0138abd4deebcfbdd68c8fccdf (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?xml version="1.0" ?>
<node name="/Channel_Request_Future"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright>Copyright © 2008-2010 Collabora Ltd.</tp:copyright>
  <tp:copyright>Copyright © 2008-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="org.freedesktop.Telepathy.ChannelRequest.FUTURE"
      tp:causes-havoc="a staging area for future Channel functionality">

      <tp:requires interface="org.freedesktop.Telepathy.ChannelRequest"/>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>This interface contains functionality which we intend to incorporate
        into the <tp:dbus-ref
          namespace="org.freedesktop.Telepathy">ChannelRequest</tp:dbus-ref>
        interface in future. It should be considered to
        be conceptually part of the core ChannelRequest interface, but without
        API or ABI guarantees.</p>
    </tp:docstring>

    <property name="Hints" tp:name-for-bindings="Hints"
      type="a{sv}" access="read">
      <tp:added version="0.19.12">(as draft)</tp:added>
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>A dictionary of metadata provided by the channel
          requester, which the handler and other clients MAY choose to
          interpret.  Currently no standard keys are defined; clients MAY
          choose to use platform-specific keys for their own purposes, but MUST
          ignore unknown keys and MUST cope with expected keys being
          missing.</p>

        <tp:rationale>This property might be used to pass a contact ID for a
          telephone number shared between two contacts from the address book to
          the call UI, so that if you try to call “Mum”, the call UI knows this
          rather than having to guess or show “Calling Mum or Dad”. The format
          of these contact IDs would be platform-specific, so we leave the
          definition of the dictionary entry up to the platform in question.
          But third-party channel requesters might not include the contact ID,
          so the call UI has to be able to deal with it not being
          there.</tp:rationale>

        <p>The channel dispatcher will not interpret these hints: they are
          solely for communication between cooperating clients.</p>

        <tp:rationale>
          <p>Any extra parameters that do affect the channel dispatcher should
            be designed separately.</p>
        </tp:rationale>

        <p>This property may be set when the channel request is created, and
          can never change. Since it is immutable, it SHOULD be included in the
          dictionary of properties passed to <tp:dbus-ref
          namespace="ofdT.Client.Interface.Requests">AddRequest</tp:dbus-ref>
          by the <tp:dbus-ref
          namespace="org.freedesktop.Telepathy">ChannelDispatcher</tp:dbus-ref>.</p>
      </tp:docstring>
    </property>

    <signal name="SucceededWithChannel" tp:name-for-bindings="Succeeded_With_Channel">
      <tp:added version="0.19.12">(as draft)</tp:added>
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Variant of the <tp:dbus-ref
            namespace="ofdT.ChannelRequest">Succeeded</tp:dbus-ref> signal
        allowing to get the channel which has been created.</p>
      </tp:docstring>

      <arg name="Connection" type="o">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The Connection owning the channel.</p>
        </tp:docstring>
      </arg>

      <arg name="Channel" type="o">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The channel which has been created.</p>
        </tp:docstring>
      </arg>

    </signal>

  </interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->