~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201111172307

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-TpMessageMixin.html

  • Committer: Ken VanDine
  • Date: 2011-11-17 20:53:21 UTC
  • mfrom: (1.6.34 upstream)
  • Revision ID: ken.vandine@canonical.com-20111117205321-l704j7kr1zgw5v9h
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
9
9
<link rel="prev" href="telepathy-glib-TpGroupMixin.html" title="TpGroupMixin">
10
10
<link rel="next" href="TpMessage.html" title="TpMessage">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
42
42
#include &lt;telepathy-glib/message-mixin.h&gt;
43
43
 
44
44
struct              <a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixin" title="struct TpMessageMixin">TpMessageMixin</a>;
45
 
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()">*TpMessageMixinSendImpl</a>)           (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
45
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()">*TpMessageMixinSendImpl</a>)           (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
46
46
                                                         <em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>,
47
47
                                                         <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>);
48
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-finalize" title="tp_message_mixin_finalize ()">tp_message_mixin_finalize</a>           (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
49
 
<span class="returnvalue">void</span>                <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>  (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
48
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-finalize" title="tp_message_mixin_finalize ()">tp_message_mixin_finalize</a>           (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);
 
49
<span class="returnvalue">void</span>                <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>  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
50
50
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()"><span class="type">TpMessageMixinSendImpl</span></a> send</code></em>,
51
 
                                                         <em class="parameter"><code><span class="type">guint</span> n_types</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_types</code></em>,
52
52
                                                         <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>,
53
53
                                                         <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>,
54
54
                                                         <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>,
55
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> * const *supported_content_types</code></em>);
56
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init" title="tp_message_mixin_init ()">tp_message_mixin_init</a>               (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
55
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *supported_content_types</code></em>);
 
56
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-init" title="tp_message_mixin_init ()">tp_message_mixin_init</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
57
57
                                                         <em class="parameter"><code><span class="type">gsize</span> offset</code></em>,
58
58
                                                         <em class="parameter"><code><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *connection</code></em>);
59
59
<span class="returnvalue">void</span>                <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>
60
 
                                                        (<em class="parameter"><code><span class="type">GObjectClass</span> *cls</code></em>);
 
60
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *cls</code></em>);
61
61
<span class="returnvalue">void</span>                <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>
62
 
                                                        (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
63
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);
64
 
<span class="returnvalue">void</span>                <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>  (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
65
 
                                                         <em class="parameter"><code><span class="type">GQuark</span> interface</code></em>,
66
 
                                                         <em class="parameter"><code><span class="type">GQuark</span> name</code></em>,
67
 
                                                         <em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
68
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> unused</code></em>);
69
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-sent" title="tp_message_mixin_sent ()">tp_message_mixin_sent</a>               (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
62
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> g_iface</code></em>,
 
63
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> iface_data</code></em>);
 
64
<span class="returnvalue">void</span>                <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>  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 
65
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> interface</code></em>,
 
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> name</code></em>,
 
67
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
 
68
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> unused</code></em>);
 
69
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-sent" title="tp_message_mixin_sent ()">tp_message_mixin_sent</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
70
70
                                                         <em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>,
71
71
                                                         <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>,
72
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
73
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
74
 
<span class="returnvalue">void</span>                <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>        (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
75
 
<span class="returnvalue">guint</span>               <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>      (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
72
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>,
 
73
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);
 
74
<span class="returnvalue">void</span>                <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>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);
 
75
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>      (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
76
76
                                                         <em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>);
77
 
<span class="returnvalue">gboolean</span>            <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>
78
 
                                                        (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
77
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>
 
78
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
79
79
                                                         <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>);
80
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-clear" title="tp_message_mixin_clear ()">tp_message_mixin_clear</a>              (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
81
 
<span class="returnvalue">void</span>                <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>    (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
82
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);
 
