← Back to branch summary

~pete-woods/libqtdbusmock/cmake-extras-compatibility

« back to all changes in this revision

Viewing changes to data/org.freedesktop.URfkill.xml

  • Committer: CI Train Bot
  • Author(s): Pete Woods, Marcus Tomlinson
  • Date: 2015-03-31 11:22:40 UTC
  • mfrom: (35.1.31 trunk)
  • Revision ID: ci-train-bot@canonical.com-20150331112240-y0fwo7btgfm1658z
Add delegates for urfkill and ofono

Show diffs side-by-side

added added

removed removed

Lines of Context:
data/org.freedesktop.URfkill.xml
 
1
<!DOCTYPE node PUBLIC
 
2
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 
3
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
 
4
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
 
5
 
 
6
  <interface name="org.freedesktop.URfkill">
 
7
    <doc:doc>
 
8
      <doc:description>
 
9
        <doc:para>
 
10
          The urfkill service is available via the system message
 
11
          bus. To access the service, use
 
12
          the <doc:tt>org.freedesktop.URfkill</doc:tt> interface on
 
13
          the <doc:tt>/org/freedesktop/URfkill</doc:tt> object on
 
14
          the D-Bus system bus service with the well-known
 
15
          name <doc:tt>org.freedesktop.URfkill</doc:tt>.
 
16
        </doc:para>
 
17
        <doc:para>
 
18
          <doc:example language="shell" title="simple example">
 
19
            <doc:code>
 
20
$ gdbus call -y \
 
21
             -d org.freedesktop.URfkill \
 
22
             -o /org/freedesktop/URfkill \
 
23
             -m org.freedesktop.URfkill.EnumerateDevices
 
24
 
 
25
([objectpath '/org/freedesktop/URfkill/devices/0', '/org/freedesktop/URfkill/devices/1'],)
 
26
            </doc:code>
 
27
          </doc:example>
 
28
        </doc:para>
 
29
      </doc:description>
 
30
    </doc:doc>
 
31
 
 
32
    <!-- ************************************************************ -->
 
33
 
 
34
    <method name="Block">
 
35
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
36
      <arg type="u" name="type" direction="in">
 
37
        <doc:doc><doc:summary>
 
38
          The type of devices to be blocked/unblocked
 
39
        </doc:summary></doc:doc>
 
40
      </arg>
 
41
      <arg type="b" name="block" direction="in">
 
42
        <doc:doc><doc:summary>
 
43
          TRUE to block the devices, FALSE to unblock
 
44
        </doc:summary></doc:doc>
 
45
      </arg>
 
46
      <arg type="b" name="ret" direction="out">
 
47
        <doc:doc><doc:summary>
 
48
          TRUE for success, otherwise FALSE
 
49
        </doc:summary></doc:doc>
 
50
      </arg>
 
51
 
 
52
      <doc:doc>
 
53
        <doc:description>
 
54
          <doc:para>
 
55
            Block or unblock the devices belonging to the type.
 
56
            The types are defined as the followings:
 
57
          </doc:para>
 
58
          <doc:list>
 
59
            <doc:item>
 
60
              <doc:term>0</doc:term><doc:definition>All</doc:definition>
 
61
            </doc:item>
 
62
            <doc:item>
 
63
              <doc:term>1</doc:term><doc:definition>WLAN</doc:definition>
 
64
            </doc:item>
 
65
            <doc:item>
 
66
              <doc:term>2</doc:term><doc:definition>Bluetooth</doc:definition>
 
67
            </doc:item>
 
68
            <doc:item>
 
69
              <doc:term>3</doc:term><doc:definition>UWB</doc:definition>
 
70
            </doc:item>
 
71
            <doc:item>
 
72
              <doc:term>4</doc:term><doc:definition>WIMAX</doc:definition>
 
73
            </doc:item>
 
74
            <doc:item>
 
