summaryrefslogtreecommitdiff
path: root/extensions/OLPC_Activity_Properties.xml
blob: 4125cd50be40edc3435cf64e8cddb9176d4fcbd4 (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?xml version="1.0" ?>
<node name="/OLPC_Activity_Properties" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright> Copyright (C) 2007 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.ActivityProperties">
    <tp:requires interface="im.telepathy1.Connection"/>

    <method name="SetProperties" tp:name-for-bindings="Set_Properties">
      <arg direction="in" name="room" type="u">
        <tp:docstring>
          An integer handle representing the room of the activity
        </tp:docstring>
      </arg>
      <arg direction="in" name="properties" type="a{sv}">
        <tp:docstring>
          A dictionary mapping properties names to the desired values
        </tp:docstring>
      </arg>
      <tp:docstring>
        Set the properties of the activity associated to the given room for this connection.
        You have to be the owner of this activity.
      </tp:docstring>
      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.Disconnected"/>
        <tp:error name="im.telepathy1.Error.InvalidArgument"/>
        <tp:error name="im.telepathy1.Error.PermissionDenied"/>
      </tp:possible-errors>
    </method>

    <method name="GetProperties" tp:name-for-bindings="Get_Properties">
      <arg direction="in" name="room" type="u">
        <tp:docstring>
          An integer handle for the activity's room to request his properties for
        </tp:docstring>
      </arg>
      <arg direction="out" name="properties" type="a{sv}">
        <tp:docstring>
          A dictionary mapping properties names to their values
        </tp:docstring>
      </arg>
      <tp:docstring>
        Get the properties of a particular activity.
      </tp:docstring>
      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.Disconnected"/>
        <tp:error name="im.telepathy1.Error.InvalidArgument"/>
      </tp:possible-errors>
    </method>

    <method name="GetActivity" tp:name-for-bindings="Get_Activity">
      <arg direction="in" name="activity_id" type="s">
        <tp:docstring>
          An activity id
        </tp:docstring>
      </arg>
      <arg direction="out" name="room" type="u">
        <tp:docstring>
          A room handle
        </tp:docstring>
      </arg>
      <tp:docstring>
        Returns the handle of the room associated with this activity
        <tp:rationale>
          <p>When an activity starts up, it knows its activity_id but doesn't
             know yet if it's shared or not, much less the room.</p>
        </tp:rationale>
      </tp:docstring>
      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.Disconnected"/>
        <tp:error name="im.telepathy1.Error.InvalidArgument"/>
      </tp:possible-errors>
    </method>

    <signal name="ActivityPropertiesChanged"
      tp:name-for-bindings="Activity_Properties_Changed">
      <arg name="room" type="u">
        <tp:docstring>
          An integer handle representing the room of the activity
        </tp:docstring>
      </arg>
      <arg name="properties" type="a{sv}">
        <tp:docstring>
          A dictionary mapping properties names to their new values
        </tp:docstring>
      </arg>
      <tp:docstring>
        Signal emitted when the properties of an activity are changed.
      </tp:docstring>
    </signal>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>An interface on connections to associate OLPC activity properties
    with rooms.</p>

    <p>The following types and names are used to request and set properties:</p>
      <dl>
        <dt>s:color</dt>
        <dd>The color of the activity. Format used is #RRGGBB,#RRGGBB (stroke,fill).</dd>

        <dt>s:name</dt>
        <dd>The name of the activity.</dd>

        <dt>s:type</dt>
        <dd>The type of the activity.</dd>
      </dl>

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