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

839 lines
46 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixEventRoomMember: 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-MatrixJsonCompact.html" title="MatrixJsonCompact">
<link rel="next" href="Matrix-0.0-MatrixEventRoom.html" title="MatrixEventRoom">
<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-MatrixEventRoomMember.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-MatrixJsonCompact.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventRoom.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-MatrixEventRoomMember"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomMember.top_of_page"></a>MatrixEventRoomMember</span></h2>
<p>MatrixEventRoomMember — Class for representing a room membership events</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMember.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-MatrixEventRoomMember.html#MATRIX-EVENT-TYPE-ROOM-MEMBER:CAPS" title="MATRIX_EVENT_TYPE_ROOM_MEMBER">MATRIX_EVENT_TYPE_ROOM_MEMBER</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="returnvalue">MatrixEventRoomMember</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#matrix-event-room-member-new" title="matrix_event_room_member_new ()">matrix_event_room_member_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-matrix-types.html#MatrixRoomMembership" title="enum MatrixRoomMembership"><span class="returnvalue">MatrixRoomMembership</span></a>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#matrix-event-room-member-get-membership" title="matrix_event_room_member_get_membership ()">matrix_event_room_member_get_membership</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-MatrixEventRoomMember.html#matrix-event-room-member-set-membership" title="matrix_event_room_member_set_membership ()">matrix_event_room_member_set_membership</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-MatrixEventRoomMember.html#matrix-event-room-member-get-avatar-url" title="matrix_event_room_member_get_avatar_url ()">matrix_event_room_member_get_avatar_url</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-MatrixEventRoomMember.html#matrix-event-room-member-set-avatar-url" title="matrix_event_room_member_set_avatar_url ()">matrix_event_room_member_set_avatar_url</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-MatrixEventRoomMember.html#matrix-event-room-member-get-display-name" title="matrix_event_room_member_get_display_name ()">matrix_event_room_member_get_display_name</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-MatrixEventRoomMember.html#matrix-event-room-member-set-display-name" title="matrix_event_room_member_set_display_name ()">matrix_event_room_member_set_display_name</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-MatrixEventRoomMember.html#matrix-event-room-member-get-tpi-display-name" title="matrix_event_room_member_get_tpi_display_name ()">matrix_event_room_member_get_tpi_display_name</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-MatrixEventRoomMember.html#matrix-event-room-member-set-tpi-display-name" title="matrix_event_room_member_set_tpi_display_name ()">matrix_event_room_member_set_tpi_display_name</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-MatrixEventRoomMember.html#matrix-event-room-member-get-tpi-signed-mxid" title="matrix_event_room_member_get_tpi_signed_mxid ()">matrix_event_room_member_get_tpi_signed_mxid</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-MatrixEventRoomMember.html#matrix-event-room-member-set-tpi-signed-mxid" title="matrix_event_room_member_set_tpi_signed_mxid ()">matrix_event_room_member_set_tpi_signed_mxid</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-MatrixEventRoomMember.html#matrix-event-room-member-get-tpi-signed-token" title="matrix_event_room_member_get_tpi_signed_token ()">matrix_event_room_member_get_tpi_signed_token</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-MatrixEventRoomMember.html#matrix-event-room-member-set-tpi-signed-token" title="matrix_event_room_member_set_tpi_signed_token ()">matrix_event_room_member_set_tpi_signed_token</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-MatrixEventRoomMember.html#matrix-event-room-member-get-tpi-signature" title="matrix_event_room_member_get_tpi_signature ()">matrix_event_room_member_get_tpi_signature</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-MatrixEventRoomMember.html#matrix-event-room-member-set-tpi-signature" title="matrix_event_room_member_set_tpi_signature ()">matrix_event_room_member_set_tpi_signature</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="returnvalue">MatrixEventState</span></a> **
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#matrix-event-room-member-get-invite-room-state" title="matrix_event_room_member_get_invite_room_state ()">matrix_event_room_member_get_invite_room_state</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-MatrixEventRoomMember.html#matrix-event-room-member-set-invite-room-state" title="matrix_event_room_member_set_invite_room_state ()">matrix_event_room_member_set_invite_room_state</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-MatrixEventRoomMember.html#matrix-event-room-member-get-user-id" title="matrix_event_room_member_get_user_id ()">matrix_event_room_member_get_user_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-MatrixEventRoomMember.html#matrix-event-room-member-set-user-id" title="matrix_event_room_member_set_user_id ()">matrix_event_room_member_set_user_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMember.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember">MatrixEventRoomMember</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMemberClass" title="struct MatrixEventRoomMemberClass">MatrixEventRoomMemberClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMember.description"></a><h2>Description</h2>
<p>Adjusts the membership state for a user in a room. It is preferable to use the membership APIs (`/rooms/&lt;room id&gt;/invite` etc) when performing membership actions rather than adjusting the state directly as there are a restricted set of valid transformations. For example, user A cannot force user B to join a room, and trying to force this state change directly will fail.</p>
<p>The following membership states are specified:</p>
<p>- invite - The user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join.</p>
<p>- join - The user has joined the room (possibly after accepting an invite), and may participate in it.</p>
<p>- leave - The user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked).</p>
<p>- ban - The user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than ban).</p>
<p>- knock - This is a reserved word, which currently has no meaning.</p>
<p>The third_party_invite property will be set if this invite is an invite event and is the successor of an m.room.third_party_invite event, and absent otherwise.</p>
<p>This event may also include an invite_room_state key outside the content key. If present, this contains an array of stripped state events. These events provide information on a few select state events such as the room name.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMember.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-ROOM-MEMBER:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_MEMBER</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_MEMBER (matrix_event_room_member_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-new"></a><h3>matrix_event_room_member_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="returnvalue">MatrixEventRoomMember</span></a> *
matrix_event_room_member_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-membership"></a><h3>matrix_event_room_member_get_membership ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-types.html#MatrixRoomMembership" title="enum MatrixRoomMembership"><span class="returnvalue">MatrixRoomMembership</span></a>
matrix_event_room_member_get_membership
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"membership"</span> property.</p>
<p>The membership state of the user.</p>
<div class="refsect3">
<a name="id-1.2.16.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"membership"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-membership"></a><h3>matrix_event_room_member_set_membership ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_membership
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-types.html#MatrixRoomMembership" title="enum MatrixRoomMembership"><span class="type">MatrixRoomMembership</span></a> value</code></em>);</pre>
<p>Set the value of the <span class="type">"membership"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The membership state of the user.</p>
<div class="refsect3">
<a name="id-1.2.16.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"membership"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-avatar-url"></a><h3>matrix_event_room_member_get_avatar_url ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_member_get_avatar_url
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"avatar-url"</span> property.</p>
<p>The avatar URL for this user, if any. This is added by the homeserver.</p>
<div class="refsect3">
<a name="id-1.2.16.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"avatar-url"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-avatar-url"></a><h3>matrix_event_room_member_set_avatar_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_avatar_url
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"avatar-url"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The avatar URL for this user, if any. This is added by the homeserver.</p>
<div class="refsect3">
<a name="id-1.2.16.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"avatar-url"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-display-name"></a><h3>matrix_event_room_member_get_display_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_member_get_display_name
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"display-name"</span> property.</p>
<p>The display name for this user, if any. This is added by the homeserver.</p>
<div class="refsect3">
<a name="id-1.2.16.6.8.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.8.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"display-name"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-display-name"></a><h3>matrix_event_room_member_set_display_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_display_name
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"display-name"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The display name for this user, if any. This is added by the homeserver.</p>
<div class="refsect3">
<a name="id-1.2.16.6.9.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"display-name"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-tpi-display-name"></a><h3>matrix_event_room_member_get_tpi_display_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_member_get_tpi_display_name
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"tpi-display-name"</span> property.</p>
<p>A name which can be displayed to represent the user instead of their third party identifier</p>
<div class="refsect3">
<a name="id-1.2.16.6.10.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.10.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"tpi-display-name"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-tpi-display-name"></a><h3>matrix_event_room_member_set_tpi_display_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_tpi_display_name
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-display-name"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>A name which can be displayed to represent the user instead of their third party identifier</p>
<div class="refsect3">
<a name="id-1.2.16.6.11.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-display-name"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-tpi-signed-mxid"></a><h3>matrix_event_room_member_get_tpi_signed_mxid ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_member_get_tpi_signed_mxid
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"tpi-signed-mxid"</span> property.</p>
<p>The invited matrix user ID. Must be equal to the user_id property of the event.</p>
<div class="refsect3">
<a name="id-1.2.16.6.12.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.12.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"tpi-signed-mxid"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-tpi-signed-mxid"></a><h3>matrix_event_room_member_set_tpi_signed_mxid ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_tpi_signed_mxid
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-signed-mxid"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The invited matrix user ID. Must be equal to the user_id property of the event.</p>
<div class="refsect3">
<a name="id-1.2.16.6.13.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-signed-mxid"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-tpi-signed-token"></a><h3>matrix_event_room_member_get_tpi_signed_token ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_member_get_tpi_signed_token
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"tpi-signed-token"</span> property.</p>
<p>The token property of the containing third_party_invite object.</p>
<div class="refsect3">
<a name="id-1.2.16.6.14.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.14.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"tpi-signed-token"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-tpi-signed-token"></a><h3>matrix_event_room_member_set_tpi_signed_token ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_tpi_signed_token
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-signed-token"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The token property of the containing third_party_invite object.</p>
<div class="refsect3">
<a name="id-1.2.16.6.15.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-signed-token"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-tpi-signature"></a><h3>matrix_event_room_member_get_tpi_signature ()</h3>
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
matrix_event_room_member_get_tpi_signature
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"tpi-signature"</span> property.</p>
<p>A single signature from the verifying server, in the format specified by the Signing Events section of the server-server API.</p>
<div class="refsect3">
<a name="id-1.2.16.6.16.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.16.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"tpi-signature"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-tpi-signature"></a><h3>matrix_event_room_member_set_tpi_signature ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_tpi_signature
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-signature"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>A single signature from the verifying server, in the format specified by the Signing Events section of the server-server API.</p>
<div class="refsect3">
<a name="id-1.2.16.6.17.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"tpi-signature"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-invite-room-state"></a><h3>matrix_event_room_member_get_invite_room_state ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="returnvalue">MatrixEventState</span></a> **
matrix_event_room_member_get_invite_room_state
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"invite-room-state"</span> property.</p>
<p>A subset of the state of the room at the time of the invite, if membership is invite.</p>
<div class="refsect3">
<a name="id-1.2.16.6.18.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.18.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"invite-room-state"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-invite-room-state"></a><h3>matrix_event_room_member_set_invite_room_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_invite_room_state
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventState.html#MatrixEventState" title="struct MatrixEventState"><span class="type">MatrixEventState</span></a> **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">"invite-room-state"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>A subset of the state of the room at the time of the invite, if membership is invite.</p>
<div class="refsect3">
<a name="id-1.2.16.6.19.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"invite-room-state"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-get-user-id"></a><h3>matrix_event_room_member_get_user_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_member_get_user_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"user-id"</span> property.</p>
<p>The user ID whom this event relates to.</p>
<div class="refsect3">
<a name="id-1.2.16.6.20.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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.16.6.20.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"user-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-member-set-user-id"></a><h3>matrix_event_room_member_set_user_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_member_set_user_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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">"user-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The user ID whom this event relates to.</p>
<div class="refsect3">
<a name="id-1.2.16.6.21.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-MatrixEventRoomMember.html#MatrixEventRoomMember" title="struct MatrixEventRoomMember"><span class="type">MatrixEventRoomMember</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-id"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMember.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventRoomMember"></a><h3>struct MatrixEventRoomMember</h3>
<pre class="programlisting">struct MatrixEventRoomMember {
MatrixEventState parent_instance;
MatrixEventRoomMemberPrivate * priv;
};
</pre>
<p>Class for representing a room membership events</p>
<p>Adjusts the membership state for a user in a room. It is preferable to use the membership APIs (`/rooms/&lt;room id&gt;/invite` etc) when performing membership actions rather than adjusting the state directly as there are a restricted set of valid transformations. For example, user A cannot force user B to join a room, and trying to force this state change directly will fail.</p>
<p>The following membership states are specified:</p>
<p>- invite - The user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join.</p>
<p>- join - The user has joined the room (possibly after accepting an invite), and may participate in it.</p>
<p>- leave - The user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked).</p>
<p>- ban - The user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than ban).</p>
<p>- knock - This is a reserved word, which currently has no meaning.</p>
<p>The third_party_invite property will be set if this invite is an invite event and is the successor of an m.room.third_party_invite event, and absent otherwise.</p>
<p>This event may also include an invite_room_state key outside the content key. If present, this contains an array of stripped state events. These events provide information on a few select state events such as the room name.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventRoomMemberClass"></a><h3>struct MatrixEventRoomMemberClass</h3>
<pre class="programlisting">struct MatrixEventRoomMemberClass {
MatrixEventStateClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomMember.html#MATRIX-EVENT-TYPE-ROOM-MEMBER:CAPS" title="MATRIX_EVENT_TYPE_ROOM_MEMBER"><code class="literal">MATRIX_EVENT_TYPE_ROOM_MEMBER</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.16.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="MatrixEventRoomMemberClass.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 View Git Blame Copy Permalink