← Back to branch summary

~ubuntu-branches/ubuntu/precise/telepathy-mission-control-5/precise

« back to all changes in this revision

Viewing changes to doc/reference/libmcclient/tmpl/mc-account.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Jonny Lamb
  • Date: 2011-05-18 14:05:17 UTC
  • mto: (0.11.4)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: james.westby@ubuntu.com-20110518140517-kxvxkktt953tk3sj
Import upstream version 5.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/libmcclient/tmpl/mc-account.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
mc-account
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
 
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
 
10
 
</para>
11
 
 
12
 
<!-- ##### SECTION See_Also ##### -->
13
 
<para>
14
 
 
15
 
</para>
16
 
 
17
 
<!-- ##### SECTION Stability_Level ##### -->
18
 
 
19
 
 
20
 
<!-- ##### SECTION Image ##### -->
21
 
 
22
 
 
23
 
<!-- ##### STRUCT McAccount ##### -->
24
 
<para>
25
 
 
26
 
</para>
27
 
 
28
 
@parent: 
29
 
@name: 
30
 
@manager_name: 
31
 
@protocol_name: 
32
 
 
33
 
<!-- ##### SIGNAL McAccount::avatar-changed ##### -->
34
 
<para>
35
 
 
36
 
</para>
37
 
 
38
 
@mcaccount: the object which received the signal.
39
 
@arg1: 
40
 
@arg2: 
41
 
 
42
 
<!-- ##### SIGNAL McAccount::channel-count-changed ##### -->
43
 
<para>
44
 
 
45
 
</para>
46
 
 
47
 
@mcaccount: the object which received the signal.
48
 
@arg1: 
49
 
 
50
 
<!-- ##### SIGNAL McAccount::connection-status-changed ##### -->
51
 
<para>
52
 
 
53
 
</para>
54
 
 
55
 
@mcaccount: the object which received the signal.
56
 
@arg1: 
57
 
@arg2: 
58
 
 
59
 
<!-- ##### SIGNAL McAccount::flag-changed ##### -->
60
 
<para>
61
 
 
62
 
</para>
63
 
 
64
 
@mcaccount: the object which received the signal.
65
 
@arg1: 
66
 
@arg2: 
67
 
 
68
 
<!-- ##### SIGNAL McAccount::parameters-changed ##### -->
69
 
<para>
70
 
 
71
 
</para>
72
 
 
73
 
@mcaccount: the object which received the signal.
74
 
@arg1: 
75
 
@arg2: 
76
 
 
77
 
<!-- ##### SIGNAL McAccount::presence-changed ##### -->
78
 
<para>
79
 
 
80
 
</para>
81
 
 
82
 
@mcaccount: the object which received the signal.
83
 
@arg1: 
84
 
@arg2: 
85
 
@arg3: 
86
 
@arg4: 
87
 
 
88
 
<!-- ##### SIGNAL McAccount::string-changed ##### -->
89
 
<para>
90
 
 
91
 
</para>
92
 
 
93
 
@mcaccount: the object which received the signal.
94
 
@arg1: 
95
 
@arg2: 
96
 
 
97
 
<!-- ##### STRUCT McAccountClass ##### -->
98
 
<para>
99
 
 
100
 
</para>
101
 
 
102
 
 
103
 
<!-- ##### FUNCTION mc_account_new ##### -->
104
 
<para>
105
 
 
106
 
</para>
107
 
 
108
 
@dbus: 
109
 
@object_path: 
110
 
@Returns: 
111
 
 
112
 
 
113
 
<!-- ##### USER_FUNCTION McAccountWhenReadyCb ##### -->
114
 
<para>
115
 
 
116
 
</para>
117
 
 
118
 
@account: 
119
 
@error: 
120
 
@user_data: 
121
 
 
122
 
 
123
 
<!-- ##### FUNCTION mc_account_call_when_ready ##### -->
124
 
<para>
125
 
 
126
 
</para>
127
 
 
128
 
@account: 
129
 
@callback: 
130
 
@user_data: 
131
 
 
132
 
 
133
 
<!-- ##### USER_FUNCTION McAccountWhenReadyObjectCb ##### -->
134
 
<para>
135
 
 
136
 
</para>
137
 
 
138
 
@account: 
139
 
@error: 
140
 
@user_data: 
141
 
@weak_object: 
142
 
 
143
 
 
144
 
<!-- ##### FUNCTION mc_account_call_when_iface_ready ##### -->
145
 
<para>
146
 
 
147
 
