/usr/share/gtk-doc/html/loudmouth/loudmouth-lm-message.html is in libloudmouth1-dev 1.4.3-8.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LmMessage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Loudmouth Reference Manual">
<link rel="up" href="ch01.html" title="Loudmouth">
<link rel="prev" href="loudmouth-lm-error.html" title="LmError">
<link rel="next" href="loudmouth-lm-message-handler.html" title="LmMessageHandler">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="loudmouth-lm-error.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Loudmouth Reference Manual</th>
<td><a accesskey="n" href="loudmouth-lm-message-handler.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#loudmouth-lm-message.synopsis" class="shortcut">Top</a>
|
<a href="#loudmouth-lm-message.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="loudmouth-lm-message"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="loudmouth-lm-message.top_of_page"></a>LmMessage</span></h2>
<p>LmMessage — A message is built up like a tree of message nodes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="loudmouth-lm-message.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage">LmMessage</a>;
enum <a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType">LmMessageType</a>;
enum <a class="link" href="loudmouth-lm-message.html#LmMessageSubType" title="enum LmMessageSubType">LmMessageSubType</a>;
<a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="returnvalue">LmMessage</span></a> * <a class="link" href="loudmouth-lm-message.html#lm-message-new" title="lm_message_new ()">lm_message_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *to</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType"><span class="type">LmMessageType</span></a> type</code></em>);
<a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="returnvalue">LmMessage</span></a> * <a class="link" href="loudmouth-lm-message.html#lm-message-new-with-sub-type" title="lm_message_new_with_sub_type ()">lm_message_new_with_sub_type</a> (<em class="parameter"><code>const <span class="type">gchar</span> *to</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType"><span class="type">LmMessageType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessageSubType" title="enum LmMessageSubType"><span class="type">LmMessageSubType</span></a> sub_type</code></em>);
<a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType"><span class="returnvalue">LmMessageType</span></a> <a class="link" href="loudmouth-lm-message.html#lm-message-get-type" title="lm_message_get_type ()">lm_message_get_type</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);
<a class="link" href="loudmouth-lm-message.html#LmMessageSubType" title="enum LmMessageSubType"><span class="returnvalue">LmMessageSubType</span></a> <a class="link" href="loudmouth-lm-message.html#lm-message-get-sub-type" title="lm_message_get_sub_type ()">lm_message_get_sub_type</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);
<a class="link" href="loudmouth-lm-message-node.html#LmMessageNode" title="struct LmMessageNode"><span class="returnvalue">LmMessageNode</span></a> * <a class="link" href="loudmouth-lm-message.html#lm-message-get-node" title="lm_message_get_node ()">lm_message_get_node</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);
<a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="returnvalue">LmMessage</span></a> * <a class="link" href="loudmouth-lm-message.html#lm-message-ref" title="lm_message_ref ()">lm_message_ref</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);
<span class="returnvalue">void</span> <a class="link" href="loudmouth-lm-message.html#lm-message-unref" title="lm_message_unref ()">lm_message_unref</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="loudmouth-lm-message.description"></a><h2>Description</h2>
<p>
Represents a message that can be sent with <a class="link" href="loudmouth-lm-connection.html#lm-connection-send" title="lm_connection_send ()"><code class="function">lm_connection_send()</code></a>, <a class="link" href="loudmouth-lm-connection.html#lm-connection-send-with-reply" title="lm_connection_send_with_reply ()"><code class="function">lm_connection_send_with_reply()</code></a> or <a class="link" href="loudmouth-lm-connection.html#lm-connection-send-with-reply-and-block" title="lm_connection_send_with_reply_and_block ()"><code class="function">lm_connection_send_with_reply_and_block()</code></a>. Either use <a class="link" href="loudmouth-lm-message.html#lm-message-new" title="lm_message_new ()"><code class="function">lm_message_new()</code></a> or <code class="function">lm_message_new_with_subtype()</code> to create a message. You need to call <a class="link" href="loudmouth-lm-message.html#lm-message-unref" title="lm_message_unref ()"><code class="function">lm_message_unref()</code></a> when are finished with it.
</p>
</div>
<div class="refsect1">
<a name="loudmouth-lm-message.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LmMessage"></a><h3>LmMessage</h3>
<pre class="programlisting">typedef struct {
LmMessageNode *node;
LmMessagePriv *priv;
} LmMessage;
</pre>
<p>
The LmMessage struct
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="loudmouth-lm-message-node.html#LmMessageNode" title="struct LmMessageNode"><span class="type">LmMessageNode</span></a> *<em class="structfield"><code><a name="LmMessage.node"></a>node</code></em>;</span></p></td>
<td>The root node of the message, you can also use <a class="link" href="loudmouth-lm-message.html#lm-message-get-node" title="lm_message_get_node ()"><code class="function">lm_message_get_node()</code></a> to retrieve this.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">LmMessagePriv</span> *<em class="structfield"><code><a name="LmMessage.priv"></a>priv</code></em>;</span></p></td>
<td>A pointer to message private data. Should never be touched from application code.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="LmMessageType"></a><h3>enum LmMessageType</h3>
<pre class="programlisting">typedef enum {
LM_MESSAGE_TYPE_MESSAGE,
LM_MESSAGE_TYPE_PRESENCE,
LM_MESSAGE_TYPE_IQ,
LM_MESSAGE_TYPE_STREAM,
LM_MESSAGE_TYPE_STREAM_ERROR,
LM_MESSAGE_TYPE_STREAM_FEATURES,
LM_MESSAGE_TYPE_AUTH,
LM_MESSAGE_TYPE_CHALLENGE,
LM_MESSAGE_TYPE_RESPONSE,
LM_MESSAGE_TYPE_SUCCESS,
LM_MESSAGE_TYPE_FAILURE,
LM_MESSAGE_TYPE_PROCEED,
LM_MESSAGE_TYPE_STARTTLS,
LM_MESSAGE_TYPE_UNKNOWN
} LmMessageType;
</pre>
<p>
Describes what type of message a message is. This maps directly to top level elements in the jabber protocol.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-MESSAGE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_MESSAGE</code></span></p></td>
<td>a message, <span style="color: red"><message></message></span>
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-PRESENCE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_PRESENCE</code></span></p></td>
<td>a presence element, <span style="color: red"><presence></presence></span>
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-IQ:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_IQ</code></span></p></td>
<td>an info/query element, <span style="color: red"><iq></iq></span>
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-STREAM:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_STREAM</code></span></p></td>
<td>the stream:stream element, you probably don't need to create a message of this type.
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-STREAM-ERROR:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_STREAM_ERROR</code></span></p></td>
<td>a stream:error element
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-STREAM-FEATURES:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_STREAM_FEATURES</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-AUTH:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_AUTH</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-CHALLENGE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_CHALLENGE</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-RESPONSE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_RESPONSE</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-SUCCESS:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_SUCCESS</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-FAILURE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_FAILURE</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-PROCEED:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_PROCEED</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-STARTTLS:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_STARTTLS</code></span></p></td>
<td>Internal
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_TYPE_UNKNOWN</code></span></p></td>
<td>incoming message is of some unknown type.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="LmMessageSubType"></a><h3>enum LmMessageSubType</h3>
<pre class="programlisting">typedef enum {
LM_MESSAGE_SUB_TYPE_NOT_SET = -10,
LM_MESSAGE_SUB_TYPE_AVAILABLE = -1,
LM_MESSAGE_SUB_TYPE_NORMAL = 0,
LM_MESSAGE_SUB_TYPE_CHAT,
LM_MESSAGE_SUB_TYPE_GROUPCHAT,
LM_MESSAGE_SUB_TYPE_HEADLINE,
LM_MESSAGE_SUB_TYPE_UNAVAILABLE,
LM_MESSAGE_SUB_TYPE_PROBE,
LM_MESSAGE_SUB_TYPE_SUBSCRIBE,
LM_MESSAGE_SUB_TYPE_UNSUBSCRIBE,
LM_MESSAGE_SUB_TYPE_SUBSCRIBED,
LM_MESSAGE_SUB_TYPE_UNSUBSCRIBED,
LM_MESSAGE_SUB_TYPE_GET,
LM_MESSAGE_SUB_TYPE_SET,
LM_MESSAGE_SUB_TYPE_RESULT,
LM_MESSAGE_SUB_TYPE_ERROR
} LmMessageSubType;
</pre>
<p>
Describes the sub type of a message. This is equal to the "type" attribute in the jabber protocol. What sub type a message can have is depending on the type of the message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-NOT-SET:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_NOT_SET</code></span></p></td>
<td>the default. No "type" attribute will be sent.
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-AVAILABLE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_AVAILABLE</code></span></p></td>
<td>presence is available, applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-NORMAL:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_NORMAL</code></span></p></td>
<td>a normal message.
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-CHAT:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_CHAT</code></span></p></td>
<td>message is a chat message, applies to message type "message"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-GROUPCHAT:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_GROUPCHAT</code></span></p></td>
<td>message is a group chat message, applies to message type "message"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-HEADLINE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_HEADLINE</code></span></p></td>
<td>message is a headline message, applies to message type "message"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-UNAVAILABLE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_UNAVAILABLE</code></span></p></td>
<td>presence is unavailable, applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-PROBE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_PROBE</code></span></p></td>
<td>a probe presence, applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-SUBSCRIBE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_SUBSCRIBE</code></span></p></td>
<td>try to subscribe to another jids presence, applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-UNSUBSCRIBE:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_UNSUBSCRIBE</code></span></p></td>
<td>unsubscribes from another jids presence, applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-SUBSCRIBED:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_SUBSCRIBED</code></span></p></td>
<td>reply from a subscribe message, informs that the subscription was successful. Applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-UNSUBSCRIBED:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_UNSUBSCRIBED</code></span></p></td>
<td>reply from subscribe or unsubscribe message. If it's a reply from a subscribe message it notifies that the subscription failed. Applies to message type "presence"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-GET:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_GET</code></span></p></td>
<td>used to get information from an IQ query, applies to message type "iq"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-SET:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_SET</code></span></p></td>
<td>used to set information in a IQ call, applised to message type "iq"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-RESULT:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_RESULT</code></span></p></td>
<td>message is an IQ reply, applies to message type "iq"
</td>
</tr>
<tr>
<td><p><a name="LM-MESSAGE-SUB-TYPE-ERROR:CAPS"></a><span class="term"><code class="literal">LM_MESSAGE_SUB_TYPE_ERROR</code></span></p></td>
<td>messages is an error, applies to all message types.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-new"></a><h3>lm_message_new ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="returnvalue">LmMessage</span></a> * lm_message_new (<em class="parameter"><code>const <span class="type">gchar</span> *to</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType"><span class="type">LmMessageType</span></a> type</code></em>);</pre>
<p>
Creates a new <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> which can be sent with <a class="link" href="loudmouth-lm-connection.html#lm-connection-send" title="lm_connection_send ()"><code class="function">lm_connection_send()</code></a> or
<a class="link" href="loudmouth-lm-connection.html#lm-connection-send-with-reply" title="lm_connection_send_with_reply ()"><code class="function">lm_connection_send_with_reply()</code></a>. If <em class="parameter"><code>to</code></em> is <code class="literal">NULL</code> the message is sent to the
server. The returned message should be unreferenced with <a class="link" href="loudmouth-lm-message.html#lm-message-unref" title="lm_message_unref ()"><code class="function">lm_message_unref()</code></a>
when caller is finished with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>to</code></em> :</span></p></td>
<td>receipient jid</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>message type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-new-with-sub-type"></a><h3>lm_message_new_with_sub_type ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="returnvalue">LmMessage</span></a> * lm_message_new_with_sub_type (<em class="parameter"><code>const <span class="type">gchar</span> *to</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType"><span class="type">LmMessageType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessageSubType" title="enum LmMessageSubType"><span class="type">LmMessageSubType</span></a> sub_type</code></em>);</pre>
<p>
Creates a new <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> with sub type set. See <a class="link" href="loudmouth-lm-message.html#lm-message-new" title="lm_message_new ()"><code class="function">lm_message_new()</code></a> for more
information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>to</code></em> :</span></p></td>
<td>receipient jid</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>message type</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub_type</code></em> :</span></p></td>
<td>message sub type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-get-type"></a><h3>lm_message_get_type ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-message.html#LmMessageType" title="enum LmMessageType"><span class="returnvalue">LmMessageType</span></a> lm_message_get_type (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);</pre>
<p>
Fetches the type of <em class="parameter"><code>message</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the message type</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-get-sub-type"></a><h3>lm_message_get_sub_type ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-message.html#LmMessageSubType" title="enum LmMessageSubType"><span class="returnvalue">LmMessageSubType</span></a> lm_message_get_sub_type (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);</pre>
<p>
Fetches the sub type of <em class="parameter"><code>message</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the message sub type</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-get-node"></a><h3>lm_message_get_node ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-message-node.html#LmMessageNode" title="struct LmMessageNode"><span class="returnvalue">LmMessageNode</span></a> * lm_message_get_node (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);</pre>
<p>
Retrieves the root node from <em class="parameter"><code>message</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message-node.html#LmMessageNode" title="struct LmMessageNode"><span class="type">LmMessageNode</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-ref"></a><h3>lm_message_ref ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="returnvalue">LmMessage</span></a> * lm_message_ref (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);</pre>
<p>
Adds a reference to <em class="parameter"><code>message</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the message</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-unref"></a><h3>lm_message_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lm_message_unref (<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>);</pre>
<p>
Removes a reference from <em class="parameter"><code>message</code></em>. When no more references are present the
message is freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|