gergely/matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
3444a3b1f9
matrix-glib-sdk/Matrix-0.0-MatrixStateEvent.html

287 lines
14 KiB
HTML
Raw Normal View History

Initial commit for the current development version
2016-03-04 15:17:42 +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>Matrix-0.0 Reference Manual: MatrixStateEvent</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-MatrixHTTPClient.html" title="MatrixHTTPClient">
<link rel="next" href="Matrix-0.0-MatrixRoomMessageEvent.html" title="MatrixRoomMessageEvent">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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-MatrixStateEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
<a href="#Matrix-0.0-MatrixStateEvent.object-hierarchy" class="shortcut">Object Hierarchy</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-MatrixHTTPClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixRoomMessageEvent.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-MatrixStateEvent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixStateEvent.top_of_page"></a>MatrixStateEvent</span></h2>
<p>MatrixStateEvent</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixStateEvent.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-MatrixStateEvent.html#MATRIX-TYPE-STATE-EVENT:CAPS" title="MATRIX_TYPE_STATE_EVENT">MATRIX_TYPE_STATE_EVENT</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="returnvalue">MatrixStateEvent</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixStateEvent.html#matrix-state-event-new" title="matrix_state_event_new ()">matrix_state_event_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixStateEvent.html#matrix-state-event-get-state-key" title="matrix_state_event_get_state_key ()">matrix_state_event_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-MatrixStateEvent.html#matrix-state-event-set-state-key" title="matrix_state_event_set_state_key ()">matrix_state_event_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-MatrixStateEvent.html#matrix-state-event-get-content" title="matrix_state_event_get_content ()">matrix_state_event_get_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-MatrixStateEvent.html#matrix-state-event-set-content" title="matrix_state_event_set_content ()">matrix_state_event_set_content</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixStateEvent.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent">MatrixStateEvent</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEventClass" title="struct MatrixStateEventClass">MatrixStateEventClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixStateEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixStateEvent.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixStateEvent.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-TYPE-STATE-EVENT:CAPS"></a><h3>MATRIX_TYPE_STATE_EVENT</h3>
<pre class="programlisting">#define MATRIX_TYPE_STATE_EVENT (matrix_state_event_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-state-event-new"></a><h3>matrix_state_event_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="returnvalue">MatrixStateEvent</span></a> *
matrix_state_event_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-state-event-get-state-key"></a><h3>matrix_state_event_get_state_key ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
matrix_state_event_get_state_key (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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.10.7.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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.10.7.4.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"state-key"</span> property</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-state-event-set-state-key"></a><h3>matrix_state_event_set_state_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_state_event_set_state_key (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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.10.7.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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-state-event-get-content"></a><h3>matrix_state_event_get_content ()</h3>
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
matrix_state_event_get_content (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"content"</span> property.</p>
<div class="refsect3">
<a name="id-1.2.10.7.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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.10.7.6.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"content"</span> property</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-state-event-set-content"></a><h3>matrix_state_event_set_content ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_state_event_set_content (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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">"content"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.10.7.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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">"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-MatrixStateEvent.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixStateEvent"></a><h3>struct MatrixStateEvent</h3>
<pre class="programlisting">struct MatrixStateEvent {
MatrixEvent parent_instance;
MatrixStateEventPrivate * priv;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="MatrixStateEventClass"></a><h3>struct MatrixStateEventClass</h3>
<pre class="programlisting">struct MatrixStateEventClass {
MatrixEventClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixStateEvent.html#MATRIX-TYPE-STATE-EVENT:CAPS" title="MATRIX_TYPE_STATE_EVENT"><code class="literal">MATRIX_TYPE_STATE_EVENT</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.10.8.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-MatrixEvent.html#MatrixEventClass" title="struct MatrixEventClass"><span class="type">MatrixEventClass</span></a> <em class="structfield"><code><a name="MatrixStateEventClass.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.20</div>
</body>
</html>
Reference in New Issue Copy Permalink