</para>
148
 
 
149
 
@account: 
150
 
@interface: 
151
 
@callback: 
152
 
@user_data: 
153
 
@destroy: 
154
 
@weak_object: 
155
 
 
156
 
 
157
 
<!-- ##### FUNCTION mc_account_call_when_all_ready ##### -->
158
 
<para>
159
 
 
160
 
</para>
161
 
 
162
 
@account: 
163
 
@callback: 
164
 
@user_data: 
165
 
@destroy: 
166
 
@weak_object: 
167
 
@Varargs: 
168
 
 
169
 
 
170
 
<!-- ##### FUNCTION mc_account_get_display_name ##### -->
171
 
<para>
172
 
 
173
 
</para>
174
 
 
175
 
@account: 
176
 
@Returns: 
177
 
 
178
 
 
179
 
<!-- ##### FUNCTION mc_account_get_icon ##### -->
180
 
<para>
181
 
 
182
 
</para>
183
 
 
184
 
@account: 
185
 
@Returns: 
186
 
 
187
 
 
188
 
<!-- ##### FUNCTION mc_account_is_valid ##### -->
189
 
<para>
190
 
 
191
 
</para>
192
 
 
193
 
@account: 
194
 
@Returns: 
195
 
 
196
 
 
197
 
<!-- ##### FUNCTION mc_account_is_enabled ##### -->
198
 
<para>
199
 
 
200
 
</para>
201
 
 
202
 
@account: 
203
 
@Returns: 
204
 
 
205
 
 
206
 
<!-- ##### FUNCTION mc_account_has_been_online ##### -->
207
 
<para>
208
 
 
209
 
</para>
210
 
 
211
 
@account: 
212
 
@Returns: 
213
 
 
214
 
 
215
 
<!-- ##### FUNCTION mc_account_connects_automatically ##### -->
216
 
<para>
217
 
 
218
 
</para>
219
 
 
220
 
@account: 
221
 
@Returns: 
222
 
 
223
 
 
224
 
<!-- ##### FUNCTION mc_account_get_nickname ##### -->
225
 
<para>
226
 
 
227
 
</para>
228
 
 
229
 
@account: 
230
 
@Returns: 
231
 
 
232
 
 
233
 
<!-- ##### FUNCTION mc_account_get_parameters ##### -->
234
 
<para>
235
 
 
236
 
</para>
237
 
 
238
 
@account: 
239
 
@Returns: 
240
 
 
241
 
 
242
 
<!-- ##### FUNCTION mc_account_get_automatic_presence ##### -->
243
 
<para>
244
 
 
245
 
</para>
246
 
 
247
 
@account: 
248
 
@type: 
249
 
@status: 
250
 
@message: 
251
 
 
252
 
 
253
 
<!-- ##### FUNCTION mc_account_get_connection_path ##### -->
254
 
<para>
255
 
 
256
 
</para>
257
 
 
258
 
@account: 
259
 
@Returns: 
260
 
 
261
 
 
262
 
<!-- ##### FUNCTION mc_account_get_connection_name ##### -->
263
 
<para>
264
 
 
265
 
</para>
266
 
 
267
 
@account: 
268
 
@Returns: 
269
 
 
270
 
 
271
 
<!-- ##### FUNCTION mc_account_get_connection_status ##### -->
272
 
<para>
273
 
 
274
 
</para>
275
 
 
276
 
@account: 
277
 
@Returns: 
278
 
 
279
 
 
280
 
<!-- ##### FUNCTION mc_account_get_connection_status_reason ##### -->
281
 
<para>
282
 
 
283
 
</para>
284
 
 
285
 
@account: 
286
 
@Returns: 
287
 
 
288
 
 
289
 
<!-- ##### FUNCTION mc_account_get_current_presence ##### -->
290
 
<para>
291
 
 
292
 
</para>
293
 
 
294
 
@account: 
295
 
@type: 
296
 
@status: 
297
 
@message: 
298
 
 
299
 
 
300
 
<!-- ##### FUNCTION mc_account_get_requested_presence ##### -->
301
 
<para>
302
 
 
303
 
</para>
304
 
 
305
 
@account: 
306
 
@type: 
307
 
@status: 
308
 
@message: 
309
 
 
310
 
 
311
 
<!-- ##### FUNCTION mc_account_get_normalized_name ##### -->
312
 
<para>
313
 
 
314
 
</para>
315
 
 
316
 
@account: 
317
 
@Returns: 
318
 
 
319
 
 
320
 