75
              <doc:term>5</doc:term><doc:definition>WWAN</doc:definition>
 
76
            </doc:item>
 
77
            <doc:item>
 
78
              <doc:term>6</doc:term><doc:definition>GPS</doc:definition>
 
79
            </doc:item>
 
80
            <doc:item>
 
81
              <doc:term>7</doc:term><doc:definition>FM</doc:definition>
 
82
            </doc:item>
 
83
          </doc:list>
 
84
          <doc:para>
 
85
            Note: This method only changes soft block. Hard block is controlled
 
86
                  by BIOS or the hardware and there is no way to change the
 
87
                  state of hard block through kernel functions.
 
88
          </doc:para>
 
89
        </doc:description>
 
90
        <doc:permission>
 
91
          This method is restricted to the active session user.
 
92
        </doc:permission>
 
93
      </doc:doc>
 
94
    </method>
 
95
 
 
96
    <!-- ************************************************************ -->
 
97
 
 
98
    <method name="BlockIdx">
 
99
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
100
      <arg type="u" name="index" direction="in">
 
101
        <doc:doc><doc:summary>
 
102
          The index of the device to be blocked/unblocked
 
103
        </doc:summary></doc:doc>
 
104
      </arg>
 
105
      <arg type="b" name="block" direction="in">
 
106
        <doc:doc><doc:summary>
 
107
          TRUE to block the device, FALSE to unblock
 
108
        </doc:summary></doc:doc>
 
109
      </arg>
 
110
      <arg type="b" name="ret" direction="out">
 
111
        <doc:doc><doc:summary>
 
112
          TRUE for success, otherwise FALSE
 
113
        </doc:summary></doc:doc>
 
114
      </arg>
 
115
 
 
116
      <doc:doc>
 
117
        <doc:description>
 
118
          <doc:para>
 
119
            Block or unblock the device by the index.
 
120
          </doc:para>
 
121
          <doc:para>
 
122
            Note: This method only changes soft block. Hard block is controlled
 
123
                  by BIOS or the hardware and there is no way to change the
 
124
                  state of hard block through kernel functions.
 
125
          </doc:para>
 
126
        </doc:description>
 
127
        <doc:permission>
 
128
          This method is restricted to the currently active session user.
 
129
        </doc:permission>
 
130
      </doc:doc>
 
131
    </method>
 
132
 
 
133
    <!-- ************************************************************ -->
 
134
 
 
135
    <method name="EnumerateDevices">
 
136
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
137
      <arg type="ao" name="array" direction="out">
 
138
        <doc:doc><doc:summary>
 
139
          An array of the object pathes for the devices
 
140
        </doc:summary></doc:doc>
 
141
      </arg>
 
142
 
 
143
      <doc:doc>
 
144
        <doc:description>
 
145
          <doc:para>
 
146
            Enumerate all rfkill objects on the system.
 
147
          </doc:para>
 
148
        </doc:description>
 
149
      </doc:doc>
 
150
    </method>
 
151
 
 
152
    <!-- ************************************************************ -->
 
153
 
 
154
    <method name="FlightMode">
 
155
      <arg type="b" name="block" direction="in">
 
156
        <doc:doc><doc:summary>
 
157
          TRUE of flight mode should be enabled, otherwise FALSE
 
158
        </doc:summary></doc:doc>
 
159
      </arg>
 
160
      <arg type="b" name="ret" direction="out">
 
161
        <doc:doc><doc:summary>
 
162
          TRUE if successful, otherwise FALSE
 
163
        </doc:summary></doc:doc>
 
164
      </arg>
 
165
 
 
166
      <doc:doc>
 
167
        <doc:description>
 
168
          <doc:para>
 
169
            Enable or disable flight mode.
 
170
          </doc:para>
 
171
        </doc:description>
 
172
      </doc:doc>
 
173
    </method>
 
174
 
 
175
    <!-- ************************************************************ -->
 
