~ubuntu-branches/ubuntu/utopic/telepathy-python/utopic

« back to all changes in this revision

Viewing changes to spec/Channel_Future.xml

  • Committer: Bazaar Package Importer
  • Author(s): Jonny Lamb
  • Date: 2009-02-16 10:47:31 UTC
  • mfrom: (7.1.14 jaunty)
  • Revision ID: james.westby@ubuntu.com-20090216104731-3l467x71wygwok32
Tags: 0.15.6-2
debian/control: Added myself to Uploaders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
 
2
<node name="/Channel_Future"
 
3
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
 
4
  <tp:copyright>Copyright (C) 2008 Collabora Ltd.</tp:copyright>
 
5
  <tp:copyright>Copyright (C) 2008 Nokia Corporation</tp:copyright>
 
6
  <tp:license xmlns="http://www.w3.org/1999/xhtml">
 
7
    <p>This library is free software; you can redistribute it and/or
 
8
modify it under the terms of the GNU Lesser General Public
 
9
License as published by the Free Software Foundation; either
 
10
version 2.1 of the License, or (at your option) any later version.</p>
 
11
 
 
12
<p>This library is distributed in the hope that it will be useful,
 
13
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
15
Lesser General Public License for more details.</p>
 
16
 
 
17
<p>You should have received a copy of the GNU Lesser General Public
 
18
License along with this library; if not, write to the Free Software
 
19
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
 
20
  </tp:license>
 
21
  <interface name="org.freedesktop.Telepathy.Channel.FUTURE"
 
22
    tp:causes-havoc="a staging area for future Channel functionality">
 
23
 
 
24
    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
25
      <p>This interface contains functionality which we intend to incorporate
 
26
        into the <tp:dbus-ref
 
27
        namespace="org.freedesktop.Telepathy">Channel</tp:dbus-ref> interface
 
28
        in future. It should be considered to
 
29
        be conceptually part of the core Channel interface, but without
 
30
        API or ABI guarantees.</p>
 
31
 
 
32
      <tp:rationale>
 
33
        <p>If we add new functionality to the Channel interface, libraries
 
34
          that use generated code (notably telepathy-glib) will have it as
 
35
          part of their ABI forever, meaning we can't make incompatible
 
36
          changes. By using this interface as a staging area for future
 
37
          Channel functionality, we can try out new properties, signals
 
38
          and methods as application-specific extensions, then merge them
 
39
          into the core Channel interface when we have enough implementation
 
40
          experience to declare them to be stable.</p>
 
41
 
 
42
        <p>The name is by analogy to Python's <code>__future__</code>
 
43
          pseudo-module.</p>
 
44
      </tp:rationale>
 
45
    </tp:docstring>
 
46
 
 
47
    <property name="Bundle" tp:name-for-bindings="Bundle"
 
48
      type="o" access="read">
 
49
      <tp:added version="0.17.9">(in Channel.FUTURE
 
50
        pseudo-interface)</tp:added>
 
51
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
52
        <p>The
 
53
          <tp:dbus-ref namespace="org.freedesktop.Telepathy">ChannelBundle</tp:dbus-ref>
 
54
          to which this channel belongs.</p>
 
55
 
 
56
        <p>A channel's Bundle property can never change.</p>
 
57
 
 
58
        <p>Older connection managers might not have this property. Clients
 
59
          (particularly the channel dispatcher) SHOULD recover by considering
 
60
          each channel to be in a bundle containing only that channel,
 
61
          distinct from all other bundles, which has no additional
 
62
          interfaces.</p>
 
63
      </tp:docstring>
 
64
    </property>
 
65
 
 
66
  </interface>
 
67
</node>
 
68
<!-- vim:set sw=2 sts=2 et ft=xml: -->