<!-- ##### FUNCTION mc_account_set_display_name ##### -->
321
 
<para>
322
 
 
323
 
</para>
324
 
 
325
 
@account: 
326
 
@display_name: 
327
 
@callback: 
328
 
@user_data: 
329
 
@destroy: 
330
 
@weak_object: 
331
 
@Returns: 
332
 
 
333
 
 
334
 
<!-- ##### FUNCTION mc_account_set_icon ##### -->
335
 
<para>
336
 
 
337
 
</para>
338
 
 
339
 
@account: 
340
 
@icon: 
341
 
@callback: 
342
 
@user_data: 
343
 
@destroy: 
344
 
@weak_object: 
345
 
@Returns: 
346
 
 
347
 
 
348
 
<!-- ##### FUNCTION mc_account_set_enabled ##### -->
349
 
<para>
350
 
 
351
 
</para>
352
 
 
353
 
@account: 
354
 
@enabled: 
355
 
@callback: 
356
 
@user_data: 
357
 
@destroy: 
358
 
@weak_object: 
359
 
@Returns: 
360
 
 
361
 
 
362
 
<!-- ##### FUNCTION mc_account_set_connect_automatically ##### -->
363
 
<para>
364
 
 
365
 
</para>
366
 
 
367
 
@account: 
368
 
@connect: 
369
 
@callback: 
370
 
@user_data: 
371
 
@destroy: 
372
 
@weak_object: 
373
 
@Returns: 
374
 
 
375
 
 
376
 
<!-- ##### FUNCTION mc_account_set_nickname ##### -->
377
 
<para>
378
 
 
379
 
</para>
380
 
 
381
 
@account: 
382
 
@nickname: 
383
 
@callback: 
384
 
@user_data: 
385
 
@destroy: 
386
 
@weak_object: 
387
 
@Returns: 
388
 
 
389
 
 
390
 
<!-- ##### FUNCTION mc_account_set_automatic_presence ##### -->
391
 
<para>
392
 
 
393
 
</para>
394
 
 
395
 
@account: 
396
 
@type: 
397
 
@status: 
398
 
@message: 
399
 
@callback: 
400
 
@user_data: 
401
 
@destroy: 
402
 
@weak_object: 
403
 
@Returns: 
404
 
 
405
 
 
406
 
<!-- ##### FUNCTION mc_account_set_requested_presence ##### -->
407
 
<para>
408
 
 
409
 
</para>
410
 
 
411
 
@account: 
412
 
@type: 
413
 
@status: 
414
 
@message: 
415
 
@callback: 
416
 
@user_data: 
417
 
@destroy: 
418
 
@weak_object: 
419
 
@Returns: 
420
 
 
421
 
 
422
 
<!-- ##### FUNCTION mc_account_avatar_call_when_ready ##### -->
423
 
<para>
424
 
 
425
 
</para>
426
 
 
427
 
@account: 
428
 
@callback: 
429
 
@user_data: 
430
 
 
431
 
 
432
 
<!-- ##### FUNCTION mc_account_avatar_get ##### -->
433
 
<para>
434
 
 
435
 
</para>
436
 
 
437
 
@account: 
438
 
@avatar: 
439
 
@length: 
440
 
@mime_type: 
441
 
 
442
 
 
443
 
<!-- ##### FUNCTION mc_account_avatar_set ##### -->
444
 
<para>
445
 
 
446
 
</para>
447
 
 
448
 
@account: 
449
 
@avatar: 
450
 
@len: 
451
 
@mime_type: 
452
 
@callback: 
453
 
@user_data: 
454
 
@destroy: 
455
 
@weak_object: 
456
 
@Returns: 
457
 
 
458
 
 
459
 
<!-- ##### FUNCTION mc_account_compat_call_when_ready ##### -->
460
 
<para>
461
 
 
462
 
</para>
463
 
 
464
 
@account: 
465
 
@callback: 
466
 
@user_data: 
467
 
 
468
 
 
469
 
<!-- ##### FUNCTION mc_account_compat_get_profile ##### -->
470
 
<para>
471
 
 
472
 
</para>
473
 
 
474
 
@account: 
475
 
@Returns: 
476
 
 
477
 
 
478
 
<!-- ##### FUNCTION mc_account_compat_get_avatar_file ##### -->
479
 
<para>
480
 
 
481
 
</para>
482
 
 
483
 
@account: 
484
 
@Returns: 
485
 
 
486
 
 
487
 