176
 
 
177
    <method name="IsFlightMode">
 
178
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
179
      <arg type="b" name="is_flight_mode" direction="out">
 
180
        <doc:doc><doc:summary>
 
181
          TRUE if flight mode is enabled, otherwise FALSE
 
182
        </doc:summary></doc:doc>
 
183
      </arg>
 
184
 
 
185
      <doc:doc>
 
186
        <doc:description>
 
187
          <doc:para>
 
188
            Get whether flight mode is enabled or not.
 
189
          </doc:para>
 
190
        </doc:description>
 
191
      </doc:doc>
 
192
    </method>
 
193
 
 
194
    <!-- ************************************************************ -->
 
195
 
 
196
    <method name="IsInhibited">
 
197
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
198
      <arg type="b" name="is_inhibited" direction="out">
 
199
        <doc:doc><doc:summary>
 
200
          TRUE if the key control is inhibited, otherwise FALSE
 
201
        </doc:summary></doc:doc>
 
202
      </arg>
 
203
 
 
204
      <doc:doc>
 
205
        <doc:description>
 
206
          <doc:para>
 
207
            Get whether the rfkill key handling function is inhibited or not.
 
208
          </doc:para>
 
209
        </doc:description>
 
210
      </doc:doc>
 
211
    </method>
 
212
 
 
213
    <!-- ************************************************************ -->
 
214
 
 
215
    <method name="Inhibit">
 
216
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
217
      <arg type="s" name="reason" direction="in">
 
218
        <doc:doc><doc:summary>
 
219
          The reason to inhibit the key control
 
220
        </doc:summary></doc:doc>
 
221
      </arg>
 
222
      <arg type="u" name="inhibit_cookie" direction="out">
 
223
        <doc:doc><doc:summary>
 
224
          The cookie
 
225
        </doc:summary></doc:doc>
 
226
      </arg>
 
227
 
 
228
      <doc:doc>
 
229
        <doc:description>
 
230
          <doc:para>
 
231
            Inhibit the rfkill key handling function for the session.
 
232
          </doc:para>
 
233
        </doc:description>
 
234
      </doc:doc>
 
235
    </method>
 
236
 
 
237
    <!-- ************************************************************ -->
 
238
 
 
239
    <method name="Uninhibit">
 
240
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
241
      <arg type="u" name="inhibit_cookie" direction="in">
 
242
        <doc:doc><doc:summary>
 
243
          The cookie
 
244
        </doc:summary></doc:doc>
 
245
      </arg>
 
246
 
 
247
      <doc:doc>
 
248
        <doc:description>
 
249
          <doc:para>
 
250
            Cancel a previous call to <doc:ref type="method" to="org.freedesktop.URfkill.Inhibit">Inhibit()</doc:ref>
 
251
            identified by the cookie.
 
252
          </doc:para>
 
253
        </doc:description>
 
254
      </doc:doc>
 
255
    </method>
 
256
 
 
257
    <!-- ************************************************************ -->
 
258
 
 
259
    <signal name="DeviceAdded">
 
260
      <arg type="o" name="device" direction="out">
 
261
        <doc:doc><doc:summary>
 
262
          The object path for the device that was added
 
263
        </doc:summary></doc:doc>
 
264
      </arg>
 
265
 
 
266
      <doc:doc>
 
267
        <doc:description>
 
268
          <doc:para>
 
269
            Emitted when a device is added.
 
270
          </doc:para>
 
271
        </doc:description>
 
272
      </doc:doc>
 
273
    </signal>
 
274
 
 
275
    <!-- ************************************************************ -->
 
276
 
 
277
    <signal name="DeviceRemoved">
 
278
      <arg type="o" name="device" direction="out">
 
279
        <doc:doc><doc:summary>
 
280
          The object path for the device that was removed
 
281
        </doc:summary></doc:doc>
 
282
      </arg>
 
283
 
 
284
      <doc:doc>
 
