This file is indexed.

/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-base-protocol.html is in libtelepathy-glib-doc 0.18.0-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpBaseProtocol</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
<link rel="prev" href="TpBaseConnectionManager.html" title="TpBaseConnectionManager">
<link rel="next" href="TpBaseConnection.html" title="TpBaseConnection">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="TpBaseConnectionManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-service-base.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
<td><a accesskey="n" href="TpBaseConnection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#telepathy-glib-base-protocol.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#telepathy-glib-base-protocol.description" class="shortcut">Description</a>
                   | 
                  <a href="#telepathy-glib-base-protocol.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#telepathy-glib-base-protocol.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#telepathy-glib-base-protocol.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-base-protocol"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-base-protocol.top_of_page"></a>TpBaseProtocol</span></h2>
<p>TpBaseProtocol — base class for <a class="link" href="telepathy-glib-svc-protocol.html#TpSvcProtocol"><span class="type">TpSvcProtocol</span></a> implementations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-base-protocol.synopsis"></a><h2>Synopsis</h2>
<a name="TpBaseProtocol"></a><pre class="synopsis">
#include &lt;telepathy-glib/telepathy-glib.h&gt;

struct              <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol-struct" title="struct TpBaseProtocol">TpBaseProtocol</a>;
const <span class="returnvalue">gchar</span> *       <a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-get-name" title="tp_base_protocol_get_name ()">tp_base_protocol_get_name</a>           (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
<span class="returnvalue">GHashTable</span> *        <a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-get-immutable-properties" title="tp_base_protocol_get_immutable_properties ()">tp_base_protocol_get_immutable_properties</a>
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
const <a class="link" href="TpBaseConnectionManager.html#TpCMParamSpec" title="struct TpCMParamSpec"><span class="returnvalue">TpCMParamSpec</span></a> * <a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-get-parameters" title="tp_base_protocol_get_parameters ()">tp_base_protocol_get_parameters</a>   (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
const <a class="link" href="telepathy-glib-TpPresenceMixin.html#TpPresenceStatusSpec" title="struct TpPresenceStatusSpec"><span class="returnvalue">TpPresenceStatusSpec</span></a> * <a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-get-statuses" title="tp_base_protocol_get_statuses ()">tp_base_protocol_get_statuses</a>
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
<a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="returnvalue">TpBaseConnection</span></a> *  <a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-new-connection" title="tp_base_protocol_new_connection ()">tp_base_protocol_new_connection</a>     (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *asv</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);