<!-- ##### FUNCTION mc_account_compat_set_profile ##### -->
488
 
<para>
489
 
 
490
 
</para>
491
 
 
492
 
@account: 
493
 
@profile: 
494
 
@callback: 
495
 
@user_data: 
496
 
@destroy: 
497
 
@weak_object: 
498
 
@Returns: 
499
 
 
500
 
 
501
 
<!-- ##### FUNCTION mc_account_compat_set_secondary_vcard_fields ##### -->
502
 
<para>
503
 
 
504
 
</para>
505
 
 
506
 
@account: 
507
 
@fields: 
508
 
@callback: 
509
 
@user_data: 
510
 
@destroy: 
511
 
@weak_object: 
512
 
@Returns: 
513
 
 
514
 
 
515
 
<!-- ##### FUNCTION mc_account_conditions_call_when_ready ##### -->
516
 
<para>
517
 
 
518
 
</para>
519
 
 
520
 
@account: 
521
 
@callback: 
522
 
@user_data: 
523
 
 
524
 
 
525
 
<!-- ##### FUNCTION mc_account_conditions_get ##### -->
526
 
<para>
527
 
 
528
 
</para>
529
 
 
530
 
@account: 
531
 
@Returns: 
532
 
 
533
 
 
534
 
<!-- ##### FUNCTION mc_account_conditions_set ##### -->
535
 
<para>
536
 
 
537
 
</para>
538
 
 
539
 
@account: 
540
 
@conditions: 
541
 
@callback: 
542
 
@user_data: 
543
 
@destroy: 
544
 
@weak_object: 
545
 
@Returns: 
546
 
 
547
 
 
548
 
<!-- ##### STRUCT McAccountChannelrequestData ##### -->
549
 
<para>
550
 
 
551
 
</para>
552
 
 
553
 
@_mask: 
554
 
@fld_channel_type: 
555
 
@fld_target_handle: 
556
 
@fld_target_handle_type: 
557
 
@fld_target_id: 
558
 
 
559
 
<!-- ##### ENUM McAccountChannelrequestEvent ##### -->
560
 
<para>
561
 
 
562
 
</para>
563
 
 
564
 
@MC_ACCOUNT_CR_SUCCEEDED: 
565
 
@MC_ACCOUNT_CR_FAILED: 
566
 
@MC_ACCOUNT_CR_CANCELLED: 
567
 
 
568
 
<!-- ##### USER_FUNCTION McAccountChannelrequestCb ##### -->
569
 
<para>
570
 
 
571
 
</para>
572
 
 
573
 
@account: 
574
 
@request_id: 
575
 
@event: 
576
 
@user_data: 
577
 
@weak_object: 
578
 
 
579
 
 
580
 
<!-- ##### ENUM McAccountChannelrequestFlags ##### -->
581
 
<para>
582
 
 
583
 
</para>
584
 
 
585
 
@MC_ACCOUNT_CR_FLAG_USE_EXISTING: 
586
 
 
587
 
<!-- ##### FUNCTION mc_account_channelrequest ##### -->
588
 
<para>
589
 
 
590
 
</para>
591
 
 
592
 
@account: 
593
 
@req_data: 
594
 
@user_action_time: 
595
 
@handler: 
596
 
@flags: 
597
 
@callback: 
598
 
@user_data: 
599
 
@destroy: 
600
 
@weak_object: 
601
 
@Returns: 
602
 
 
603
 
 
604
 
<!-- ##### FUNCTION mc_account_channelrequest_ht ##### -->
605
 
<para>
606
 
 
607
 
</para>
608
 
 
609
 
@account: 
610
 
@properties: 
611
 
@user_action_time: 
612
 
@handler: 
613
 
@flags: 
614
 
@callback: 
615
 
@user_data: 
616
 
@destroy: 
617
 
@weak_object: 
618
 
@Returns: 
619
 
 
620
 
 
621
 
<!-- ##### FUNCTION mc_account_channelrequest_add ##### -->
622
 
<para>
623
 
 
624
 
</para>
625
 
 
626
 
@account: 
627
 
@object_path: 
628
 
@properties: 
629
 
@callback: 
630
 
@user_data: 
631
 
@destroy: 
632
 
@weak_object: 
633
 
@Returns: 
634
 
 
635
 
 
636
 
<!-- ##### FUNCTION mc_account_channelrequest_cancel ##### -->
637
 
<para>
638
 
 
639
 
</para>
640
 
 
641
 
@account: 
642
 
@request_id: 
643
 
 
644
 
 
645
 
