gergely/matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
gh-pages
matrix-glib-sdk/Matrix-0.0-MatrixEventRoomJoinRules.html

211 lines
12 KiB
HTML
Raw Permalink 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>MatrixEventRoomJoinRules: 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-MatrixEventCall.html" title="MatrixEventCall">
<link rel="next" href="Matrix-0.0-MatrixMessageFile.html" title="MatrixMessageFile">
<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-MatrixEventRoomJoinRules.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-MatrixEventCall.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixMessageFile.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-MatrixEventRoomJoinRules"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomJoinRules.top_of_page"></a>MatrixEventRoomJoinRules</span></h2>
<p>MatrixEventRoomJoinRules — Class to hold a m.room.join_rules event.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomJoinRules.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-MatrixEventRoomJoinRules.html#MATRIX-EVENT-TYPE-ROOM-JOIN-RULES:CAPS" title="MATRIX_EVENT_TYPE_ROOM_JOIN_RULES">MATRIX_EVENT_TYPE_ROOM_JOIN_RULES</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="returnvalue">MatrixEventRoomJoinRules</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#matrix-event-room-join-rules-new" title="matrix_event_room_join_rules_new ()">matrix_event_room_join_rules_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-matrix-types.html#MatrixJoinRules" title="enum MatrixJoinRules"><span class="returnvalue">MatrixJoinRules</span></a>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#matrix-event-room-join-rules-get-join-rules" title="matrix_event_room_join_rules_get_join_rules ()">matrix_event_room_join_rules_get_join_rules</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-MatrixEventRoomJoinRules.html#matrix-event-room-join-rules-set-join-rules" title="matrix_event_room_join_rules_set_join_rules ()">matrix_event_room_join_rules_set_join_rules</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomJoinRules.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-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules">MatrixEventRoomJoinRules</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRulesClass" title="struct MatrixEventRoomJoinRulesClass">MatrixEventRoomJoinRulesClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomJoinRules.description"></a><h2>Description</h2>
<p>A room may be public meaning anyone can join the room without any prior action. Alternatively, it can be invite meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, knock and private are reserved keywords which are not implemented.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomJoinRules.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-ROOM-JOIN-RULES:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_JOIN_RULES</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_JOIN_RULES (matrix_event_room_join_rules_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="type">MatrixEventRoomJoinRules</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-join-rules-new"></a><h3>matrix_event_room_join_rules_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="returnvalue">MatrixEventRoomJoinRules</span></a> *
matrix_event_room_join_rules_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-join-rules-get-join-rules"></a><h3>matrix_event_room_join_rules_get_join_rules ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-types.html#MatrixJoinRules" title="enum MatrixJoinRules"><span class="returnvalue">MatrixJoinRules</span></a>
matrix_event_room_join_rules_get_join_rules
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="type">MatrixEventRoomJoinRules</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"join-rules"</span> property.</p>
<div class="refsect3">
<a name="id-1.2.25.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-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="type">MatrixEventRoomJoinRules</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.25.6.4.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"join-rules"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-join-rules-set-join-rules"></a><h3>matrix_event_room_join_rules_set_join_rules ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_join_rules_set_join_rules
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="type">MatrixEventRoomJoinRules</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-types.html#MatrixJoinRules" title="enum MatrixJoinRules"><span class="type">MatrixJoinRules</span></a> value</code></em>);</pre>
<p>Set the value of the <span class="type">"join-rules"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.25.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-MatrixEventRoomJoinRules.html#MatrixEventRoomJoinRules" title="struct MatrixEventRoomJoinRules"><span class="type">MatrixEventRoomJoinRules</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">"join-rules"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomJoinRules.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventRoomJoinRules"></a><h3>struct MatrixEventRoomJoinRules</h3>
<pre class="programlisting">struct MatrixEventRoomJoinRules {
MatrixEventState parent_instance;
MatrixEventRoomJoinRulesPrivate * priv;
};
</pre>
<p>Class to hold a m.room.join_rules event.</p>
<p>A room may be public meaning anyone can join the room without any prior action. Alternatively, it can be invite meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, knock and private are reserved keywords which are not implemented.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventRoomJoinRulesClass"></a><h3>struct MatrixEventRoomJoinRulesClass</h3>
<pre class="programlisting">struct MatrixEventRoomJoinRulesClass {
MatrixEventStateClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomJoinRules.html#MATRIX-EVENT-TYPE-ROOM-JOIN-RULES:CAPS" title="MATRIX_EVENT_TYPE_ROOM_JOIN_RULES"><code class="literal">MATRIX_EVENT_TYPE_ROOM_JOIN_RULES</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.25.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-MatrixEventState.html#MatrixEventStateClass" title="struct MatrixEventStateClass"><span class="type">MatrixEventStateClass</span></a> <em class="structfield"><code><a name="MatrixEventRoomJoinRulesClass.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