struct              <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass" title="struct TpBaseProtocolClass">TpBaseProtocolClass</a>;
const <a class="link" href="TpBaseConnectionManager.html#TpCMParamSpec" title="struct TpCMParamSpec"><span class="returnvalue">TpCMParamSpec</span></a> * (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolGetParametersFunc" title="TpBaseProtocolGetParametersFunc ()">*TpBaseProtocolGetParametersFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
<a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="returnvalue">TpBaseConnection</span></a> *  (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolNewConnectionFunc" title="TpBaseProtocolNewConnectionFunc ()">*TpBaseProtocolNewConnectionFunc</a>)  (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *asv</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolNormalizeContactFunc" title="TpBaseProtocolNormalizeContactFunc ()">*TpBaseProtocolNormalizeContactFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *contact</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolIdentifyAccountFunc" title="TpBaseProtocolIdentifyAccountFunc ()">*TpBaseProtocolIdentifyAccountFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *asv</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GStrv</span>               (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolGetInterfacesFunc" title="TpBaseProtocolGetInterfacesFunc ()">*TpBaseProtocolGetInterfacesFunc</a>)  (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolGetConnectionDetailsFunc" title="TpBaseProtocolGetConnectionDetailsFunc ()">*TpBaseProtocolGetConnectionDetailsFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GStrv</span> *connection_interfaces</code></em>,
                                                         <em class="parameter"><code><span class="type">GType</span> **channel_manager_types</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **icon_name</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **english_name</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **vcard_field</code></em>);
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolGetAvatarDetailsFunc" title="TpBaseProtocolGetAvatarDetailsFunc ()">*TpBaseProtocolGetAvatarDetailsFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GStrv</span> *supported_mime_types</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *min_height</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *min_width</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *rec_height</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *rec_width</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *max_height</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *max_width</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *max_bytes</code></em>);


struct              <a class="link" href="telepathy-glib-base-protocol.html#TpProtocolAddressingInterface" title="struct TpProtocolAddressingInterface">TpProtocolAddressingInterface</a>;
<span class="returnvalue">GStrv</span>               (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolDupSupportedVCardFieldsFunc" title="TpBaseProtocolDupSupportedVCardFieldsFunc ()">*TpBaseProtocolDupSupportedVCardFieldsFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
<span class="returnvalue">GStrv</span>               (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolDupSupportedURISchemesFunc" title="TpBaseProtocolDupSupportedURISchemesFunc ()">*TpBaseProtocolDupSupportedURISchemesFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);
<span class="returnvalue">gchar</span> *             (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolNormalizeVCardAddressFunc" title="TpBaseProtocolNormalizeVCardAddressFunc ()">*TpBaseProtocolNormalizeVCardAddressFunc</a>)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *vcard_field</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *vcard_address</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             (<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolNormalizeURIFunc" title="TpBaseProtocolNormalizeURIFunc ()">*TpBaseProtocolNormalizeURIFunc</a>)   (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----TpBaseProtocol
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpBaseProtocol implements
 <a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a>,  <a class="link" href="telepathy-glib-svc-protocol.html#TpSvcProtocol">TpSvcProtocol</a>,  <a class="link" href="telepathy-glib-svc-protocol.html#TpSvcProtocolInterfacePresence">TpSvcProtocolInterfacePresence</a>,  <a class="link" href="telepathy-glib-svc-protocol.html#TpSvcProtocolInterfaceAvatars">TpSvcProtocolInterfaceAvatars</a> and  <a class="link" href="telepathy-glib-svc-protocol.html#TpSvcProtocolInterfaceAddressing">TpSvcProtocolInterfaceAddressing</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol--immutable-properties" title='The "immutable-properties" property'>immutable-properties</a>"     <span class="type">GHashTable_gchararray+GValue_*</span>  : Read
  "<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol--name" title='The "name" property'>name</a>"                     <span class="type">gchar</span>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.description"></a><h2>Description</h2>
<p>
Base class for Telepathy Protocol objects.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpBaseProtocol-struct"></a><h3>struct TpBaseProtocol</h3>
<pre class="programlisting">struct TpBaseProtocol;</pre>
<p>
An object providing static details of the implementation of one real-time
communications protocol.
</p>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-protocol-get-name"></a><h3>tp_base_protocol_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       tp_base_protocol_get_name           (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a Protocol</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol--name" title='The "name" property'><span class="type">"name"</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-protocol-get-immutable-properties"></a><h3>tp_base_protocol_get_immutable_properties ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *        tp_base_protocol_get_immutable_properties
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Return a basic set of immutable properties for this Protocol object,
by using <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-make-properties-hash" title="tp_dbus_properties_mixin_make_properties_hash ()"><code class="function">tp_dbus_properties_mixin_make_properties_hash()</code></a>.
</p>
<p>
Additional keys and values can be inserted into the returned hash table;
if this is done, the inserted keys and values will be freed when the
hash table is destroyed. The keys must be allocated with <code class="function">g_strdup()</code> or
equivalent, and the values must be slice-allocated (for instance with
<a class="link" href="telepathy-glib-util.html#tp-g-value-slice-new-string" title="tp_g_value_slice_new_string ()"><code class="function">tp_g_value_slice_new_string()</code></a> or a similar function).
</p>
<p>
Note that in particular, <a class="link" href="telepathy-glib-asv.html#tp-asv-set-string" title="tp_asv_set_string ()"><code class="function">tp_asv_set_string()</code></a> and similar functions should
not be used with this hash table.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a Protocol</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a hash table mapping (gchar *) fully-qualified property names to
GValues, which must be freed by the caller (at which point its
contents will also be freed).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-protocol-get-parameters"></a><h3>tp_base_protocol_get_parameters ()</h3>
<pre class="programlisting">const <a class="link" href="TpBaseConnectionManager.html#TpCMParamSpec" title="struct TpCMParamSpec"><span class="returnvalue">TpCMParamSpec</span></a> * tp_base_protocol_get_parameters   (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Returns the parameters supported by this protocol, as an array of structs
which must remain valid at least as long as <em class="parameter"><code>self</code></em> exists (it will typically
be a global static array).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a Protocol object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a description of the
parameters supported by this protocol. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-protocol-get-statuses"></a><h3>tp_base_protocol_get_statuses ()</h3>
<pre class="programlisting">const <a class="link" href="telepathy-glib-TpPresenceMixin.html#TpPresenceStatusSpec" title="struct TpPresenceStatusSpec"><span class="returnvalue">TpPresenceStatusSpec</span></a> * tp_base_protocol_get_statuses
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Get the statuses supported by this object. Subclasses implement this via
the <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.get-statuses"><span class="type">TpBaseProtocolClass.get_statuses</span></a> virtual method.
</p>
<p>
If the object does not implement the Protocol.Interface.Presences
interface, it need not implement this virtual method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a Protocol object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an array of <a class="link" href="telepathy-glib-TpPresenceMixin.html#TpPresenceStatusSpec" title="struct TpPresenceStatusSpec"><span class="type">TpPresenceStatusSpec</span></a> structs describing the
standard statuses supported by this protocol, with a final element
whose name element is guaranteed to be <code class="literal">NULL</code>. The array must remain
valid at least as long as <em class="parameter"><code>self</code></em> does.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-protocol-new-connection"></a><h3>tp_base_protocol_new_connection ()</h3>
<pre class="programlisting"><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="returnvalue">TpBaseConnection</span></a> *  tp_base_protocol_new_connection     (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *asv</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Create a new connection using the <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.get-parameters"><span class="type">TpBaseProtocolClass.get_parameters</span></a> and
<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.new-connection"><span class="type">TpBaseProtocolClass.new_connection</span></a> implementations provided by a subclass.
This is used to implement the <code class="function">RequestConnection()</code> D-Bus method.
</p>
<p>
If the parameters in <em class="parameter"><code>asv</code></em> do not fit the result of <em class="parameter"><code>get_parameters</code></em> (unknown
parameters are given, types are inappropriate, required parameters are
not given, or a <a class="link" href="TpBaseConnectionManager.html#TpCMParamSpec.filter"><span class="type">TpCMParamSpec.filter</span></a> fails), then this method raises an
error and <em class="parameter"><code>new_connection</code></em> is not called.
</p>
<p>
Otherwise, <em class="parameter"><code>new_connection</code></em> is called. Its <em class="parameter"><code>asv</code></em> argument is a copy of the
<em class="parameter"><code>asv</code></em> given to this method, with default values for missing parameters
filled in where available, and parameters' types converted to the <span class="type">GType</span>
specified by <a class="link" href="TpBaseConnectionManager.html#TpCMParamSpec.gtype"><span class="type">TpCMParamSpec.gtype</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a Protocol object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>asv</code></em> :</span></p></td>
<td>the parameters
provided via D-Bus. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to return an error if <code class="literal">NULL</code> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new connection, or <code class="literal">NULL</code> on error</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolClass"></a><h3>struct TpBaseProtocolClass</h3>
<pre class="programlisting">struct TpBaseProtocolClass {
  GObjectClass parent_class;
  TpDBusPropertiesMixinClass dbus_properties_class;

  gboolean is_stub;
  const TpCMParamSpec *(*get_parameters) (TpBaseProtocol *self);
  TpBaseConnection *(*new_connection) (TpBaseProtocol *self,
      GHashTable *asv,
      GError **error);

  gchar *(*normalize_contact) (TpBaseProtocol *self,
      const gchar *contact,
      GError **error);
  gchar *(*identify_account) (TpBaseProtocol *self,
      GHashTable *asv,
      GError **error);

  GStrv (*get_interfaces) (TpBaseProtocol *self);

  void (*get_connection_details) (TpBaseProtocol *self,
      GStrv *connection_interfaces,
      GType **channel_manager_types,
      gchar **icon_name,
      gchar **english_name,
      gchar **vcard_field);

  const TpPresenceStatusSpec * (*get_statuses) (TpBaseProtocol *self);

  TpBaseProtocolGetAvatarDetailsFunc get_avatar_details;

  GStrv (*dup_authentication_types) (TpBaseProtocol *self);
};
</pre>
<p>
The class of a <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">GObjectClass</span> <em class="structfield"><code><a name="TpBaseProtocolClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>the parent class</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass"><span class="type">TpDBusPropertiesMixinClass</span></a> <em class="structfield"><code><a name="TpBaseProtocolClass.dbus-properties-class"></a>dbus_properties_class</code></em>;</span></p></td>
<td>a D-Bus properties mixin</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="TpBaseProtocolClass.is-stub"></a>is_stub</code></em>;</span></p></td>
<td>if <code class="literal">TRUE</code>, this protocol will not be advertised on D-Bus (for
internal use by <a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a>)</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.get-parameters"></a>get_parameters</code></em> ()</span></p></td>
<td>a callback used to implement
<a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-get-parameters" title="tp_base_protocol_get_parameters ()"><code class="function">tp_base_protocol_get_parameters()</code></a>, which all subclasses must provide;
see the documentation of that method for details</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.new-connection"></a>new_connection</code></em> ()</span></p></td>
<td>a callback used to implement
<a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-new-connection" title="tp_base_protocol_new_connection ()"><code class="function">tp_base_protocol_new_connection()</code></a>, which all subclasses must provide;
see the documentation of that method for details</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.normalize-contact"></a>normalize_contact</code></em> ()</span></p></td>
<td>a callback used to implement the NormalizeContact
D-Bus method; it must either return a newly allocated string that is the
normalized version of <em class="parameter"><code>contact</code></em>, or raise an error via <em class="parameter"><code>error</code></em> and
return <code class="literal">NULL</code>. If not implemented, <a class="link" href="telepathy-glib-errors.html#TP-ERROR-NOT-IMPLEMENTED:CAPS"><code class="literal">TP_ERROR_NOT_IMPLEMENTED</code></a> will be raised
instead.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.identify-account"></a>identify_account</code></em> ()</span></p></td>
<td>a callback used to implement the IdentifyAccount
D-Bus method; it takes as input a map from strings to <span class="type">GValue</span>s,
and must either return a newly allocated string that represents the
"identity" of the parameters in <em class="parameter"><code>asv</code></em> (usually the "account" parameter),
or <code class="literal">NULL</code> with an error raised via <em class="parameter"><code>error</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.get-interfaces"></a>get_interfaces</code></em> ()</span></p></td>
<td>a callback used to implement the Interfaces D-Bus property;
it must return a newly allocated <span class="type">GStrv</span> containing D-Bus interface names</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.get-connection-details"></a>get_connection_details</code></em> ()</span></p></td>
<td>a callback used to implement the Protocol D-Bus
properties that represent details of the connections provided by this
protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.get-statuses"></a>get_statuses</code></em> ()</span></p></td>
<td>a callback used to implement the Protocol.Interface.Presence
interface's Statuses property. Since 0.13.5</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolGetAvatarDetailsFunc" title="TpBaseProtocolGetAvatarDetailsFunc ()"><span class="type">TpBaseProtocolGetAvatarDetailsFunc</span></a> <em class="structfield"><code><a name="TpBaseProtocolClass.get-avatar-details"></a>get_avatar_details</code></em>;</span></p></td>
<td>a callback used to implement the
Protocol.Interface.Avatars interface's properties. Since 0.13.7</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpBaseProtocolClass.dup-authentication-types"></a>dup_authentication_types</code></em> ()</span></p></td>
<td>a callback used to implement the
AuthenticationTypes D-Bus property; it must return a newly allocated <span class="type">GStrv</span>
containing D-Bus interface names. Since 0.13.9</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolGetParametersFunc"></a><h3>TpBaseProtocolGetParametersFunc ()</h3>
<pre class="programlisting">const <a class="link" href="TpBaseConnectionManager.html#TpCMParamSpec" title="struct TpCMParamSpec"><span class="returnvalue">TpCMParamSpec</span></a> * (*TpBaseProtocolGetParametersFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Signature of a virtual method to get the allowed parameters for connections
to a protocol.
</p>
<p>
Returns the parameters supported by this protocol, as an array of structs
which must remain valid at least as long as <em class="parameter"><code>self</code></em> exists (it will typically
be a global static array).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a description of the
parameters supported by this protocol. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolNewConnectionFunc"></a><h3>TpBaseProtocolNewConnectionFunc ()</h3>
<pre class="programlisting"><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="returnvalue">TpBaseConnection</span></a> *  (*TpBaseProtocolNewConnectionFunc)  (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *asv</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Signature of a virtual method to create a new connection to this protocol.
This is used to implement the RequestConnection D-Bus method.
</p>
<p>
Implementations of <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.new-connection"><span class="type">TpBaseProtocolClass.new_connection</span></a> may assume that
the parameters in <em class="parameter"><code>asv</code></em> conform to the specifications given by
<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.get-parameters"><span class="type">TpBaseProtocolClass.get_parameters</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>asv</code></em> :</span></p></td>
<td>the parameters
provided via D-Bus. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to return an error if <code class="literal">NULL</code> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new connection, or <code class="literal">NULL</code> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolNormalizeContactFunc"></a><h3>TpBaseProtocolNormalizeContactFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             (*TpBaseProtocolNormalizeContactFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *contact</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Signature of a virtual method to perform best-effort offline normalization
of a contact's identifier. It must either return a newly allocated string
that is the normalized form of <em class="parameter"><code>contact</code></em>, or raise an error and return <code class="literal">NULL</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
<td>a contact's identifier</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to return an error if <code class="literal">NULL</code> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a normalized identifier, or <code class="literal">NULL</code> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolIdentifyAccountFunc"></a><h3>TpBaseProtocolIdentifyAccountFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             (*TpBaseProtocolIdentifyAccountFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *asv</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Signature of a virtual method to choose a unique name for an account whose
connection parameters are <em class="parameter"><code>asv</code></em>. This will typically return a copy of
the 'account' parameter from <em class="parameter"><code>asv</code></em>, but may do something more complex (for
instance, on IRC it could combine the nickname and the IRC network).
</p>
<p>
Implementations of <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.identify-account"><span class="type">TpBaseProtocolClass.identify_account</span></a> may assume that
the parameters in <em class="parameter"><code>asv</code></em> conform to the specifications given by
<a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.get-parameters"><span class="type">TpBaseProtocolClass.get_parameters</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>asv</code></em> :</span></p></td>
<td>parameters that might be passed to the RequestConnection D-Bus method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to return an error if <code class="literal">NULL</code> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a unique name for the account, or <code class="literal">NULL</code> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolGetInterfacesFunc"></a><h3>TpBaseProtocolGetInterfacesFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GStrv</span>               (*TpBaseProtocolGetInterfacesFunc)  (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Signature of a virtual method to get the D-Bus interfaces implemented by
<em class="parameter"><code>self</code></em>, in addition to the Protocol interface.
</p>
<p>
If you implement <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolClass.get-statuses"><span class="type">TpBaseProtocolClass.get_statuses</span></a>, you should include
<a class="link" href="telepathy-glib-interfaces.html#TP-IFACE-PROTOCOL-INTERFACE-PRESENCE:CAPS" title="TP_IFACE_PROTOCOL_INTERFACE_PRESENCE"><code class="literal">TP_IFACE_PROTOCOL_INTERFACE_PRESENCE</code></a> in the returned array.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <code class="literal">NULL</code>-terminated array of D-Bus interface names. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolGetConnectionDetailsFunc"></a><h3>TpBaseProtocolGetConnectionDetailsFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpBaseProtocolGetConnectionDetailsFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GStrv</span> *connection_interfaces</code></em>,
                                                         <em class="parameter"><code><span class="type">GType</span> **channel_manager_types</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **icon_name</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **english_name</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **vcard_field</code></em>);</pre>
<p>
Signature of a virtual method to get the D-Bus interfaces implemented by
<em class="parameter"><code>self</code></em>, in addition to the Protocol interface.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection_interfaces</code></em> :</span></p></td>
<td>used to return a
<code class="literal">NULL</code>-terminated array of interfaces which might be implemented on
connections to this protocol. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel_manager_types</code></em> :</span></p></td>
<td>used to return a <code class="literal">G_TYPE_INVALID</code>-terminated array of types that implement
<a class="link" href="TpChannelManager.html" title="TpChannelManager"><span class="type">TpChannelManager</span></a>, which must include all channel managers that might be
present on connections to this protocol; the channel managers should
all implement <a class="link" href="TpChannelManager.html#TpChannelManagerIface.type-foreach-channel-class"><span class="type">TpChannelManagerIface.type_foreach_channel_class</span></a>. The
array will be freed with <code class="function">g_free()</code> by the caller. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td>
<td>used to return the name of an icon
for this protocol, such as "im-icq", or an empty string. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>english_name</code></em> :</span></p></td>
<td>used to return a human-readable
but non-localized name for this protocol, or an empty string. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vcard_field</code></em> :</span></p></td>
<td>used to return the name of the vCard
field typically used with this protocol, or an empty string. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolGetAvatarDetailsFunc"></a><h3>TpBaseProtocolGetAvatarDetailsFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpBaseProtocolGetAvatarDetailsFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">GStrv</span> *supported_mime_types</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *min_height</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *min_width</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *rec_height</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *rec_width</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *max_height</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *max_width</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> *max_bytes</code></em>);</pre>
<p>
Signature of a virtual method to get the supported avatar details for the
protocol implemented by <em class="parameter"><code>self</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>supported_mime_types</code></em> :</span></p></td>
<td>used to return a
<code class="literal">NULL</code>-terminated array of supported avatar mime types. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min_height</code></em> :</span></p></td>
<td>used to return the minimum height in pixels of an
avatar on this protocol, which may be 0. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min_width</code></em> :</span></p></td>
<td>used to return the minimum width in pixels of an avatar
on this protocol, which may be 0. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rec_height</code></em> :</span></p></td>
<td>used to return the rec height in pixels
of an avatar on this protocol, or 0 if there is no preferred height. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rec_width</code></em> :</span></p></td>
<td>used to return the rec width in pixels
of an avatar on this protocol, or 0 if there is no preferred width. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_height</code></em> :</span></p></td>
<td>used to return the maximum height in pixels of an
avatar on this protocol, or 0 if there is no limit. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_width</code></em> :</span></p></td>
<td>used to return the maximum width in pixels of an avatar
on this protocol, or 0 if there is no limit. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_bytes</code></em> :</span></p></td>
<td>used to return the maximum size in bytes of an avatar on
this protocol, or 0 if there is no limit. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.7</p>
</div>
<hr>
<div class="refsect2">
<a name="TpProtocolAddressingInterface"></a><h3>struct TpProtocolAddressingInterface</h3>
<pre class="programlisting">struct TpProtocolAddressingInterface {
  GTypeInterface parent;

  TpBaseProtocolDupSupportedVCardFieldsFunc dup_supported_vcard_fields;

  TpBaseProtocolDupSupportedURISchemesFunc dup_supported_uri_schemes;

  TpBaseProtocolNormalizeVCardAddressFunc normalize_vcard_address;

  TpBaseProtocolNormalizeURIFunc normalize_contact_uri;
};
</pre>
<p>
The interface vtable for a <code class="literal">TP_TYPE_PROTOCOL_ADDRESSING</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="TpProtocolAddressingInterface.parent"></a>parent</code></em>;</span></p></td>
<td>the parent interface</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolDupSupportedVCardFieldsFunc" title="TpBaseProtocolDupSupportedVCardFieldsFunc ()"><span class="type">TpBaseProtocolDupSupportedVCardFieldsFunc</span></a> <em class="structfield"><code><a name="TpProtocolAddressingInterface.dup-supported-vcard-fields"></a>dup_supported_vcard_fields</code></em>;</span></p></td>
<td>provides the supported vCard fields. Must
always be implemented.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolDupSupportedURISchemesFunc" title="TpBaseProtocolDupSupportedURISchemesFunc ()"><span class="type">TpBaseProtocolDupSupportedURISchemesFunc</span></a> <em class="structfield"><code><a name="TpProtocolAddressingInterface.dup-supported-uri-schemes"></a>dup_supported_uri_schemes</code></em>;</span></p></td>
<td>provides the supported URI schemes. Must always
be implemented.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolNormalizeVCardAddressFunc" title="TpBaseProtocolNormalizeVCardAddressFunc ()"><span class="type">TpBaseProtocolNormalizeVCardAddressFunc</span></a> <em class="structfield"><code><a name="TpProtocolAddressingInterface.normalize-vcard-address"></a>normalize_vcard_address</code></em>;</span></p></td>
<td>protocol-specific implementation for normalizing
vCard addresses.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocolNormalizeURIFunc" title="TpBaseProtocolNormalizeURIFunc ()"><span class="type">TpBaseProtocolNormalizeURIFunc</span></a> <em class="structfield"><code><a name="TpProtocolAddressingInterface.normalize-contact-uri"></a>normalize_contact_uri</code></em>;</span></p></td>
<td>protocol-specific implementation for normalizing contact URIs.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolDupSupportedVCardFieldsFunc"></a><h3>TpBaseProtocolDupSupportedVCardFieldsFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GStrv</span>               (*TpBaseProtocolDupSupportedVCardFieldsFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Signature of a virtual method to get the supported vCard fields supported by
<span class="type">self</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of vCard fields in lower
case, e.g. [x-sip, tel]. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolDupSupportedURISchemesFunc"></a><h3>TpBaseProtocolDupSupportedURISchemesFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GStrv</span>               (*TpBaseProtocolDupSupportedURISchemesFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>);</pre>
<p>
Signature of a virtual method to get the supported URI schemes supported by
<span class="type">self</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of uri schemes, e.g. [sip, sips, tel]. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolNormalizeVCardAddressFunc"></a><h3>TpBaseProtocolNormalizeVCardAddressFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             (*TpBaseProtocolNormalizeVCardAddressFunc)
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *vcard_field</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *vcard_address</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Signature of a virtual method to perform best-effort offline normalization
of a vCard address. It must either return a newly allocated string
that is the normalized form of <em class="parameter"><code>vcard_address</code></em>, or raise an error and
return <code class="literal">NULL</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vcard_field</code></em> :</span></p></td>
<td>The vCard field of the address to be normalized.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vcard_address</code></em> :</span></p></td>
<td>The address to normalize.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to return an error if <code class="literal">NULL</code> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a normalized identifier, or <code class="literal">NULL</code> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocolNormalizeURIFunc"></a><h3>TpBaseProtocolNormalizeURIFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             (*TpBaseProtocolNormalizeURIFunc)   (<em class="parameter"><code><a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Signature of a virtual method to perform best-effort offline normalization
of a URI. It must either return a newly allocated string
that is the normalized form of <em class="parameter"><code>uri</code></em>, or raise an error and return <code class="literal">NULL</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>The URI to normalize.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to return an error if <code class="literal">NULL</code> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a normalized identifier, or <code class="literal">NULL</code> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.11</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpBaseProtocol--immutable-properties"></a><h3>The <code class="literal">"immutable-properties"</code> property</h3>
<pre class="programlisting">  "immutable-properties"     <span class="type">GHashTable_gchararray+GValue_*</span>  : Read</pre>
<p>
The D-Bus properties to be announced in the ConnectionManager
interface's Protocols property, as a map from
interface.name.propertyname to GValue.
</p>
<p>
A protocol's immutable properties are constant for its lifetime on the
bus, so this property should never change. All of the D-Bus
properties mentioned here should also be exposed through the D-Bus
properties interface.
</p>
<p>
The <a class="link" href="telepathy-glib-base-protocol.html#TpBaseProtocol"><span class="type">TpBaseProtocol</span></a> base class implements this property to be correct
for the basic set of properties. It can be reimplemented by
subclasses to have more immutable properties; if so, the subclass
should use <a class="link" href="telepathy-glib-base-protocol.html#tp-base-protocol-get-immutable-properties" title="tp_base_protocol_get_immutable_properties ()"><code class="function">tp_base_protocol_get_immutable_properties()</code></a>,
then augment the result using
<a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-fill-properties-hash" title="tp_dbus_properties_mixin_fill_properties_hash ()"><code class="function">tp_dbus_properties_mixin_fill_properties_hash()</code></a>.
</p>
<p class="since">Since 0.11.11</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseProtocol--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting">  "name"                     <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>The Protocol from telepathy-spec, such as 'jabber' or 'local-xmpp'.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-protocol.see-also"></a><h2>See Also</h2>
<a class="link" href="TpBaseConnectionManager.html" title="TpBaseConnectionManager"><span class="type">TpBaseConnectionManager</span></a>, <a class="link" href="telepathy-glib-svc-protocol.html#TpSvcProtocol"><span class="type">TpSvcProtocol</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>