blob: 63a24bdf7204b9d5566bb1a092d5cc0a68182f79 (
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>$interface.really_short_name — $spec.title</title>
<link rel="stylesheet" href="style.css" type="text/css"/>
<link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
<script src="jquery.min.js"></script>
<script src="magic.js"></script>
</head>
<body>
<div class="header">
<h1>Interface <abbr title='$interface.name'>$interface.short_name</abbr></h1>
<a href="index.html">Interface Index</a>
(<a href="interfaces.html">Compact</a>)
| <a href="#summary">Summary</a>
#if $interface.client_interests: | <a href="#client-interests">Client Interests</a>
#if $interface.docstring: | <a href="#description">Description</a>
#if $interface.methods: | <a href="#methods">Methods</a>
#if $interface.signals: | <a href="#signals">Signals</a>
#if $interface.properties: | <a href="#properties">Properties</a>
#if $interface.tpproperties: | <a href="#tpproperties">Telepathy Properties</a>
#if $interface.contact_attributes: | <a href="#contact-attributes">Contact Attributes</a>
#if $interface.handler_capability_tokens: | <a href="#handler-capability-tokens">Handler Capability Tokens</a>
#if $interface.types: | <a href="#types">Types</a>
</div>
<div class="main">
#if $interface.methods or $interface.signals or $interface.properties or $interface.types or $interface.tpproperties
<div class="summary">
<a name="summary"></a>
#if $interface.client_interests
<h3>Client Interests</h3>
<table class="summary">
#for $interest in $interface.client_interests
<td><a href="$interest.get_url()">$interest.name</a></td>
#end for
</table>
#end if
#if $interface.methods
<h3>Methods</h3>
<table class="summary">
#for $method in $interface.methods
#if $method.is_deprecated
<tr class="deprecated">
#else
<tr>
#end if
<td><a href="$method.get_url()">$method.short_name</a></td>
<td>($method.get_in_args())</td>
<td>→</td>
<td>$method.get_out_args()</td>
<td>
#if $method.is_deprecated: (deprecated)
</td>
</tr>
#end for
</table>
#end if
#if $interface.signals
<h3>Signals</h3>
<table class="summary">
#for $signal in $interface.signals
#if $signal.is_deprecated
<tr class="deprecated">
#else
<tr>
#end if
<td><a href="$signal.get_url()">$signal.short_name</a></td>
<td>($signal.get_args())</td>
<td>
#if $signal.is_deprecated: (deprecated)
</td>
</tr>
#end for
</table>
#end if
#if $interface.properties
<h3>Properties</h3>
<table class="summary">
#for $property in $interface.properties
#if $property.is_deprecated
<tr class="deprecated">
#else
<tr>
#end if
<td><a href="$property.get_url()">$property.short_name</a></td>
<td>
$property.dbus_type
#if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
</td>
<td>$property.get_access()</td>
<td>$property.get_flag_summary()</td>
<td>
#if $property.is_deprecated: (deprecated)
</td>
</tr>
#end for
</table>
#end if
#if $interface.tpproperties
<h3>Telepathy Properties</h3>
<table class="summary">
#for $property in $interface.tpproperties
<tr class="deprecated">
<td><a href="$property.get_url()">$property.short_name</a></td>
<td>
$property.dbus_type
#if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
</td>
</tr>
#end for
</table>
#end if
#if $interface.contact_attributes
<h3>Contact Attributes</h3>
<table class="summary">
#for $token in $interface.contact_attributes
<tr class="contact-attribute">
<td><a href="$token.get_url()">$token.name</a></td>
<td>
$token.dbus_type
#if $token.type: (<a href="$token.get_type_url()" title="$token.get_type_title()">$token.get_type().short_name</a>)
</td>
</tr>
#end for
</table>
#end if
#if $interface.handler_capability_tokens
<h3>Handler Capability Tokens</h3>
<table class="summary">
#for $token in $interface.handler_capability_tokens
<tr class="handler-capability-token">
<td><a href="$token.get_url()">$token.name</a>
#if $token.is_family
(etc.)
#end if
</td>
<td>
</td>
</tr>
#end for
</table>
#end if
#if $interface.types
<h3>Types</h3>
<table class="summary">
#for $type in $interface.types
#if type.is_deprecated
<tr class="deprecated">
#else
<tr>
#end if
<td><a href="$type.get_url()">$type.short_name</a></td>
<td>$type.get_type_name()</td>
<td>$type.dbus_type</td>
<td>
#if $type.is_deprecated: (deprecated)
</td>
</tr>
#end for
</table>
#end if
</div>
#end if
#if $interface.causes_havoc
<div class="annotation havoc"><span class="warning">WARNING:</span>
This interface is $interface.causes_havoc and is likely to cause havoc
to your API/ABI if bindings are generated. Do not include this interface
in libraries that care about compatibility.
</div>
#end if
$interface.get_added()
$interface.get_changed()
$interface.get_deprecated()
#if $interface.requires or $interface.xor_requires
<div class="requires">
Objects implementing this interface must also implement:
<ul>
#for $req in $interface.get_xor_requires()
<li>
#echo " <strong>or</strong> ".join(['<a href="' + x.get_url() + '''"
title="''' + x.get_title() + '">' + x.name + '</a>' for x in req])
</li>
#end for
#for $req in $interface.get_requires()
<li><a href="$req.get_url()" title="$req.get_title()">$req.name</a></li>
#end for
</ul>
</div>
#end if
#if $interface.docstring
<a name="description"></a>
<h3>Description</h3>
$interface.get_docstring()
#end if
#if $interface.client_interests
<div class="outset client-interests client-interest">
<a name="client-interests"></a>
<h1>Client Interests</h1>
<div>
Set using the
<a href="Connection.html#org.freedesktop.Telepathy.Connection.AddClientInterest">AddClientInterest</a> and
<a href="Connection.html#org.freedesktop.Telepathy.Connection.RemoveClientInterest">RemoveClientInterest</a> methods.
</div>
#for $interest in $interface.client_interests
<div class="inset client-interest">
<a name="$interest.get_anchor()"></a>
<span class="permalink">(<a href="$interest.get_url()">Permalink</a>)</span>
<h2>$interest.name</h2>
$interest.get_docstring()
</div>
#end for
</div>
#end if
#if $interface.methods
<div class="outset methods method">
<a name="methods"></a>
<h1>Methods</h1>
#for $method in $interface.methods
<div class="inset method">
<a name="$method.get_anchor()"></a>
<span class="permalink">(<a href="$method.get_url()">Permalink</a>)</span>
<h2>$method.short_name ($method.get_in_args()) → $method.get_out_args()</h2>
$method.get_added()
$method.get_changed()
$method.get_deprecated()
#if $method.no_reply
<div class="annotation no-reply">The caller should not expect a reply when calling this method.</div>
#end if
#if $method.in_args
<div class="indent">
<h3>Parameters</h3>
<ul>
#for $arg in $method.in_args
<li>
$arg.short_name — $arg.dbus_type
#if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>)
</li>
$arg.get_added()
$arg.get_changed()
$arg.get_deprecated()
$arg.get_docstring()
#end for
</ul>
</div>
#end if
#if $method.out_args
<div class="indent">
<h3>Returns</h3>
<ul>
#for $arg in $method.out_args
<li>
$arg.short_name — $arg.dbus_type
#if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>)
</li>
$arg.get_added()
$arg.get_changed()
$arg.get_deprecated()
$arg.get_docstring()
#end for
</ul>
</div>
#end if
$method.get_docstring()
#if $method.possible_errors
<hr/>
<div class="indent">
<h3>Possible Errors</h3>
<ul>
#for $error in $method.possible_errors
<li><a href="$error.get_url()" title="$error.get_title()">$error.get_error().short_name</a></li>
$error.get_added()
$error.get_changed()
$error.get_deprecated()
$error.get_docstring()
#end for
</ul>
</div>
#end if
</div>
#end for
</div>
#end if
#if $interface.signals
<div class="outset signals signal">
<a name="signals"></a>
<h1>Signals</h1>
#for $signal in $interface.signals
<div class="inset signal">
<a name="$signal.get_anchor()"></a>
<span class="permalink">(<a href="$signal.get_url()">Permalink</a>)</span>
<h2>$signal.short_name ($signal.get_args())</h2>
$signal.get_added()
$signal.get_changed()
$signal.get_deprecated()
#if $signal.args
<div class="indent">
<h3>Parameters</h3>
<ul>
#for $arg in $signal.args
<li>
$arg.short_name — $arg.dbus_type
#if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>)
</li>
$arg.get_added()
$arg.get_changed()
$arg.get_deprecated()
$arg.get_docstring()
#end for
</ul>
</div>
#end if
$signal.get_docstring()
</div>
#end for
</div>
#end if
#if $interface.properties
<div class="outset properties property">
<a name="properties"></a>
<h1>Properties</h1>
<div>
Accessed using the <a
href="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties">org.freedesktop.DBus.Properties</a>
interface.
</div>
#for $property in $interface.properties
<div class="inset property">
<a name="$property.get_anchor()"></a>
<span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span>
<h2>
$property.short_name — $property.dbus_type
#if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
</h2>
<div class="access">$property.get_access()</div>
#if $property.sometimes_immutable:
<div class="annotation immutable">Depending on the protocol, this
property may be <strong>immutable</strong> which means that it can never
#if $interface.is_channel_related:
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.NewChannels">NewChannels</a>
signals.
#else
change.
#end if
</div>
#elif $property.immutable:
<div class="annotation immutable">This property is
<strong>immutable</strong> which means that it can never
#if $interface.is_channel_related:
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.NewChannels">NewChannels</a>
signals.
#else
change.
#end if
</div>
#end if
#if $property.sometimes_requestable:
<div class="annotation requestable">Depending on the protocol, this
property may be <strong>requestable</strong>, which means that it may be
allowed in the properties hash of a channel request such as in the
<a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.CreateChannel">CreateChannel</a>
and
<a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.EnsureChannel">EnsureChannel</a>
methods
on <a href="Connection_Interface_Requests.html">Requests</a>
and <a href="Channel_Dispatcher.html">ChannelDispatcher</a>.
If supported on this protocol, the property should appear in either the
Fixed_Properties or Allowed_Properties of
a <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.RequestableChannelClasses">RequestableChannelClass</a>
advertised by the CM.</div>
#elif $property.requestable:
<div class="annotation requestable">This property
is <strong>requestable</strong>, which means that it is allowed
in the properties hash of a channel request such as in the
<a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.CreateChannel">CreateChannel</a>
and
<a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.EnsureChannel">EnsureChannel</a>
methods
on <a href="Connection_Interface_Requests.html">Requests</a>
and <a href="Channel_Dispatcher.html">ChannelDispatcher</a>.
The property should also appear in either the Fixed_Properties
or Allowed_Properties of
a <a href="Connection_Interface_Requests.html#org.freedesktop.Telepathy.Connection.Interface.Requests.RequestableChannelClasses">RequestableChannelClass</a>
advertised by the CM.</div>
#end if
$property.get_added()
$property.get_changed()
$property.get_deprecated()
#if not $property.immutable:
#if $property.emits_changed == $property.EMITS_CHANGED_UPDATES
<div class="annotation emits-changed emits-changed-updates">
When this property changes, the
<code>org.freedesktop.DBus.Properties.PropertiesChanged</code>
signal is emitted with the new value.
</div>
#elif $property.emits_changed == $property.EMITS_CHANGED_INVALIDATES
<div class="annotation emits-changed emits-changed-invalidates">
When this property changes, the
<code>org.freedesktop.DBus.Properties.PropertiesChanged</code>
signal is emitted, but the new value is not sent.
</div>
#elif $property.emits_changed == $property.EMITS_CHANGED_NONE
<div class="annotation emits-changed emits-changed-none">
The <code>org.freedesktop.DBus.Properties.PropertiesChanged</code>
signal is <strong>not</strong> emitted when this property changes.
</div>
#end if
#end if
#if $property.is_connection_parameter:
<div class="annotation connection-parameter">
<p><span class='note'>Note:</span> Connections implementing this
property SHOULD provide a corresponding parameter named
<tt>$property.name</tt> with the <a
href="Connection_Manager.html#Conn_Mgr_Param_Flags">DBus_Property</a>
flag. Clients SHOULD update this property by
calling <a
href="Account.html#org.freedesktop.Telepathy.Account.UpdateParameters">UpdateParameters</a>
on the relevant <a href="Account.html">Account</a> rather than
setting the property directly; change notification is via <a
href="Account.html#org.freedesktop.Telepathy.Account.AccountPropertyChanged">AccountPropertyChanged</a>.
</p>
</div>
#end if
$property.get_docstring()
</div>
#end for
</div>
#end if
#if $interface.tpproperties
<div class="outset tpproperties tpproperty">
<a name="tpproperties"></a>
<h1>Telepathy Properties</h1>
<div>
Accessed using the <a
href="Properties_Interface.html">org.freedesktop.Telepathy.Properties</a>
interface.
</div>
#for $property in $interface.tpproperties
<div class="inset tpproperty">
<a name="$property.get_anchor()"></a>
<span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span>
<h2>
$property.short_name — $property.dbus_type
#if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
</h2>
$property.get_added()
$property.get_changed()
$property.get_deprecated()
$property.get_docstring()
</div>
#end for
</div>
#end if
#if $interface.contact_attributes
<div class="outset contact-attributes">
<a name="contact-attributes"></a>
<h1>Contact Attributes</h1>
<div>
Attributes that a contact can have, accessed with the
org.freedesktop.Telepathy.Connection.Interface.Contacts interface.
</div>
#for $token in $interface.contact_attributes
<div class="inset contact-attribute">
<a name="$token.get_anchor()"></a>
<span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span>
<h2>
$token.name — $token.dbus_type
#if $token.type: (<a href="$token.get_type_url()" title="$token.get_type_title()">$token.get_type().short_name</a>)
</h2>
$token.get_added()
$token.get_changed()
$token.get_deprecated()
$token.get_docstring()
</div>
#end for
</div>
#end if
#if $interface.handler_capability_tokens
<div class="outset handler-capability-tokens">
<a name="handler-capability-tokens"></a>
<h1>Handler Capability Tokens</h1>
<div>
Tokens representing capabilities that a Client.Handler can have.
</div>
#for $token in $interface.handler_capability_tokens
<div class="inset handler-capability-token">
<a name="$token.get_anchor()"></a>
<span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span>
<h2>
$token.name
#if $token.is_family
(etc.)
#end if
</h2>
$token.get_added()
$token.get_changed()
$token.get_deprecated()
$token.get_docstring()
</div>
#end for
</div>
#end if
#if $interface.types
<div class="outset types type">
<a name="types"></a>
<h1>Types</h1>
#for $type in $interface.types
<div class="inset type">
<a name="$type.get_anchor()"></a>
<span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span>
<h2>
$type.short_name — $type.dbus_type
</h2>
$type.get_added()
$type.get_changed()
$type.get_deprecated()
$type.get_docstring()
$type.get_breakdown()
</div>
#end for
</div>
#end if
</div>
</body>
</html>
|
