/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-TpMessageMixin.html is in libtelepathy-glib-doc 0.24.1-1.
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 960 961 962 963 964 965 966 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>telepathy-glib API Reference Manual: TpMessageMixin</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-service-base.html" title="Service-side implementation">
<link rel="prev" href="telepathy-glib-TpGroupMixin.html" title="TpGroupMixin">
<link rel="next" href="TpMessage.html" title="TpMessage">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#telepathy-glib-TpMessageMixin.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch-service-base.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="telepathy-glib-TpGroupMixin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="TpMessage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="telepathy-glib-TpMessageMixin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-TpMessageMixin.top_of_page"></a>TpMessageMixin</span></h2>
<p>TpMessageMixin — a mixin implementation of the text channel type and the
Messages interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()">*TpMessageMixinSendImpl</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-finalize" title="tp_message_mixin_finalize ()">tp_message_mixin_finalize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-implement-sending" title="tp_message_mixin_implement_sending ()">tp_message_mixin_implement_sending</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init" title="tp_message_mixin_init ()">tp_message_mixin_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init-dbus-properties" title="tp_message_mixin_init_dbus_properties ()">tp_message_mixin_init_dbus_properties</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-messages-iface-init" title="tp_message_mixin_messages_iface_init ()">tp_message_mixin_messages_iface_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-get-dbus-property" title="tp_message_mixin_get_dbus_property ()">tp_message_mixin_get_dbus_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-sent" title="tp_message_mixin_sent ()">tp_message_mixin_sent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-set-rescued" title="tp_message_mixin_set_rescued ()">tp_message_mixin_set_rescued</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-take-received" title="tp_message_mixin_take_received ()">tp_message_mixin_take_received</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-has-pending-messages" title="tp_message_mixin_has_pending_messages ()">tp_message_mixin_has_pending_messages</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-clear" title="tp_message_mixin_clear ()">tp_message_mixin_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-text-iface-init" title="tp_message_mixin_text_iface_init ()">tp_message_mixin_text_iface_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendChatStateImpl" title="TpMessageMixinSendChatStateImpl ()">*TpMessageMixinSendChatStateImpl</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-chat-state-iface-init" title="tp_message_mixin_chat_state_iface_init ()">tp_message_mixin_chat_state_iface_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-change-chat-state" title="tp_message_mixin_change_chat_state ()">tp_message_mixin_change_chat_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-implement-send-chat-state" title="tp_message_mixin_implement_send_chat_state ()">tp_message_mixin_implement_send_chat_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-maybe-send-gone" title="tp_message_mixin_maybe_send_gone ()">tp_message_mixin_maybe_send_gone</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin">TpMessageMixin</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <telepathy-glib/telepathy-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.description"></a><h2>Description</h2>
<p>This mixin can be added to a channel GObject class to implement the
text channel type (with the Messages interface) in a general way.
The channel class should also have a <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass"><span class="type">TpDBusPropertiesMixinClass</span></a>.</p>
<p>To use the messages mixin, include a <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin"><span class="type">TpMessageMixin</span></a> somewhere in your
instance structure, and call <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> from your
constructor function, and <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> from your dispose
or finalize function. In the class_init function, call
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init-dbus-properties" title="tp_message_mixin_init_dbus_properties ()"><code class="function">tp_message_mixin_init_dbus_properties()</code></a> to hook this mixin into the D-Bus
properties mixin class. Finally, include the following in the fourth
argument of <code class="function">G_DEFINE_TYPE_WITH_CODE()</code>:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function">G_IMPLEMENT_INTERFACE</span> <span class="gtkdoc opt">(</span>TP_TYPE_SVC_CHANNEL_TYPE_TEXT<span class="gtkdoc opt">,</span>
tp_message_mixin_text_iface_init<span class="gtkdoc opt">);</span>
<span class="function">G_IMPLEMENT_INTERFACE</span> <span class="gtkdoc opt">(</span>TP_TYPE_SVC_CHANNEL_INTERFACE_MESSAGES<span class="gtkdoc opt">,</span>
tp_message_mixin_messages_iface_init<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>To support sending messages, you must call
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-implement-sending" title="tp_message_mixin_implement_sending ()"><code class="function">tp_message_mixin_implement_sending()</code></a> in the constructor function. If you do
not, any attempt to send a message will fail with NotImplemented.</p>
<p>To support chat state, you must call
<a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-implement-send-chat-state" title="tp_message_mixin_implement_send_chat_state ()"><code class="function">tp_message_mixin_implement_send_chat_state()</code></a> in the constructor function, and
include the following in the fourth argument of <code class="function">G_DEFINE_TYPE_WITH_CODE()</code>:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function">G_IMPLEMENT_INTERFACE</span> <span class="gtkdoc opt">(</span>TP_TYPE_SVC_CHANNEL_INTERFACE_CHAT_STATE<span class="gtkdoc opt">,</span>
tp_message_mixin_chat_state_iface_init<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="TpMessageMixinSendImpl"></a><h3>TpMessageMixinSendImpl ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*TpMessageMixinSendImpl<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpMessageSendingFlags" title="enum TpMessageSendingFlags"><span class="type">TpMessageSendingFlags</span></a> flags</code></em>);</pre>
<p>Signature of a virtual method which may be implemented to allow messages
to be sent. It must arrange for <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-sent" title="tp_message_mixin_sent ()"><code class="function">tp_message_mixin_sent()</code></a> to be called when
the message has submitted or when message submission has failed.</p>
<div class="refsect3">
<a name="id-1.6.16.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>An outgoing message</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>flags with which to send the message</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-finalize"></a><h3>tp_message_mixin_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_finalize (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
<p>Free resources held by the text mixin.</p>
<div class="refsect3">
<a name="id-1.6.16.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>An object with this mixin.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-implement-sending"></a><h3>tp_message_mixin_implement_sending ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_implement_sending (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()"><span class="type">TpMessageMixinSendImpl</span></a> send</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_types</code></em>,
<em class="parameter"><code>const <a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> *types</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpMessagePartSupportFlags" title="enum TpMessagePartSupportFlags"><span class="type">TpMessagePartSupportFlags</span></a> message_part_support_flags</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpDeliveryReportingSupportFlags" title="enum TpDeliveryReportingSupportFlags"><span class="type">TpDeliveryReportingSupportFlags</span></a> delivery_reporting_support_flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const *supported_content_types</code></em>);</pre>
<p>Set the callback used to implement SendMessage, and the types of message
that can be sent. This must be called from the init, constructor or
constructed callback, after <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>, and may only be called
once per object.</p>
<div class="refsect3">
<a name="id-1.6.16.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>send</p></td>
<td class="parameter_description"><p>An implementation of <code class="function">SendMessage()</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_types</p></td>
<td class="parameter_description"><p>Number of supported message types</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>types</p></td>
<td class="parameter_description"><p><em class="parameter"><code>n_types</code></em>
supported message types</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message_part_support_flags</p></td>
<td class="parameter_description"><p>Flags indicating what message part structures
are supported</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>delivery_reporting_support_flags</p></td>
<td class="parameter_description"><p>Flags indicating what kind of delivery
reports are supported</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>supported_content_types</p></td>
<td class="parameter_description"><p>The supported content types</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-init"></a><h3>tp_message_mixin_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_init (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
<em class="parameter"><code><span class="type">gsize</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *connection</code></em>);</pre>
<p>Initialize the mixin. Should be called from the implementation's
instance init function or constructor like so:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init">tp_message_mixin_init</a></span> <span class="gtkdoc opt">((</span>GObject <span class="gtkdoc opt">*)</span> self<span class="gtkdoc opt">,</span>
<span class="function">G_STRUCT_OFFSET</span> <span class="gtkdoc opt">(</span>SomeObject<span class="gtkdoc opt">,</span> message_mixin<span class="gtkdoc opt">),</span>
self<span class="gtkdoc opt">-></span>connection<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<div class="refsect3">
<a name="id-1.6.16.7.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>An instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>The byte offset of the TpMessageMixin within the object structure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-init-dbus-properties"></a><h3>tp_message_mixin_init_dbus_properties ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_init_dbus_properties (<em class="parameter"><code><span class="type">GObjectClass</span> *cls</code></em>);</pre>
<p>Set up a <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass"><span class="type">TpDBusPropertiesMixinClass</span></a> to use this mixin's implementation
of the Messages interface's properties.</p>
<p>This uses <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-get-dbus-property" title="tp_message_mixin_get_dbus_property ()"><code class="function">tp_message_mixin_get_dbus_property()</code></a> as the property getter
and sets a list of the supported properties for it.</p>
<div class="refsect3">
<a name="id-1.6.16.7.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cls</p></td>
<td class="parameter_description"><p>The class of an object with this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-messages-iface-init"></a><h3>tp_message_mixin_messages_iface_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_messages_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>
<p>Fill in this mixin's Messages method implementations in the given interface
vtable.</p>
<div class="refsect3">
<a name="id-1.6.16.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>g_iface</p></td>
<td class="parameter_description"><p>A pointer to the <a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelInterfaceMessagesClass" title="TpSvcChannelInterfaceMessagesClass"><span class="type">TpSvcChannelInterfaceMessagesClass</span></a> in an object
class</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iface_data</p></td>
<td class="parameter_description"><p>Ignored</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-get-dbus-property"></a><h3>tp_message_mixin_get_dbus_property ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_get_dbus_property (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><span class="type">GQuark</span> interface</code></em>,
<em class="parameter"><code><span class="type">GQuark</span> name</code></em>,
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> unused</code></em>);</pre>
<p>An implementation of <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()"><span class="type">TpDBusPropertiesMixinGetter</span></a> which assumes that
the <em class="parameter"><code>object</code></em>
has the messages mixin. It can only be used for the Messages
interface.</p>
<div class="refsect3">
<a name="id-1.6.16.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An object with this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interface</p></td>
<td class="parameter_description"><p>Must be <a class="link" href="telepathy-glib-interfaces.html#TP-IFACE-QUARK-CHANNEL-INTERFACE-MESSAGES:CAPS" title="TP_IFACE_QUARK_CHANNEL_INTERFACE_MESSAGES"><code class="literal">TP_IFACE_QUARK_CHANNEL_INTERFACE_MESSAGES</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>A quark representing the D-Bus property name, either
"PendingMessages", "SupportedContentTypes" or "MessagePartSupportFlags"</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>A GValue pre-initialized to the right type, into which to put
the value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unused</p></td>
<td class="parameter_description"><p>Ignored</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-sent"></a><h3>tp_message_mixin_sent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_sent (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpMessageSendingFlags" title="enum TpMessageSendingFlags"><span class="type">TpMessageSendingFlags</span></a> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
<p>Indicate to the message mixin that message submission to the IM server has
succeeded or failed. This should be called as soon as the CM determines
it's theoretically possible to send the message (e.g. the parameters are
supported and correct).</p>
<p>After this function is called, <em class="parameter"><code>message</code></em>
will have been freed, and must not
be dereferenced.</p>
<div class="refsect3">
<a name="id-1.6.16.7.9.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An object implementing the Text and Messages interfaces with this
mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>The outgoing message</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>The flags used when sending the message, which may be a subset of
those passed to the <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()"><span class="type">TpMessageMixinSendImpl</span></a> implementation if not all are
supported, or 0 on error.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>token</p></td>
<td class="parameter_description"><p>A token representing the sent message (see the Telepathy D-Bus API
specification), or an empty string if no suitable identifier is available,
or <code class="literal">NULL</code> on error</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code> on success, or the error with which message submission failed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-set-rescued"></a><h3>tp_message_mixin_set_rescued ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_set_rescued (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
<p>Mark all pending messages as having been "rescued" from a channel that
previously closed.</p>
<div class="refsect3">
<a name="id-1.6.16.7.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>An object with this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-take-received"></a><h3>tp_message_mixin_take_received ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
tp_message_mixin_take_received (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>);</pre>
<p>Receive a message into the pending messages queue, where it will stay
until acknowledged, and emit the Received and ReceivedMessage signals. Also
emit the SendError signal if the message is a failed delivery report.</p>
<div class="refsect3">
<a name="id-1.6.16.7.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a channel with this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>the message. Its ownership is claimed by the message
mixin, so it must no longer be modified or freed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.16.7.11.6"></a><h4>Returns</h4>
<p> the message ID</p>
<p></p>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-has-pending-messages"></a><h3>tp_message_mixin_has_pending_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_message_mixin_has_pending_messages (<em class="parameter"><code><span class="type">GObject</span> *object</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>
<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="refsect3">
<a name="id-1.6.16.7.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An object with this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_sender</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to store the sender of the oldest pending
message</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.16.7.12.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if there are pending messages</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-clear"></a><h3>tp_message_mixin_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_clear (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
<p>Clear the pending message queue, deleting all messages without emitting
PendingMessagesRemoved.</p>
<div class="refsect3">
<a name="id-1.6.16.7.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>An object with this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-text-iface-init"></a><h3>tp_message_mixin_text_iface_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_text_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>
<p>Fill in this mixin's Text method implementations in the given interface
vtable.</p>
<div class="refsect3">
<a name="id-1.6.16.7.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>g_iface</p></td>
<td class="parameter_description"><p>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</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iface_data</p></td>
<td class="parameter_description"><p>Ignored</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.7.21</p>
</div>
<hr>
<div class="refsect2">
<a name="TpMessageMixinSendChatStateImpl"></a><h3>TpMessageMixinSendChatStateImpl ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*TpMessageMixinSendChatStateImpl<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelChatState" title="enum TpChannelChatState"><span class="type">TpChannelChatState</span></a> state</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Signature of a virtual method which may be implemented to allow sending chat
state.</p>
<div class="refsect3">
<a name="id-1.6.16.7.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>an instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-enums.html#TpChannelChatState" title="enum TpChannelChatState"><span class="type">TpChannelChatState</span></a> to be send</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> to fill</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.16.7.15.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.</p>
<p></p>
</div>
<p class="since">Since 0.19.0</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-chat-state-iface-init"></a><h3>tp_message_mixin_chat_state_iface_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_chat_state_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>
<p>Fill in this mixin's ChatState method implementations in the given interface
vtable.</p>
<div class="refsect3">
<a name="id-1.6.16.7.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>g_iface</p></td>
<td class="parameter_description"><p>A pointer to the <a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelInterfaceChatStateClass" title="TpSvcChannelInterfaceChatStateClass"><span class="type">TpSvcChannelInterfaceChatStateClass</span></a> in an object
class</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iface_data</p></td>
<td class="parameter_description"><p>Ignored</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.19.0</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-change-chat-state"></a><h3>tp_message_mixin_change_chat_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_change_chat_state (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> member</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelChatState" title="enum TpChannelChatState"><span class="type">TpChannelChatState</span></a> state</code></em>);</pre>
<p>Change the current chat state of <em class="parameter"><code>member</code></em>
to be <em class="parameter"><code>state</code></em>
. This emits
ChatStateChanged signal and update ChatStates property.</p>
<div class="refsect3">
<a name="id-1.6.16.7.17.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>an instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>member</p></td>
<td class="parameter_description"><p>a member of this chat</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>the new state to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.19.0</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-implement-send-chat-state"></a><h3>tp_message_mixin_implement_send_chat_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_implement_send_chat_state
(<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendChatStateImpl" title="TpMessageMixinSendChatStateImpl ()"><span class="type">TpMessageMixinSendChatStateImpl</span></a> send_chat_state</code></em>);</pre>
<p>Set the callback used to implement SetChatState. This must be called from the
init, constructor or constructed callback, after <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>,
and may only be called once per object.</p>
<div class="refsect3">
<a name="id-1.6.16.7.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>an instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>send_chat_state</p></td>
<td class="parameter_description"><p>send our chat state</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.19.0</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-message-mixin-maybe-send-gone"></a><h3>tp_message_mixin_maybe_send_gone ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_message_mixin_maybe_send_gone (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>);</pre>
<p>Send <a class="link" href="telepathy-glib-enums.html#TP-CHANNEL-CHAT-STATE-GONE:CAPS"><span class="type">TP_CHANNEL_CHAT_STATE_GONE</span></a> if needed. This should be called on private
chats when channel is closed.</p>
<div class="refsect3">
<a name="id-1.6.16.7.19.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An instance of the implementation that uses this mixin</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 0.19.0</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="TpMessageMixin"></a><h3>struct TpMessageMixin</h3>
<pre class="programlisting">struct TpMessageMixin {
};
</pre>
<p>Structure to be included in the instance structure of objects that
use this mixin. Initialize it with <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>.</p>
<p>There are no public fields.</p>
<p class="since">Since 0.7.21</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-TpMessageMixin.see-also"></a><h2>See Also</h2>
<p><a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelTypeText"><span class="type">TpSvcChannelTypeText</span></a>, <a class="link" href="telepathy-glib-svc-channel-text.html#TpSvcChannelInterfaceMessages"><span class="type">TpSvcChannelInterfaceMessages</span></a>,</p>
<a class="link" href="telepathy-glib-dbus-properties-mixin.html" title="TpDBusPropertiesMixin">TpDBusPropertiesMixin</a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|