80
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpMessageMixin.html#tp-message-mixin-clear" title="tp_message_mixin_clear ()">tp_message_mixin_clear</a>              (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);
 
81
<span class="returnvalue">void</span>                <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>    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> g_iface</code></em>,
 
82
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> iface_data</code></em>);
83
83
</pre>
84
84
</div>
85
85
<div class="refsect1">
96
96
or finalize function. In the class_init function, call
97
97
<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
98
98
properties mixin class. Finally, include the following in the fourth
99
 
argument of <code class="function">G_DEFINE_TYPE_WITH_CODE()</code>:
 
99
argument of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-DEFINE-TYPE-WITH-CODE:CAPS"><code class="function">G_DEFINE_TYPE_WITH_CODE()</code></a>:
100
100
</p>
101
101
<p>
102
102
</p>
103
 
<div class="informalexample"><pre class="programlisting">
104
 
 G_IMPLEMENT_INTERFACE (TP_TYPE_SVC_CHANNEL_TYPE_TEXT,
105
 
   tp_message_mixin_text_iface_init);
106
 
 G_IMPLEMENT_INTERFACE (TP_TYPE_SVC_CHANNEL_INTERFACE_MESSAGES,
107
 
   tp_message_mixin_messages_iface_init);
108
 
</pre></div>
 
103
<div class="informalexample">
 
104
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
105
    <tbody>
 
106
      <tr>
 
107
        <td class="listing_lines" align="right"><pre>1
 
108
2
 
109
3
 
110
4</pre></td>
 
111
        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-IMPLEMENT-INTERFACE:CAPS">G_IMPLEMENT_INTERFACE</a></span> <span class="gtkdoc opt">(</span>TP_TYPE_SVC_CHANNEL_TYPE_TEXT<span class="gtkdoc opt">,</span>
 
112
  tp_message_mixin_text_iface_init<span class="gtkdoc opt">);</span>
 
113
<span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-IMPLEMENT-INTERFACE:CAPS">G_IMPLEMENT_INTERFACE</a></span> <span class="gtkdoc opt">(</span>TP_TYPE_SVC_CHANNEL_INTERFACE_MESSAGES<span class="gtkdoc opt">,</span>
 
114
  tp_message_mixin_messages_iface_init<span class="gtkdoc opt">);</span></pre></td>
 
115
      </tr>
 
116
    </tbody>
 
117
  </table>
 
118
</div>
 
119
 
109
120
<p>
110
121
</p>
111
122
<p>
133
144
<hr>
134
145
<div class="refsect2">
135
146
<a name="TpMessageMixinSendImpl"></a><h3>TpMessageMixinSendImpl ()</h3>
136
 
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpMessageMixinSendImpl)           (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
147
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpMessageMixinSendImpl)           (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
137
148
                                                         <em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>,
138
149
                                                         <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>
139
150
<p>
162
173
<hr>
163
174
<div class="refsect2">
164
175
<a name="tp-message-mixin-finalize"></a><h3>tp_message_mixin_finalize ()</h3>
165
 
<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>
 
176
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_finalize           (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);</pre>
166
177
<p>
167
178
Free resources held by the text mixin.
168
179
</p>
178
189
<hr>
179
190
<div class="refsect2">
180
191
<a name="tp-message-mixin-implement-sending"></a><h3>tp_message_mixin_implement_sending ()</h3>
181
 
<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>,
 
192
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_implement_sending  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
182
193
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-TpMessageMixin.html#TpMessageMixinSendImpl" title="TpMessageMixinSendImpl ()"><span class="type">TpMessageMixinSendImpl</span></a> send</code></em>,
183
 
                                                         <em class="parameter"><code><span class="type">guint</span> n_types</code></em>,
 
194
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_types</code></em>,
184
195
                                                         <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>,
185
196
                                                         <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>,
186
197
                                                         <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>,
187
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> * const *supported_content_types</code></em>);</pre>
 
