217 lines
12 KiB
HTML
217 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>MatrixEventRoomAliases: 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-MatrixEventRoomHistoryVisibility.html" title="MatrixEventRoomHistoryVisibility">
|
||
<link rel="next" href="Matrix-0.0-MatrixEventCallCandidates.html" title="MatrixEventCallCandidates">
|
||
<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-MatrixEventRoomAliases.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-MatrixEventRoomHistoryVisibility.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="Matrix-0.0-MatrixEventCallCandidates.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-MatrixEventRoomAliases"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomAliases.top_of_page"></a>MatrixEventRoomAliases</span></h2>
|
||
<p>MatrixEventRoomAliases — Class to hold a m.room.aliases event.</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEventRoomAliases.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-MatrixEventRoomAliases.html#MATRIX-EVENT-TYPE-ROOM-ALIASES:CAPS" title="MATRIX_EVENT_TYPE_ROOM_ALIASES">MATRIX_EVENT_TYPE_ROOM_ALIASES</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="returnvalue">MatrixEventRoomAliases</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#matrix-event-room-aliases-new" title="matrix_event_room_aliases_new ()">matrix_event_room_aliases_new</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-MatrixEventRoomAliases.html#matrix-event-room-aliases-get-aliases" title="matrix_event_room_aliases_get_aliases ()">matrix_event_room_aliases_get_aliases</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-MatrixEventRoomAliases.html#matrix-event-room-aliases-set-aliases" title="matrix_event_room_aliases_set_aliases ()">matrix_event_room_aliases_set_aliases</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEventRoomAliases.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-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases">MatrixEventRoomAliases</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MatrixEventRoomAliasesClass" title="struct MatrixEventRoomAliasesClass">MatrixEventRoomAliasesClass</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEventRoomAliases.description"></a><h2>Description</h2>
|
||
<p>This event is sent by a homeserver directly to inform of changes to the list of aliases it knows about for that room.</p>
|
||
<p>The state_key for this event is set to the homeserver which owns the room alias.</p>
|
||
<p>The entire set of known aliases for the room is the union of all the m.room.aliases events, one for each homeserver. Clients should check the validity of any room alias given in this list before presenting it to the user as trusted fact. The lists given by this event should be considered simply as advice on which aliases might exist, for which the client can perform the lookup to confirm whether it receives the correct room ID.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEventRoomAliases.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="MATRIX-EVENT-TYPE-ROOM-ALIASES:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_ALIASES</h3>
|
||
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_ALIASES (matrix_event_room_aliases_get_type ())
|
||
</pre>
|
||
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="type">MatrixEventRoomAliases</span></a>.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-room-aliases-new"></a><h3>matrix_event_room_aliases_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="returnvalue">MatrixEventRoomAliases</span></a> *
|
||
matrix_event_room_aliases_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-room-aliases-get-aliases"></a><h3>matrix_event_room_aliases_get_aliases ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gchar</span> **
|
||
matrix_event_room_aliases_get_aliases (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="type">MatrixEventRoomAliases</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">"aliases"</span> property.</p>
|
||
<p>A list of room aliases.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.35.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-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="type">MatrixEventRoomAliases</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.35.6.4.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"aliases"</span> property</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-room-aliases-set-aliases"></a><h3>matrix_event_room_aliases_set_aliases ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_room_aliases_set_aliases (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="type">MatrixEventRoomAliases</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">"aliases"</span> property to <em class="parameter"><code>value</code></em>
|
||
.</p>
|
||
<p>A list of room aliases.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.35.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-MatrixEventRoomAliases.html#MatrixEventRoomAliases" title="struct MatrixEventRoomAliases"><span class="type">MatrixEventRoomAliases</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">"aliases"</span> property</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEventRoomAliases.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="MatrixEventRoomAliases"></a><h3>struct MatrixEventRoomAliases</h3>
|
||
<pre class="programlisting">struct MatrixEventRoomAliases {
|
||
MatrixEventState parent_instance;
|
||
MatrixEventRoomAliasesPrivate * priv;
|
||
};
|
||
</pre>
|
||
<p>Class to hold a m.room.aliases event.</p>
|
||
<p>This event is sent by a homeserver directly to inform of changes to the list of aliases it knows about for that room.</p>
|
||
<p>The state_key for this event is set to the homeserver which owns the room alias.</p>
|
||
<p>The entire set of known aliases for the room is the union of all the m.room.aliases events, one for each homeserver. Clients should check the validity of any room alias given in this list before presenting it to the user as trusted fact. The lists given by this event should be considered simply as advice on which aliases might exist, for which the client can perform the lookup to confirm whether it receives the correct room ID.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="MatrixEventRoomAliasesClass"></a><h3>struct MatrixEventRoomAliasesClass</h3>
|
||
<pre class="programlisting">struct MatrixEventRoomAliasesClass {
|
||
MatrixEventStateClass parent_class;
|
||
};
|
||
</pre>
|
||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomAliases.html#MATRIX-EVENT-TYPE-ROOM-ALIASES:CAPS" title="MATRIX_EVENT_TYPE_ROOM_ALIASES"><code class="literal">MATRIX_EVENT_TYPE_ROOM_ALIASES</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.35.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="MatrixEventRoomAliasesClass.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> |