gergely/matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
3dfe286f52
matrix-glib-sdk/Matrix-0.0-MatrixEventState.html

299 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>MatrixEventState: 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-MatrixEventPresence.html" title="MatrixEventPresence">
<link rel="next" href="Matrix-0.0-MatrixEventRoomCanonicalAlias.html" title="MatrixEventRoomCanonicalAlias">
<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-MatrixEventState.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-MatrixEventPresence.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventRoomCanonicalAlias.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-MatrixEventState"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventState.top_of_page"></a>MatrixEventState</span></h2>
<p>MatrixEventState</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventState.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-MatrixEventState.html#MATRIX-EVENT-TYPE-STATE:CAPS" title="MATRIX_EVENT_TYPE_STATE">MATRIX_EVENT_TYPE_STATE</a></td>
</tr>
<tr>
<td class="function_type">
<a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventState.html#matrix-event-state-get-stripped-node" title="matrix_event_state_get_stripped_node ()">matrix_event_state_get_stripped_node</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-MatrixEventState.html#matrix-event-state-get-state-key" title="matrix_event_state_get_state_key ()">matrix_event_state_get_state_key</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-MatrixEventState.html#matrix-event-state-set-state-key" title="matrix_event_state_set_state_key ()">matrix_event_state_set_state_key</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventState.html#matrix-event-state-get-prev-content" title="matrix_event_state_get_prev_content ()">matrix_event_state_get_prev_content</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-MatrixEventState.html#matrix-event-state-set-prev-content" title="matrix_event_state_set_prev_content ()">matrix_event_state_set_prev_content</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventState.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-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState">MatrixEventState</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventStateClass" title="struct MatrixEventStateClass">MatrixEventStateClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventState.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventState.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-STATE:CAPS"></a><h3>MATRIX_EVENT_TYPE_STATE</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_STATE (matrix_event_state_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-state-get-stripped-node"></a><h3>matrix_event_state_get_stripped_node ()</h3>
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
matrix_event_state_get_stripped_node (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a> *self</code></em>);</pre>
<p>Get a stripped state event.</p>
<div class="refsect3">
<a name="id-1.2.8.6.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.8.6.3.6"></a><h4>Returns</h4>
<p>`null` if the event is not allowed to be stripped, or the full JSON node otherwise </p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-state-get-state-key"></a><h3>matrix_event_state_get_state_key ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_state_get_state_key (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"state-key"</span> property.</p>
<div class="refsect3">
<a name="id-1.2.8.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</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.8.6.4.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"state-key"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-state-set-state-key"></a><h3>matrix_event_state_set_state_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_state_set_state_key (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</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">"state-key"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.8.6.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</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">"state-key"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-state-get-prev-content"></a><h3>matrix_event_state_get_prev_content ()</h3>
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
matrix_event_state_get_prev_content (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"prev-content"</span> property.</p>
<div class="refsect3">
<a name="id-1.2.8.6.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</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.8.6.6.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"prev-content"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-state-set-prev-content"></a><h3>matrix_event_state_set_prev_content ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_state_set_prev_content (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a> *self</code></em>,
<em class="parameter"><code><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="type">JsonNode</span></a> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"prev-content"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.8.6.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</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">"prev-content"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventState.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventState"></a><h3>struct MatrixEventState</h3>
<pre class="programlisting">struct MatrixEventState {
MatrixEventRoom parent_instance;
MatrixEventStatePrivate * priv;
gchar* _state_key;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventStateClass"></a><h3>struct MatrixEventStateClass</h3>
<pre class="programlisting">struct MatrixEventStateClass {
MatrixEventRoomClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventState.html#MATRIX-EVENT-TYPE-STATE:CAPS" title="MATRIX_EVENT_TYPE_STATE"><code class="literal">MATRIX_EVENT_TYPE_STATE</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.8.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-MatrixEventRoom.html#MatrixEventRoomClass" title="struct MatrixEventRoomClass"><span class="type">MatrixEventRoomClass</span></a> <em class="structfield"><code><a name="MatrixEventStateClass.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>
Reference in New Issue Copy Permalink