198
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *supported_content_types</code></em>);</pre>
188
199
<p>
189
200
Set the callback used to implement SendMessage, and the types of message
190
201
that can be sent. This must be called from the init, constructor or
233
244
<hr>
234
245
<div class="refsect2">
235
246
<a name="tp-message-mixin-init"></a><h3>tp_message_mixin_init ()</h3>
236
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_init               (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
247
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_init               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
237
248
                                                         <em class="parameter"><code><span class="type">gsize</span> offset</code></em>,
238
249
                                                         <em class="parameter"><code><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *connection</code></em>);</pre>
239
250
<p>
242
253
</p>
243
254
<p>
244
255
</p>
245
 
<div class="informalexample"><pre class="programlisting">
246
 
tp_message_mixin_init ((GObject *) self,
247
 
    G_STRUCT_OFFSET (SomeObject, message_mixin),
248
 
    self-&gt;connection);
249
 
</pre></div>
 
256
<div class="informalexample">
 
257
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
258
    <tbody>
 
259
      <tr>
 
260
        <td class="listing_lines" align="right"><pre>1
 
261
2
 
262
3</pre></td>
 
263
        <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>
 
264
    <span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-STRUCT-OFFSET:CAPS">G_STRUCT_OFFSET</a></span> <span class="gtkdoc opt">(</span>SomeObject<span class="gtkdoc opt">,</span> message_mixin<span class="gtkdoc opt">),</span>
 
265
    self<span class="gtkdoc opt">-&gt;</span>connection<span class="gtkdoc opt">);</span></pre></td>
 
266
      </tr>
 
267
    </tbody>
 
268
  </table>
 
269
</div>
 
270
 
250
271
<p>
251
272
</p>
252
273
<div class="variablelist"><table border="0">
273
294
<div class="refsect2">
274
295
<a name="tp-message-mixin-init-dbus-properties"></a><h3>tp_message_mixin_init_dbus_properties ()</h3>
275
296
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_init_dbus_properties
276
 
                                                        (<em class="parameter"><code><span class="type">GObjectClass</span> *cls</code></em>);</pre>
 
297
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *cls</code></em>);</pre>
277
298
<p>
278
299
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
279
300
of the Messages interface's properties.
294
315
<div class="refsect2">
295
316
<a name="tp-message-mixin-messages-iface-init"></a><h3>tp_message_mixin_messages_iface_init ()</h3>
296
317
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_messages_iface_init
297
 
                                                        (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
298
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);</pre>
 
318
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> g_iface</code></em>,
 
319
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> iface_data</code></em>);</pre>
299
320
<p>
300
321
Fill in this mixin's Messages method implementations in the given interface
301
322
vtable.
319
340
<hr>
320
341
<div class="refsect2">
321
342
<a name="tp-message-mixin-get-dbus-property"></a><h3>tp_message_mixin_get_dbus_property ()</h3>
322
 
<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>,
323
 
                                                         <em class="parameter"><code><span class="type">GQuark</span> interface</code></em>,
324
 
                                                         <em class="parameter"><code><span class="type">GQuark</span> name</code></em>,
325
 
                                                         <em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
326
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> unused</code></em>);</pre>
 
343
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_get_dbus_property  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 
344
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> interface</code></em>,
 
345
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> name</code></em>,
 
346
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
 