285
        <doc:description>
 
286
          <doc:para>
 
287
            Emitted when a device is removed.
 
288
          </doc:para>
 
289
        </doc:description>
 
290
      </doc:doc>
 
291
    </signal>
 
292
 
 
293
    <!-- ************************************************************ -->
 
294
 
 
295
    <signal name="DeviceChanged">
 
296
      <arg type="o" name="device" direction="out">
 
297
        <doc:doc><doc:summary>
 
298
          The object path for the device that was changed
 
299
        </doc:summary></doc:doc>
 
300
      </arg>
 
301
 
 
302
      <doc:doc>
 
303
        <doc:description>
 
304
          <doc:para>
 
305
            Emitted when a device is changed.
 
306
          </doc:para>
 
307
        </doc:description>
 
308
      </doc:doc>
 
309
    </signal>
 
310
 
 
311
    <!-- ************************************************************ -->
 
312
 
 
313
    <signal name="FlightModeChanged">
 
314
      <arg type="b" name="flight_mode" direction="out">
 
315
        <doc:doc><doc:summary>
 
316
          TRUE if flight mode has been enabled, otherwise FALSE
 
317
        </doc:summary></doc:doc>
 
318
      </arg>
 
319
 
 
320
      <doc:doc>
 
321
        <doc:description>
 
322
          <doc:para>
 
323
            Emitted when flight mode is enabled or disabled.
 
324
          </doc:para>
 
325
        </doc:description>
 
326
      </doc:doc>
 
327
    </signal>
 
328
 
 
329
    <!-- ************************************************************ -->
 
330
 
 
331
    <signal name="UrfkeyPressed">
 
332
      <arg type="i" name="keycode" direction="out">
 
333
        <doc:doc><doc:summary>
 
334
          The keycode emitted from the input device
 
335
        </doc:summary></doc:doc>
 
336
      </arg>
 
337
 
 
338
      <doc:doc>
 
339
        <doc:description>
 
340
          <doc:para>
 
341
            Emitted when a rfkill key is pressed. The keycode is defined in
 
342
            &lt;linux/input.h&gt;.
 
343
          </doc:para>
 
344
          <doc:list>
 
345
            <doc:item>
 
346
              <doc:term>237</doc:term><doc:definition>KEY_BLUETOOTH</doc:definition>
 
347
            </doc:item>
 
348
            <doc:item>
 
349
              <doc:term>238</doc:term><doc:definition>KEY_WLAN</doc:definition>
 
350
            </doc:item>
 
351
            <doc:item>
 
352
              <doc:term>239</doc:term><doc:definition>KEY_UWB</doc:definition>
 
353
            </doc:item>
 
354
            <doc:item>
 
355
              <doc:term>246</doc:term><doc:definition>KEY_WIMAX</doc:definition>
 
356
            </doc:item>
 
357
            <doc:item>
 
358
              <doc:term>247</doc:term><doc:definition>KEY_RFKILL</doc:definition>
 
359
            </doc:item>
 
360
          </doc:list>
 
361
        </doc:description>
 
362
      </doc:doc>
 
363
    </signal>
 
364
 
 
365
    <!-- ************************************************************ -->
 
366
 
 
367
    <property name="DaemonVersion" type="s" access="read">
 
368
      <doc:doc>
 
369
        <doc:description>
 
370
          <doc:para>
 
371
            The version the running daemon. e.g. 0.2.0
 
372
          </doc:para>
 
373
        </doc:description>
 
374
      </doc:doc>
 
375
    </property>
 
376
 
 
377
    <property name="KeyControl" type="b" access="read">
 
378
      <doc:doc>
 
379
        <doc:description>
 
380
          <doc:para>
 
381
            Whether the key control is enabled or not
 
382
          </doc:para>
 
383
        </doc:description>
 
384
      </doc:doc>
 
385
    </property>
 
386
 
 
387
  </interface>
 
388
</node>