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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Connection SimplePresence interface: telepathy-glib API Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-client.html" title="Client-side proxies">
<link rel="prev" href="telepathy-glib-connection-requests.html" title="Connection Requests interface">
<link rel="next" href="telepathy-glib-connection-presence.html" title="Connection Presence interface">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#telepathy-glib-connection-simple-presence.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch-client.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="telepathy-glib-connection-requests.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="telepathy-glib-connection-presence.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="telepathy-glib-connection-simple-presence"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-connection-simple-presence.top_of_page"></a>Connection SimplePresence interface</span></h2>
<p>Connection SimplePresence interface — client-side wrappers for the SimplePresence interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="telepathy-glib-connection-simple-presence.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-run-get-presences" title="tp_cli_connection_interface_simple_presence_run_get_presences ()">tp_cli_connection_interface_simple_presence_run_get_presences</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-run-set-presence" title="tp_cli_connection_interface_simple_presence_run_set_presence ()">tp_cli_connection_interface_simple_presence_run_set_presence</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-call-get-presences" title="tp_cli_connection_interface_simple_presence_call_get_presences ()">tp_cli_connection_interface_simple_presence_call_get_presences</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-call-set-presence" title="tp_cli_connection_interface_simple_presence_call_set_presence ()">tp_cli_connection_interface_simple_presence_call_set_presence</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-callback-for-get-presences" title="tp_cli_connection_interface_simple_presence_callback_for_get_presences ()">*tp_cli_connection_interface_simple_presence_callback_for_get_presences</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-callback-for-set-presence" title="tp_cli_connection_interface_simple_presence_callback_for_set_presence ()">*tp_cli_connection_interface_simple_presence_callback_for_set_presence</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="returnvalue">TpProxySignalConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-connect-to-presences-changed" title="tp_cli_connection_interface_simple_presence_connect_to_presences_changed ()">tp_cli_connection_interface_simple_presence_connect_to_presences_changed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-signal-callback-presences-changed" title="tp_cli_connection_interface_simple_presence_signal_callback_presences_changed ()">*tp_cli_connection_interface_simple_presence_signal_callback_presences_changed</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-simple-presence.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <telepathy-glib/telepathy-glib-dbus.h>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-simple-presence.description"></a><h2>Description</h2>
<p>Most instant messaging protocols allow users to advertise their presence
status. In Telepathy, this is represented by the SimplePresence
interface, which lets applications advertise the presence status of the
local user, and query the presence status of their contacts.</p>
<p>This section documents the auto-generated C wrappers for the
SimplePresence interface, used with <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> objects.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-simple-presence.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-run-get-presences"></a><h3>tp_cli_connection_interface_simple_presence_run_get_presences ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_cli_connection_interface_simple_presence_run_get_presences
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">GArray</span> *in_Contacts</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> **out_Presence</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>,
<em class="parameter"><code><span class="type">GMainLoop</span> **loop</code></em>);</pre>
<div class="warning"><p><code class="literal">tp_cli_connection_interface_simple_presence_run_get_presences</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Call the method GetPresences and run the main loop
until it returns. Before calling this method, you must
add a reference to any borrowed objects you need to keep,
and generally ensure that everything is in a consistent
state.</p>
<p>Get presence previously emitted by <tp:member-ref>PresencesChanged</tp:member-ref> for the given contacts. Data is returned in the same structure as the PresencesChanged signal; no additional network requests are made.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-run-get-presences.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>Timeout in milliseconds, or -1 for default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Contacts</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: An array of the contacts whose presence should be obtained.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Presence</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <code class="literal">TRUE</code> is returned: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Presence information in the same format as for the <tp:member-ref>PresencesChanged</tp:member-ref> signal. The returned mapping MUST include an entry for each contact in the method's argument.</p> <p>The definition of the connection presence types Unknown and Offline means that if a connection manager will return Unknown for contacts not on the subscribe list, it MUST delay the reply to this method call until it has found out which contacts are, in fact, on the subscribe list.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to return errors if <code class="literal">FALSE</code>
is returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>loop</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, set before re-entering
the main loop, to point to a <span class="type">GMainLoop</span>
which can be used to cancel this call with
<code class="function">g_main_loop_quit()</code>, causing a return of
<code class="literal">FALSE</code> with <em class="parameter"><code>error</code></em>
set to <a class="link" href="telepathy-glib-proxy.html#TP-DBUS-ERROR-CANCELLED:CAPS"><code class="literal">TP_DBUS_ERROR_CANCELLED</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-run-get-presences.returns"></a><h4>Returns</h4>
<p> TRUE on success, FALSE and sets <em class="parameter"><code>error</code></em>
on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-run-set-presence"></a><h3>tp_cli_connection_interface_simple_presence_run_set_presence ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_cli_connection_interface_simple_presence_run_set_presence
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *in_Status</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *in_Status_Message</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>,
<em class="parameter"><code><span class="type">GMainLoop</span> **loop</code></em>);</pre>
<div class="warning"><p><code class="literal">tp_cli_connection_interface_simple_presence_run_set_presence</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Call the method SetPresence and run the main loop
until it returns. Before calling this method, you must
add a reference to any borrowed objects you need to keep,
and generally ensure that everything is in a consistent
state.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request that the presence status and status message are published for the connection. Changes will be indicated by <tp:member-ref>PresencesChanged</tp:member-ref> signals being emitted.</p> <p>This method may be called on a newly-created connection while it is still in the DISCONNECTED state, to request that when the connection connects, it will do so with the selected status.</p> <p>In DISCONNECTED state the <tp:member-ref>Statuses</tp:member-ref> property will indicate which statuses are allowed to be set while DISCONNECTED (none, if the Connection Manager doesn't allow this). This value MUST NOT be cached, as the set of allowed presences might change upon connecting.</p></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-run-set-presence.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>Timeout in milliseconds, or -1 for default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Status</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The string identifier of the desired status. Possible status identifiers are defined in the <tp:member-ref>Statuses</tp:member-ref> property.</p> <p>Clients MUST NOT set a status whose string value they do not recognise, even if its presence type in Statuses matches what the user requested.</p> <tp:rationale> <p>Suppose a protocol has statuses that include 'phone' (of type BUSY) and 'in-a-meeting' (of type BUSY), but there is no generic 'busy' status.</p> <p>If the user requests &quot;Busy&quot; status from a menu, a client author might be tempted to pick an arbitrary status that has type BUSY. However, on this protocol, neither of the choices would be appropriate, and incorrect information about the user would be conveyed.</p> </tp:rationale> <p>Statuses whose <tp:type>Connection_Presence_Type</tp:type> is Offline, Error or Unknown MUST NOT be passed to this function. Connection managers SHOULD reject these statuses.</p> <tp:rationale> <p>To go offline, call <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">Disconnect</tp:dbus-ref> instead. The &quot;error&quot; and &quot;unknown&quot; statuses make no sense.</p> </tp:rationale></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Status_Message</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: The status message associated with the current status.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to return errors if <code class="literal">FALSE</code>
is returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>loop</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, set before re-entering
the main loop, to point to a <span class="type">GMainLoop</span>
which can be used to cancel this call with
<code class="function">g_main_loop_quit()</code>, causing a return of
<code class="literal">FALSE</code> with <em class="parameter"><code>error</code></em>
set to <a class="link" href="telepathy-glib-proxy.html#TP-DBUS-ERROR-CANCELLED:CAPS"><code class="literal">TP_DBUS_ERROR_CANCELLED</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-run-set-presence.returns"></a><h4>Returns</h4>
<p> TRUE on success, FALSE and sets <em class="parameter"><code>error</code></em>
on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-call-get-presences"></a><h3>tp_cli_connection_interface_simple_presence_call_get_presences ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
tp_cli_connection_interface_simple_presence_call_get_presences
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">GArray</span> *in_Contacts</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-callback-for-get-presences" title="tp_cli_connection_interface_simple_presence_callback_for_get_presences ()"><span class="type">tp_cli_connection_interface_simple_presence_callback_for_get_presences</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Start a GetPresences method call.</p>
<p>Get presence previously emitted by <tp:member-ref>PresencesChanged</tp:member-ref> for the given contacts. Data is returned in the same structure as the PresencesChanged signal; no additional network requests are made.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-call-get-presences.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>the timeout in milliseconds, or -1 to use the
default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Contacts</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: An array of the contacts whose presence should be obtained.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the method call succeeds or fails;
may be <code class="literal">NULL</code> to make a "fire and forget" call with no
reply tracking</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data passed to the callback;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, a <span class="type">GObject</span> which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be <code class="literal">NULL</code> if
<em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-call-get-presences.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
progress. It is borrowed from the object, and will become
invalid when the callback is called, the call is
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-call-set-presence"></a><h3>tp_cli_connection_interface_simple_presence_call_set_presence ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
tp_cli_connection_interface_simple_presence_call_set_presence
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *in_Status</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *in_Status_Message</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-callback-for-set-presence" title="tp_cli_connection_interface_simple_presence_callback_for_set_presence ()"><span class="type">tp_cli_connection_interface_simple_presence_callback_for_set_presence</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Start a SetPresence method call.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request that the presence status and status message are published for the connection. Changes will be indicated by <tp:member-ref>PresencesChanged</tp:member-ref> signals being emitted.</p> <p>This method may be called on a newly-created connection while it is still in the DISCONNECTED state, to request that when the connection connects, it will do so with the selected status.</p> <p>In DISCONNECTED state the <tp:member-ref>Statuses</tp:member-ref> property will indicate which statuses are allowed to be set while DISCONNECTED (none, if the Connection Manager doesn't allow this). This value MUST NOT be cached, as the set of allowed presences might change upon connecting.</p></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-call-set-presence.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>the timeout in milliseconds, or -1 to use the
default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Status</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The string identifier of the desired status. Possible status identifiers are defined in the <tp:member-ref>Statuses</tp:member-ref> property.</p> <p>Clients MUST NOT set a status whose string value they do not recognise, even if its presence type in Statuses matches what the user requested.</p> <tp:rationale> <p>Suppose a protocol has statuses that include 'phone' (of type BUSY) and 'in-a-meeting' (of type BUSY), but there is no generic 'busy' status.</p> <p>If the user requests &quot;Busy&quot; status from a menu, a client author might be tempted to pick an arbitrary status that has type BUSY. However, on this protocol, neither of the choices would be appropriate, and incorrect information about the user would be conveyed.</p> </tp:rationale> <p>Statuses whose <tp:type>Connection_Presence_Type</tp:type> is Offline, Error or Unknown MUST NOT be passed to this function. Connection managers SHOULD reject these statuses.</p> <tp:rationale> <p>To go offline, call <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">Disconnect</tp:dbus-ref> instead. The &quot;error&quot; and &quot;unknown&quot; statuses make no sense.</p> </tp:rationale></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Status_Message</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: The status message associated with the current status.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the method call succeeds or fails;
may be <code class="literal">NULL</code> to make a "fire and forget" call with no
reply tracking</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data passed to the callback;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, a <span class="type">GObject</span> which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be <code class="literal">NULL</code> if
<em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-call-set-presence.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
progress. It is borrowed from the object, and will become
invalid when the callback is called, the call is
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-callback-for-get-presences"></a><h3>tp_cli_connection_interface_simple_presence_callback_for_get_presences ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_simple_presence_callback_for_get_presences<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Presence</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Signature of the callback called when a GetPresences method call
succeeds or fails.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-callback-for-get-presences.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>the proxy on which the call was made</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Presence</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Presence information in the same format as for the <tp:member-ref>PresencesChanged</tp:member-ref> signal. The returned mapping MUST include an entry for each contact in the method's argument.</p> <p>The definition of the connection presence types Unknown and Offline means that if a connection manager will return Unknown for contacts not on the subscribe list, it MUST delay the reply to this method call until it has found out which contacts are, in fact, on the subscribe list.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code> on success, or an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>user-supplied object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-callback-for-set-presence"></a><h3>tp_cli_connection_interface_simple_presence_callback_for_set_presence ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_simple_presence_callback_for_set_presence<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Signature of the callback called when a SetPresence method call
succeeds or fails.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-callback-for-set-presence.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>the proxy on which the call was made</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code> on success, or an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>user-supplied object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-connect-to-presences-changed"></a><h3>tp_cli_connection_interface_simple_presence_connect_to_presences_changed ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="returnvalue">TpProxySignalConnection</span></a> *
tp_cli_connection_interface_simple_presence_connect_to_presences_changed
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-signal-callback-presences-changed" title="tp_cli_connection_interface_simple_presence_signal_callback_presences_changed ()"><span class="type">tp_cli_connection_interface_simple_presence_signal_callback_presences_changed</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Connect a handler to the signal PresencesChanged.</p>
<p>This signal should be emitted when your own presence has been changed, or the presence of the member of any of the connection's channels has been changed.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-connect-to-presences-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>Callback to be called when the signal is
received</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-supplied data for the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>A <span class="type">GObject</span> which will be weakly referenced;
if it is destroyed, this callback will automatically be
disconnected</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to raise an error if <code class="literal">NULL</code> is
returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-connect-to-presences-changed.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="type">TpProxySignalConnection</span></a> containing all of the
above, which can be used to disconnect the signal; or
<code class="literal">NULL</code> if the proxy does not have the desired interface
or has become invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-simple-presence-signal-callback-presences-changed"></a><h3>tp_cli_connection_interface_simple_presence_signal_callback_presences_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_simple_presence_signal_callback_presences_changed<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *arg_Presence</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Represents the signature of a callback for the signal PresencesChanged.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-simple-presence-signal-callback-presences-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>The proxy on which <a class="link" href="telepathy-glib-connection-simple-presence.html#tp-cli-connection-interface-simple-presence-connect-to-presences-changed" title="tp_cli_connection_interface_simple_presence_connect_to_presences_changed ()"><code class="function">tp_cli_connection_interface_simple_presence_connect_to_presences_changed()</code></a>
was called</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg_Presence</p></td>
<td class="parameter_description"><p>A dictionary of contact handles mapped to the status, presence type and status message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>User-supplied weakly referenced object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-simple-presence.see-also"></a><h2>See Also</h2>
<p><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>
|