347
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> unused</code></em>);</pre>
327
348
<p>
328
349
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
329
350
the <em class="parameter"><code>object</code></em> has the messages mixin. It can only be used for the Messages
361
382
<hr>
362
383
<div class="refsect2">
363
384
<a name="tp-message-mixin-sent"></a><h3>tp_message_mixin_sent ()</h3>
364
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_sent               (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
385
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_sent               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
365
386
                                                         <em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>,
366
387
                                                         <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>,
367
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
368
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
 
388
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>,
 
389
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
369
390
<p>
370
391
Indicate to the message mixin that message submission to the IM server has
371
392
succeeded or failed. This should be called as soon as the CM determines
398
419
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
399
420
<td>A token representing the sent message (see the Telepathy D-Bus API
400
421
specification), or an empty string if no suitable identifier is available,
401
 
or <code class="literal">NULL</code> on error</td>
 
422
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error</td>
402
423
</tr>
403
424
<tr>
404
425
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
405
426
<td>
406
 
<code class="literal">NULL</code> on success, or the error with which message submission failed</td>
 
427
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on success, or the error with which message submission failed</td>
407
428
</tr>
408
429
</tbody>
409
430
</table></div>
412
433
<hr>
413
434
<div class="refsect2">
414
435
<a name="tp-message-mixin-set-rescued"></a><h3>tp_message_mixin_set_rescued ()</h3>
415
 
<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>
 
436
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_set_rescued        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);</pre>
416
437
<p>
417
438
Mark all pending messages as having been "rescued" from a channel that
418
439
previously closed.
428
449
<hr>
429
450
<div class="refsect2">
430
451
<a name="tp-message-mixin-take-received"></a><h3>tp_message_mixin_take_received ()</h3>
431
 
<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>,
 
452
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               tp_message_mixin_take_received      (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
432
453
                                                         <em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>);</pre>
433
454
<p>
434
455
Receive a message into the pending messages queue, where it will stay
458
479
<hr>
459
480
<div class="refsect2">
460
481
<a name="tp-message-mixin-has-pending-messages"></a><h3>tp_message_mixin_has_pending_messages ()</h3>
461
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_message_mixin_has_pending_messages
462
 
                                                        (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
 
482
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_message_mixin_has_pending_messages
 
483
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
463
484
                                                         <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>
464
485
<p>
465
486
Return whether the channel <em class="parameter"><code>obj</code></em> has unacknowledged messages. If so, and
466
 
<em class="parameter"><code>first_sender</code></em> is not <code class="literal">NULL</code>, the handle of the sender of the first message
 
487
<em class="parameter"><code>first_sender</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the handle of the sender of the first message
467
488
is placed in it, without incrementing the handle's reference count.
468
489
</p>
469
490
<div class="variablelist"><table border="0">
475
496
</tr>
476
497
<tr>
477
498
<td><p><span class="term"><em class="parameter"><code>first_sender</code></em> :</span></p></td>
478
 
<td>If not <code class="literal">NULL</code>, used to store the sender of the oldest pending
 
499
<td>If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, used to store the sender of the oldest pending
479
500
message</td>
480
501
</tr>
481
502
<tr>
482
503
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
483
504
<td>
484
 
<code class="literal">TRUE</code> if there are pending messages</td>
 
505
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there are pending messages</td>
485
506
</tr>
486
507
</tbody>
487
508
</table></div>
489
510
<hr>
490
511
<div class="refsect2">
491
512
<a name="tp-message-mixin-clear"></a><h3>tp_message_mixin_clear ()</h3>
492
 
<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>
 
513
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_clear              (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);</pre>
493
514
<p>
494
515
Clear the pending message queue, deleting all messages without emitting
495
516
PendingMessagesRemoved.
505
526
<hr>
506
527
<div class="refsect2">
507
528
<a name="tp-message-mixin-text-iface-init"></a><h3>tp_message_mixin_text_iface_init ()</h3>
508
 
<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>,
509
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);</pre>
 
529
<pre class="programlisting"><span class="returnvalue">void</span>                tp_message_mixin_text_iface_init    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> g_iface</code></em>,
 
530
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> iface_data</code></em>);</pre>
510
531
<p>
511
532
Fill in this mixin's Text method implementations in the given interface
512
533
vtable.
535
556
</div>
536
557
<div class="footer">
537
558
<hr>
538
 
          Generated by GTK-Doc V1.17</div>
 
559
          Generated by GTK-Doc V1.18</div>
539
560
</body>
540
561
</html>
 
 
b'\\ No newline at end of file'