<!-- ##### FUNCTION mc_account_channelrequest_get_error ##### -->
646
 
<para>
647
 
 
648
 
</para>
649
 
 
650
 
@account: 
651
 
@request_id: 
652
 
@Returns: 
653
 
 
654
 
 
655
 
<!-- ##### FUNCTION mc_account_channelrequest_get_path ##### -->
656
 
<para>
657
 
 
658
 
</para>
659
 
 
660
 
@account: 
661
 
@request_id: 
662
 
@Returns: 
663
 
 
664
 
 
665
 
<!-- ##### FUNCTION mc_account_channelrequest_get_from_path ##### -->
666
 
<para>
667
 
 
668
 
</para>
669
 
 
670
 
@account: 
671
 
@object_path: 
672
 
@Returns: 
673
 
 
674
 
 
675
 
<!-- ##### USER_FUNCTION mc_cli_account_signal_callback_removed ##### -->
676
 
<para>
677
 
 
678
 
</para>
679
 
 
680
 
@proxy: 
681
 
@user_data: 
682
 
@weak_object: 
683
 
 
684
 
 
685
 
<!-- ##### FUNCTION mc_cli_account_connect_to_removed ##### -->
686
 
<para>
687
 
 
688
 
</para>
689
 
 
690
 
@proxy: 
691
 
@callback: 
692
 
@user_data: 
693
 
@destroy: 
694
 
@weak_object: 
695
 
@error: 
696
 
@Returns: 
697
 
 
698
 
 
699
 
<!-- ##### USER_FUNCTION mc_cli_account_signal_callback_account_property_changed ##### -->
700
 
<para>
701
 
 
702
 
</para>
703
 
 
704
 
@proxy: 
705
 
@arg_Properties: 
706
 
@user_data: 
707
 
@weak_object: 
708
 
 
709
 
 
710
 
<!-- ##### FUNCTION mc_cli_account_connect_to_account_property_changed ##### -->
711
 
<para>
712
 
 
713
 
</para>
714
 
 
715
 
@proxy: 
716
 
@callback: 
717
 
@user_data: 
718
 
@destroy: 
719
 
@weak_object: 
720
 
@error: 
721
 
@Returns: 
722
 
 
723
 
 
724
 
<!-- ##### USER_FUNCTION mc_cli_account_callback_for_remove ##### -->
725
 
<para>
726
 
 
727
 
</para>
728
 
 
729
 
@proxy: 
730
 
@error: 
731
 
@user_data: 
732
 
@weak_object: 
733
 
 
734
 
 
735
 
<!-- ##### FUNCTION mc_cli_account_call_remove ##### -->
736
 
<para>
737
 
 
738
 
</para>
739
 
 
740
 
@proxy: 
741
 
@timeout_ms: 
742
 
@callback: 
743
 
@user_data: 
744
 
@destroy: 
745
 
@weak_object: 
746
 
@Returns: 
747
 
 
748
 
 
749
 
<!-- ##### USER_FUNCTION mc_cli_account_callback_for_update_parameters ##### -->
750
 
<para>
751
 
 
752
 
</para>
753
 
 
754
 
@proxy: 
755
 
@out_Reconnect_Required: 
756
 
@error: 
757
 
@user_data: 
758
 
@weak_object: 
759
 
 
760
 
 
761
 
<!-- ##### FUNCTION mc_cli_account_call_update_parameters ##### -->
762
 
<para>
763
 
 
764
 
</para>
765
 
 
766
 
@proxy: 
767
 
@timeout_ms: 
768
 
@in_Set: 
769
 
@in_Unset: 
770
 
@callback: 
771
 
@user_data: 
772
 
@destroy: 
773
 
@weak_object: 
774
 
@Returns: 
775
 
 
776
 
 
777
 
<!-- ##### USER_FUNCTION mc_cli_account_interface_avatar_signal_callback_avatar_changed ##### -->
778
 
<para>
779
 
 
780
 
</para>
781
 
 
782
 
@proxy: 
783
 
@user_data: 
784
 
@weak_object: 
785
 
 
786
 
 
787
 
<!-- ##### FUNCTION mc_cli_account_interface_avatar_connect_to_avatar_changed ##### -->
788
 
<para>
789
 
 
790
 
</para>
791
 
 
792
 
@proxy: 
793
 
@callback: 
794
 
@user_data: 
795
 
@destroy: 
796
 
@weak_object: 
797
 
@error: 
798
 
@Returns: 
799
 
 
800