gergely
/
matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
matrix-glib-sdk/Matrix-0.0-MatrixEventTypin...

287 lines
14 KiB
HTML
Raw Normal View History

Update GTK Doc with current develop
2016-03-17 16:47:46 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixEventTyping: Matrix-0.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Matrix-0.0 Reference Manual">
<link rel="up" href="ch01.html" title="Matrix-0.0 API Reference">
<link rel="prev" href="Matrix-0.0-MatrixProfile.html" title="MatrixProfile">
<link rel="next" href="Matrix-0.0-MatrixJsonCompact.html" title="MatrixJsonCompact">
<meta name="generator" content="GTK-Doc V1.24 (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="#Matrix-0.0-MatrixEventTyping.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Matrix-0.0-MatrixProfile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixJsonCompact.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="Matrix-0.0-MatrixEventTyping"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventTyping.top_of_page"></a>MatrixEventTyping</span></h2>
<p>MatrixEventTyping — Class to hold an m.typing event.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventTyping.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MATRIX-EVENT-TYPE-TYPING:CAPS" title="MATRIX_EVENT_TYPE_TYPING">MATRIX_EVENT_TYPE_TYPING</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="returnvalue">MatrixEventTyping</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventTyping.html#matrix-event-typing-new" title="matrix_event_typing_new ()">matrix_event_typing_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventTyping.html#matrix-event-typing-get-room-id" title="matrix_event_typing_get_room_id ()">matrix_event_typing_get_room_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventTyping.html#matrix-event-typing-set-room-id" title="matrix_event_typing_set_room_id ()">matrix_event_typing_set_room_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventTyping.html#matrix-event-typing-get-user-ids" title="matrix_event_typing_get_user_ids ()">matrix_event_typing_get_user_ids</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventTyping.html#matrix-event-typing-set-user-ids" title="matrix_event_typing_set_user_ids ()">matrix_event_typing_set_user_ids</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventTyping.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping">MatrixEventTyping</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTypingClass" title="struct MatrixEventTypingClass">MatrixEventTypingClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventTyping.description"></a><h2>Description</h2>
<p>Informs the client of the list of users currently typing.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventTyping.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-TYPING:CAPS"></a><h3>MATRIX_EVENT_TYPE_TYPING</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_TYPING (matrix_event_typing_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-typing-new"></a><h3>matrix_event_typing_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="returnvalue">MatrixEventTyping</span></a> *
matrix_event_typing_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-typing-get-room-id"></a><h3>matrix_event_typing_get_room_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_typing_get_room_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"room-id"</span> property.</p>
<p>The ID of the room this event belongs to.</p>
<div class="refsect3">
<a name="id-1.2.14.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.14.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"room-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-typing-set-room-id"></a><h3>matrix_event_typing_set_room_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_typing_set_room_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"room-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The ID of the room this event belongs to.</p>
<div class="refsect3">
<a name="id-1.2.14.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"room-id"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-typing-get-user-ids"></a><h3>matrix_event_typing_get_user_ids ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
matrix_event_typing_get_user_ids (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">int</span> *result_length1</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"user-ids"</span> property.</p>
<p>The list of user IDs typing in this room, if any.</p>
<div class="refsect3">
<a name="id-1.2.14.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.14.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"user-ids"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-typing-set-user-ids"></a><h3>matrix_event_typing_set_user_ids ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_typing_set_user_ids (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **value</code></em>,
<em class="parameter"><code><span class="type">int</span> value_length1</code></em>);</pre>
<p>Set the value of the <span class="type">"user-ids"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The list of user IDs typing in this room, if any.</p>
<div class="refsect3">
<a name="id-1.2.14.6.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventTyping.html#MatrixEventTyping" title="struct MatrixEventTyping"><span class="type">MatrixEventTyping</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"user-ids"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventTyping.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventTyping"></a><h3>struct MatrixEventTyping</h3>
<pre class="programlisting">struct MatrixEventTyping {
MatrixEventBase parent_instance;
MatrixEventTypingPrivate * priv;
};
</pre>
<p>Class to hold an m.typing event.</p>
<p>Informs the client of the list of users currently typing.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventTypingClass"></a><h3>struct MatrixEventTypingClass</h3>
<pre class="programlisting">struct MatrixEventTypingClass {
MatrixEventBaseClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventTyping.html#MATRIX-EVENT-TYPE-TYPING:CAPS" title="MATRIX_EVENT_TYPE_TYPING"><code class="literal">MATRIX_EVENT_TYPE_TYPING</code></a>. All the fields in this structure are private and should never be accessed directly.</p>
<div class="refsect3">
<a name="id-1.2.14.7.3.5"></a><h4>Members</h4>
<div class="informaltable"><table 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><a class="link" href="Matrix-0.0-MatrixEventBase.html#MatrixEventBaseClass" title="struct MatrixEventBaseClass"><span class="type">MatrixEventBaseClass</span></a> <em class="structfield"><code><a name="MatrixEventTypingClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>the parent class structure</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>