/usr/share/gtk-doc/html/libinfinity-0.6/InfChatSession.html is in libinfinity-0.6-doc 0.6.7-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfChatSession: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfSession.html" title="InfSession">
<link rel="next" href="InfChatBuffer.html" title="InfChatBuffer">
<meta name="generator" content="GTK-Doc V1.25 (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="#InfChatSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfChatSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfChatSession.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfChatSession.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfChatSession.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfChatBuffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfChatSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfChatSession.top_of_page"></a>InfChatSession</span></h2>
<p>InfChatSession — Simple standalone chat</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfChatSession.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfChatSession.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="returnvalue">InfChatSession</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfChatSession.html#inf-chat-session-new" title="inf_chat_session_new ()">inf_chat_session_new</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="InfChatSession.html#inf-chat-session-set-log-file" title="inf_chat_session_set_log_file ()">inf_chat_session_set_log_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfChatSession.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfChatSession.html#InfChatSession--log-file" title="The “log-file” property">log-file</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfChatSession.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfChatSession.html#InfChatSession-receive-message" title="The “receive-message” signal">receive-message</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfChatSession.html#InfChatSession-send-message" title="The “send-message” signal">send-message</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfChatSession.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="InfChatSession.html#InfChatSession-struct" title="struct InfChatSession">InfChatSession</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfChatSession.html#InfChatSessionClass" title="struct InfChatSessionClass">InfChatSessionClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfChatSession.html#InfChatSessionError" title="enum InfChatSessionError">InfChatSessionError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfChatSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="InfSession.html" title="InfSession">InfSession</a>
<span class="lineart">╰──</span> InfChatSession
</pre>
</div>
<div class="refsect1">
<a name="InfChatSession.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfChatSession implements
<a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a>.</p>
</div>
<div class="refsect1">
<a name="InfChatSession.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-chat-session.h>
</pre>
</div>
<div class="refsect1">
<a name="InfChatSession.description"></a><h2>Description</h2>
<p><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> represents a chat session. Normally, there is one chat
session per server, and it can be enabled via <a class="link" href="InfdDirectory.html#infd-directory-enable-chat" title="infd_directory_enable_chat ()"><code class="function">infd_directory_enable_chat()</code></a>.
Clients can subscribe to the chat session via
<a class="link" href="InfcBrowser.html#infc-browser-subscribe-chat" title="infc_browser_subscribe_chat ()"><code class="function">infc_browser_subscribe_chat()</code></a>.</p>
</div>
<div class="refsect1">
<a name="InfChatSession.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-chat-session-new"></a><h3>inf_chat_session_new ()</h3>
<pre class="programlisting"><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="returnvalue">InfChatSession</span></a> *
inf_chat_session_new (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="InfChatBuffer.html" title="InfChatBuffer"><span class="type">InfChatBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="type">InfSessionStatus</span></a> status</code></em>,
<em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *sync_group</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *sync_connection</code></em>);</pre>
<p>Creates a new <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> with the messages contained in <em class="parameter"><code>buffer</code></em>
as
initial messages. The communication manager is used to send and receive
requests from subscription and synchronization.</p>
<p>If <em class="parameter"><code>status</code></em>
is <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a> or <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>, then the
session will initially be synchronized, meaning an initial backlog is
retrieved from <em class="parameter"><code>sync_connection</code></em>
(which must not be <code class="literal">NULL</code> in this case). If
you are subscribed to the session, set the subscription group via
<a class="link" href="InfSession.html#inf-session-set-subscription-group" title="inf_session_set_subscription_group ()"><code class="function">inf_session_set_subscription_group()</code></a>.</p>
<div class="refsect3">
<a name="inf-chat-session-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfChatBuffer.html" title="InfChatBuffer"><span class="type">InfChatBuffer</span></a> to use for the session.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>status</p></td>
<td class="parameter_description"><p>Initial status of the session. If this is
<a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a> or <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a>, then <em class="parameter"><code>sync_group</code></em>
and
<em class="parameter"><code>sync_connection</code></em>
need to be set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sync_group</p></td>
<td class="parameter_description"><p>A group in which the session is synchronized. Ignored if
<em class="parameter"><code>status</code></em>
is <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sync_connection</p></td>
<td class="parameter_description"><p>A connection to synchronize the session from. Ignored if
<em class="parameter"><code>status</code></em>
is <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-chat-session-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-chat-session-set-log-file"></a><h3>inf_chat_session_set_log_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_chat_session_set_log_file (<em class="parameter"><code><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> *session</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *log_file</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Sets a file onto which all received messages are appended. The file is
created if it does not exist. If a previous log file was set, then it is
closed before opening the new file.</p>
<p>Backlog messages received upon synchronization are not logged.</p>
<div class="refsect3">
<a name="inf-chat-session-set-log-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>log_file</p></td>
<td class="parameter_description"><p>A filename to store all received messages into.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-chat-session-set-log-file.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the log file could be opened, <code class="literal">FALSE</code> otherwise (in which
case <em class="parameter"><code>error</code></em>
is set).</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfChatSession.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfChatSession-struct"></a><h3>struct InfChatSession</h3>
<pre class="programlisting">struct InfChatSession;</pre>
<p><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> is an opaque data type. You should only access it via the
public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfChatSessionClass"></a><h3>struct InfChatSessionClass</h3>
<pre class="programlisting">struct InfChatSessionClass {
void (*receive_message)(InfChatSession* session,
const InfChatBufferMessage* message);
void (*send_message)(InfChatSession* session,
const InfChatBufferMessage* message);
};
</pre>
<p>This structure contains default signal handlers for <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>.</p>
<div class="refsect3">
<a name="InfChatSessionClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfChatSessionClass.receive-message"></a>receive_message</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfChatSession.html#InfChatSession-receive-message" title="The “receive-message” signal"><span class="type">“receive-message”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfChatSessionClass.send-message"></a>send_message</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfChatSession.html#InfChatSession-send-message" title="The “send-message” signal"><span class="type">“send-message”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfChatSessionError"></a><h3>enum InfChatSessionError</h3>
<p>Errors that can occur with a chat session, especially in the
process_xml_sync and process_xml_run vfunc implementations.</p>
<div class="refsect3">
<a name="InfChatSessionError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INF-CHAT-SESSION-ERROR-TYPE-INVALID:CAPS"></a>INF_CHAT_SESSION_ERROR_TYPE_INVALID</p></td>
<td class="enum_member_description">
<p>An invalid message type was sent.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-CHAT-SESSION-ERROR-NO-SUCH-USER:CAPS"></a>INF_CHAT_SESSION_ERROR_NO_SUCH_USER</p></td>
<td class="enum_member_description">
<p>A message referred to a nonexisting
user.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-CHAT-SESSION-ERROR-FAILED:CAPS"></a>INF_CHAT_SESSION_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>Generic error code when no further reason
of failure is known.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfChatSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfChatSession--log-file"></a><h3>The <code class="literal">“log-file”</code> property</h3>
<pre class="programlisting"> “log-file” <span class="type">gchar</span> *</pre>
<p>The file into which to store all received messages.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="InfChatSession.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfChatSession-receive-message"></a><h3>The <code class="literal">“receive-message”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> *session,
<a class="link" href="InfChatBuffer.html#InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> *message,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever a message has been received. If the
session is in <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a> state the received message was
a backlog message.</p>
<div class="refsect3">
<a name="InfChatSession-receive-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>session</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> that is receiving a message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfChatBuffer.html#InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> that was received.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="InfChatSession-send-message"></a><h3>The <code class="literal">“send-message”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> *session,
<a class="link" href="InfChatBuffer.html#InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> *message,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever a message is sent. Messages can be sent
by calling <a class="link" href="InfChatBuffer.html#inf-chat-buffer-add-message" title="inf_chat_buffer_add_message ()"><code class="function">inf_chat_buffer_add_message()</code></a> or
<a class="link" href="InfChatBuffer.html#inf-chat-buffer-add-emote-message" title="inf_chat_buffer_add_emote_message ()"><code class="function">inf_chat_buffer_add_emote_message()</code></a> on the session's <a class="link" href="InfChatBuffer.html" title="InfChatBuffer"><span class="type">InfChatBuffer</span></a>.
Messages of type <a class="link" href="InfChatBuffer.html#INF-CHAT-BUFFER-MESSAGE-USERJOIN:CAPS"><code class="literal">INF_CHAT_BUFFER_MESSAGE_USERJOIN</code></a> or
<a class="link" href="InfChatBuffer.html#INF-CHAT-BUFFER-MESSAGE-USERPART:CAPS"><code class="literal">INF_CHAT_BUFFER_MESSAGE_USERPART</code></a> can not be sent explicitely, so this
signal will never be emitted for such messages.</p>
<div class="refsect3">
<a name="InfChatSession-send-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>session</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> that is sending a message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfChatBuffer.html#InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> that is sent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|