libtelepathy-glib-doc 0.22.1-1ubuntu2 / usr / share / doc / libtelepathy-glib-doc / telepathy-glib / telepathy-glib-TpTextMixin.html

This file is indexed.

/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-TpTextMixin.html is in libtelepathy-glib-doc 0.22.1-1ubuntu2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpTextMixin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-obsolete.html" title="Obsolete modules">
<link rel="prev" href="telepathy-glib-debug-ansi.html" title="ANSI codes for debug messages">
<link rel="next" href="annotation-glossary.html" title="Annotation Glossary">
<meta name="generator" content="GTK-Doc V1.19 (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="telepathy-glib-debug-ansi.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-obsolete.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="annotation-glossary.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-TpTextMixin.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#telepathy-glib-TpTextMixin.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-TpTextMixin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-TpTextMixin.top_of_page"></a>TpTextMixin</span></h2>
<p>TpTextMixin — a mixin implementation of the text channel type</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-TpTextMixin.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;telepathy-glib/text-mixin.h&gt;

                    <a class="link" href="telepathy-glib-TpTextMixin.html#TpTextMixin" title="TpTextMixin">TpTextMixin</a>;
struct              <a class="link" href="telepathy-glib-TpTextMixin.html#TpTextMixinClass" title="struct TpTextMixinClass">TpTextMixinClass</a>;
<span class="returnvalue">GQuark</span>              <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-get-offset-quark" title="tp_text_mixin_class_get_offset_quark ()">tp_text_mixin_class_get_offset_quark</a>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">GQuark</span>              <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-get-offset-quark" title="tp_text_mixin_get_offset_quark ()">tp_text_mixin_get_offset_quark</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-init" title="tp_text_mixin_class_init ()">tp_text_mixin_class_init</a>            (<em class="parameter"><code><span class="type">GObjectClass</span> *obj_cls</code></em>,
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-init" title="tp_text_mixin_init ()">tp_text_mixin_init</a>                  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *contacts_repo</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-set-message-types" title="tp_text_mixin_set_message_types ()">tp_text_mixin_set_message_types</a>     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-finalize" title="tp_text_mixin_finalize ()">tp_text_mixin_finalize</a>              (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive-with-flags" title="tp_text_mixin_receive_with_flags ()">tp_text_mixin_receive_with_flags</a>    (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageFlags" title="enum TpChannelTextMessageFlags"><span class="type">TpChannelTextMessageFlags</span></a> flags</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive" title="tp_text_mixin_receive ()">tp_text_mixin_receive</a>               (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-acknowledge-pending-messages" title="tp_text_mixin_acknowledge_pending_messages ()">tp_text_mixin_acknowledge_pending_messages</a>
                                                        (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code>const <span class="type">GArray</span> *ids</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-list-pending-messages" title="tp_text_mixin_list_pending_messages ()">tp_text_mixin_list_pending_messages</a> (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> clear</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> **ret</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-get-message-types" title="tp_text_mixin_get_message_types ()">tp_text_mixin_get_message_types</a>     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GArray</span> **ret</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-clear" title="tp_text_mixin_clear ()">tp_text_mixin_clear</a>                 (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-has-pending-messages" title="tp_text_mixin_has_pending_messages ()">tp_text_mixin_has_pending_messages</a>  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> *first_sender</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-set-rescued" title="tp_text_mixin_set_rescued ()">tp_text_mixin_set_rescued</a>           (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-iface-init" title="tp_text_mixin_iface_init ()">tp_text_mixin_iface_init</a>            (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpTextMixin.description"></a><h2>Description</h2>
<p>
This mixin can be added to a channel GObject class to implement the
text channel type in a general way. It implements the pending message
queue and GetMessageTypes, so the implementation should only need to
implement Send.
</p>
<p>
To use the text mixin, include a <a class="link" href="telepathy-glib-TpTextMixin.html#TpTextMixinClass" title="struct TpTextMixinClass"><span class="type">TpTextMixinClass</span></a> somewhere in your
class structure and a <a class="link" href="telepathy-glib-TpTextMixin.html#TpTextMixin" title="TpTextMixin"><span class="type">TpTextMixin</span></a> somewhere in your instance structure,
and call <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-init" title="tp_text_mixin_class_init ()"><code class="function">tp_text_mixin_class_init()</code></a> from your class_init function,
<a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-init" title="tp_text_mixin_init ()"><code class="function">tp_text_mixin_init()</code></a> from your init function or constructor, and
<a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-finalize" title="tp_text_mixin_finalize ()"><code class="function">tp_text_mixin_finalize()</code></a> from your dispose or finalize function.
</p>
<p>
To use the text mixin as the implementation of
<a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelTypeText"><span class="type">TpSvcChannelTypeText</span></a>, in the function you pass to G_IMPLEMENT_INTERFACE,
you should first call <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-iface-init" title="tp_text_mixin_iface_init ()"><code class="function">tp_text_mixin_iface_init()</code></a>, then call
<a class="link" href="telepathy-glib-svc-channel-text.html#tp-svc-channel-type-text-implement-send" title="tp_svc_channel_type_text_implement_send ()"><code class="function">tp_svc_channel_type_text_implement_send()</code></a> to register your implementation
of the Send method.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpTextMixin.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpTextMixin"></a><h3>TpTextMixin</h3>
<pre class="programlisting">typedef struct _TpTextMixin TpTextMixin;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">TpTextMixin</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Structure to be included in the instance structure of objects that
use this mixin. Initialize it with <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-init" title="tp_text_mixin_init ()"><code class="function">tp_text_mixin_init()</code></a>.
</p>
<p>
There are no public fields.
</p>
</div>
<hr>
<div class="refsect2">
<a name="TpTextMixinClass"></a><h3>struct TpTextMixinClass</h3>
<pre class="programlisting">struct TpTextMixinClass {
};
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">TpTextMixinClass</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Structure to be included in the class structure of objects that
use this mixin. Initialize it with <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-init" title="tp_text_mixin_class_init ()"><code class="function">tp_text_mixin_class_init()</code></a>.
</p>
<p>
There are no public fields.
</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-class-get-offset-quark"></a><h3>tp_text_mixin_class_get_offset_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>              tp_text_mixin_class_get_offset_quark
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_class_get_offset_quark</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>

</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the quark used for storing mixin offset on a GObjectClass</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-get-offset-quark"></a><h3>tp_text_mixin_get_offset_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>              tp_text_mixin_get_offset_quark      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_get_offset_quark</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>

</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the quark used for storing mixin offset on a GObject</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-class-init"></a><h3>tp_text_mixin_class_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_class_init            (<em class="parameter"><code><span class="type">GObjectClass</span> *obj_cls</code></em>,
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_class_init</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>
Initialize the text mixin. Should be called from the implementation's
class_init function like so:
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
tp_text_mixin_class_init ((GObjectClass *) klass,
                          G_STRUCT_OFFSET (SomeObjectClass, text_mixin));
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj_cls</code></em> :</span></p></td>
<td>The class of the implementation that uses this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>The byte offset of the TpTextMixinClass within the class structure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-init"></a><h3>tp_text_mixin_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_init                  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *contacts_repo</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_init</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init" title="tp_message_mixin_init ()"><code class="function">tp_message_mixin_init()</code></a> instead.</p>
</div>
<p>
Initialize the text mixin. Should be called from the implementation's
instance init function like so:
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
tp_text_mixin_init ((GObject *) self,
                    G_STRUCT_OFFSET (SomeObject, text_mixin),
                    self-&gt;contact_repo);
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An instance of the implementation that uses this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>The byte offset of the TpTextMixin within the object structure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contacts_repo</code></em> :</span></p></td>
<td>The connection's <a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-CONTACT:CAPS"><code class="literal">TP_HANDLE_TYPE_CONTACT</code></a> repository</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-set-message-types"></a><h3>tp_text_mixin_set_message_types ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_set_message_types     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_set_message_types</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>
Set the supported message types.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>guints representing members of <a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a>, terminated
by G_MAXUINT</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-finalize"></a><h3>tp_text_mixin_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_finalize              (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_finalize</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-finalize" title="tp_message_mixin_finalize ()"><code class="function">tp_message_mixin_finalize()</code></a> instead.</p>
</div>
<p>
Free resources held by the text mixin.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-receive-with-flags"></a><h3>tp_text_mixin_receive_with_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_receive_with_flags    (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageFlags" title="enum TpChannelTextMessageFlags"><span class="type">TpChannelTextMessageFlags</span></a> flags</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_receive_with_flags</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-take-received" title="tp_message_mixin_take_received ()"><code class="function">tp_message_mixin_take_received()</code></a> instead.</p>
</div>
<p>
Add a message to the pending queue and emit Received.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with the text mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The type of message received from the underlying protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sender</code></em> :</span></p></td>
<td>The handle of the message sender</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>The time the message was received</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The text of the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>the message's flags</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success; <code class="literal">FALSE</code> if the message was lost due to the memory
limit.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-receive"></a><h3>tp_text_mixin_receive ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_receive               (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_receive</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-take-received" title="tp_message_mixin_take_received ()"><code class="function">tp_message_mixin_take_received()</code></a> instead.</p>
</div>
<p>
Add a message to the pending queue and emit Received. Exactly equivalent
to <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive-with-flags" title="tp_text_mixin_receive_with_flags ()"><code class="function">tp_text_mixin_receive_with_flags()</code></a> with <em class="parameter"><code>flags</code></em> == 0.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with the text mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The type of message received from the underlying protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sender</code></em> :</span></p></td>
<td>The handle of the message sender</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>The time the message was received</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The text of the message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success; <code class="literal">FALSE</code> if the message was lost due to the memory
limit.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-acknowledge-pending-messages"></a><h3>tp_text_mixin_acknowledge_pending_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_acknowledge_pending_messages
                                                        (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code>const <span class="type">GArray</span> *ids</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_acknowledge_pending_messages</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>
Implements D-Bus method AcknowledgePendingMessages
on interface org.freedesktop.Telepathy.Channel.Type.Text
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
<td>An array of guint representing message IDs</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Used to return a pointer to a GError detailing any error
that occurred, D-Bus will throw the error only if this
function returns false.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if successful, FALSE if an error was thrown.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-list-pending-messages"></a><h3>tp_text_mixin_list_pending_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_list_pending_messages (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> clear</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> **ret</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_list_pending_messages</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>
Implements D-Bus method ListPendingMessages
on interface org.freedesktop.Telepathy.Channel.Type.Text
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>clear</code></em> :</span></p></td>
<td>If <code class="literal">TRUE</code>, delete the pending messages from the queue</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ret</code></em> :</span></p></td>
<td>Used to return a pointer to a new GPtrArray of D-Bus structures</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Used to return a pointer to a GError detailing any error
that occurred, D-Bus will throw the error only if this
function returns false.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if successful, FALSE if an error was thrown.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-get-message-types"></a><h3>tp_text_mixin_get_message_types ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_get_message_types     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GArray</span> **ret</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_get_message_types</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> instead.</p>
</div>
<p>
Return a newly allocated GArray of guint, representing message types
taken from <a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a>, through <em class="parameter"><code>ret</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ret</code></em> :</span></p></td>
<td>A pointer to where a GArray of guint will be placed on success</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to where an error will be placed on failure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-clear"></a><h3>tp_text_mixin_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_clear                 (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_clear</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-clear" title="tp_message_mixin_clear ()"><code class="function">tp_message_mixin_clear()</code></a> instead.</p>
</div>
<p>
Clear the pending message queue, deleting all messages.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-has-pending-messages"></a><h3>tp_text_mixin_has_pending_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_has_pending_messages  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> *first_sender</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_has_pending_messages</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-has-pending-messages" title="tp_message_mixin_has_pending_messages ()"><code class="function">tp_message_mixin_has_pending_messages()</code></a> instead.</p>
</div>
<p>
Return whether the channel <em class="parameter"><code>obj</code></em> has unacknowledged messages. If so, and
<em class="parameter"><code>first_sender</code></em> is not <code class="literal">NULL</code>, the handle of the sender of the first message
is placed in it, without incrementing the handle's reference count.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_sender</code></em> :</span></p></td>
<td>If not <code class="literal">NULL</code>, used to store the sender of the oldest pending
message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if there are pending messages</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-set-rescued"></a><h3>tp_text_mixin_set_rescued ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_set_rescued           (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_set_rescued</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-set-rescued" title="tp_message_mixin_set_rescued ()"><code class="function">tp_message_mixin_set_rescued()</code></a> instead.</p>
</div>
<p>
Mark all pending messages as having been "rescued" from a channel that
previously closed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>An object with this mixin</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-text-mixin-iface-init"></a><h3>tp_text_mixin_iface_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_iface_init            (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_text_mixin_iface_init</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-text-iface-init" title="tp_message_mixin_text_iface_init ()"><code class="function">tp_message_mixin_text_iface_init()</code></a> instead.</p>
</div>
<p>
Fill in this mixin's AcknowledgePendingMessages, GetMessageTypes and
ListPendingMessages implementations in the given interface vtable.
In addition to calling this function during interface initialization, the
implementor is expected to call <a class="link" href="telepathy-glib-svc-channel-text.html#tp-svc-channel-type-text-implement-send" title="tp_svc_channel_type_text_implement_send ()"><code class="function">tp_svc_channel_type_text_implement_send()</code></a>,
providing a Send implementation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>g_iface</code></em> :</span></p></td>
<td>A pointer to the <a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelTypeTextClass" title="TpSvcChannelTypeTextClass"><span class="type">TpSvcChannelTypeTextClass</span></a> in an object class</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iface_data</code></em> :</span></p></td>
<td>Ignored</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpTextMixin.see-also"></a><h2>See Also</h2>
<a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelTypeText"><span class="type">TpSvcChannelTypeText</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.