aboutsummaryrefslogtreecommitdiff
path: root/spec/Subscriber.xml
blob: 904be2ae30f4b4f831ebde924406c3fa8cac16a9 (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
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <interface name="org.freedesktop.ContextKit.Subscriber" >
    <method name="Subscribe">
      <tp:docstring>
        Subscribe to a one or more keys
      </tp:docstring>

      <arg name="keys" type="as" direction="in">
        <tp:docstring>
          An array of the keys to subscribe to.
        </tp:docstring>
      </arg>

      <arg name="values" type="a{sv}" tp:type="Value_Set" direction="out">
        <tp:docstring>
          A Value_Set mapping the requested keys to their current values.
        </tp:docstring>
      </arg>
      <arg name="undeterminable_keys" type="as"  direction="out">
        <tp:docstring>
          An array of keys which we couldn't determine the values for.
        </tp:docstring>
      </arg>

    </method>

    <signal name="Changed" >
      <arg name="values" type="a{sv}" tp:type="Value_Set" >
        <tp:docstring >
          A Value_Set mapping the changed keys to their values.
        </tp:docstring>
      </arg>
      <arg name="undeterminable_keys" type="as" >
        <tp:docstring>
          An array of keys which we can no longer determine the values for.
        </tp:docstring>
      </arg>
    </signal>

    <method name="Unsubscribe" >
      <tp:docstring >
        A Value_Set mapping the requested keys to their values.
      </tp:docstring>

      <arg name="keys" type="as" direction="in">
        <tp:docstring>
          An array of the keys to unsubscribe from.
        </tp:docstring>
      </arg>
    </method>

  </interface>
</node>