summaryrefslogtreecommitdiff
path: root/extensions/OLPC_Channel_Interface_View.xml
blob: 0265538d6fe17af3d0131bffcf54886a7b7249be (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
<?xml version="1.0" ?>
<node name="/OLPC_Channel_Interface_View" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright> Copyright (C) 2008 Collabora Limited </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 St, Fifth Floor, Boston, MA  02110-1301  USA</p>
  </tp:license>
  <interface name="org.laptop.Telepathy.Channel.Interface.View">
  <tp:requires interface="org.freedesktop.Telepathy.Channel"/>

    <signal name="ActivitiesChanged" tp:name-for-bindings="Activities_Changed">
      <arg name="added" type="a(su)" tp:type="Activity[]">
        <tp:docstring>
          Room handles of the added activities
        </tp:docstring>
      </arg>
      <arg name="removed" type="a(su)" tp:type="Activity[]">
        <tp:docstring>
          Room handles of the removed activities
        </tp:docstring>
      </arg>
      <tp:docstring>
        Signal emitted when the activities in the view are changed.
      </tp:docstring>
    </signal>

    <signal name="BuddiesChanged" tp:name-for-bindings="Buddies_Changed">
      <arg name="added" type="au">
        <tp:docstring>
          Handles of the added buddies
        </tp:docstring>
      </arg>
      <arg name="removed" type="au">
        <tp:docstring>
          Handles of the removed buddies
        </tp:docstring>
      </arg>
      <tp:docstring>
        Signal emitted when the buddies in the view are changed.
      </tp:docstring>
    </signal>

    <property name="MaxSize" type="u" access="read"
              tp:name-for-bindings="Size">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>The maximum number of elements that Gadget has to return to the search request.</p>
        <p>When requesting a channel with 
          <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
          this property MUST be included in the request.</p>
      </tp:docstring>
    </property>

    <property name="Buddies" type="au" access="read"
              tp:name-for-bindings="Buddies" tp:type="Contact_Handle[]">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>The buddies who are in this view channel.</p>

        <p>It does not make sense for this property to be in channel requests.</p>
      </tp:docstring>
    </property>

    <property name="Activities" type="a(su)" access="read"
              tp:name-for-bindings="Activities" tp:type="Activity[]">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>The activities which are in this view channel.</p>

        <p>It does not make sense for this property to be in channel requests.</p>
      </tp:docstring>
    </property>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>An interface for channels representing the result of a Gadget search.</p>
      <p>Buddy properties changes are notified on the Connection object using the
        <tp:dbus-ref namespace="org.laptop.Telepathy">BuddyInfo</tp:dbus-ref>
        interface while the view object
        is alive.</p>
      <p>Activity properties changes are notified on the Connection object using the
        <tp:dbus-ref namespace="org.laptop.Telepathy">ActivityProperties</tp:dbus-ref>
        interface while the view object is alive.</p>
      <p>Activities membership is notified on the Connection object using the
        <tp:dbus-ref namespace="org.laptop.Telepathy">BuddyInfo</tp:dbus-ref>
        properties while the view object is alive.</p>
    </tp:docstring>
  </interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->