208 lines
11 KiB
HTML
208 lines
11 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>MatrixEventRoomName: 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-MatrixEventCallInvite.html" title="MatrixEventCallInvite">
|
|||
|
|
<link rel="next" href="Matrix-0.0-MatrixEventPresence.html" title="MatrixEventPresence">
|
|||
|
|
<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-MatrixEventRoomName.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-MatrixEventCallInvite.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
|||
|
|
<td><a accesskey="n" href="Matrix-0.0-MatrixEventPresence.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-MatrixEventRoomName"></a><div class="titlepage"></div>
|
|||
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|||
|
|
<td valign="top">
|
|||
|
|
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomName.top_of_page"></a>MatrixEventRoomName</span></h2>
|
|||
|
|
<p>MatrixEventRoomName — Class to hold a m.room.name event.</p>
|
|||
|
|
</td>
|
|||
|
|
<td class="gallery_image" valign="top" align="right"></td>
|
|||
|
|
</tr></table></div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomName.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-MatrixEventRoomName.html#MATRIX-EVENT-TYPE-ROOM-NAME:CAPS" title="MATRIX_EVENT_TYPE_ROOM_NAME">MATRIX_EVENT_TYPE_ROOM_NAME</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="function_type">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="returnvalue">MatrixEventRoomName</span></a> *
|
|||
|
|
</td>
|
|||
|
|
<td class="function_name">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomName.html#matrix-event-room-name-new" title="matrix_event_room_name_new ()">matrix_event_room_name_new</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-MatrixEventRoomName.html#matrix-event-room-name-get-name" title="matrix_event_room_name_get_name ()">matrix_event_room_name_get_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-MatrixEventRoomName.html#matrix-event-room-name-set-name" title="matrix_event_room_name_set_name ()">matrix_event_room_name_set_name</a> <span class="c_punctuation">()</span>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomName.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-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName">MatrixEventRoomName</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="datatype_keyword">struct</td>
|
|||
|
|
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MatrixEventRoomNameClass" title="struct MatrixEventRoomNameClass">MatrixEventRoomNameClass</a></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomName.description"></a><h2>Description</h2>
|
|||
|
|
<p>A room has an opaque room ID which is not human-friendly to read. A room alias is human-friendly, but not all rooms have room aliases. The room name is a human-friendly string designed to be displayed to the end-user. The room name is not unique, as multiple rooms can have the same room name set. The room name can also be set when creating a room using createRoom with the name key.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomName.functions_details"></a><h2>Functions</h2>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MATRIX-EVENT-TYPE-ROOM-NAME:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_NAME</h3>
|
|||
|
|
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_NAME (matrix_event_room_name_get_type ())
|
|||
|
|
</pre>
|
|||
|
|
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="type">MatrixEventRoomName</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-name-new"></a><h3>matrix_event_room_name_new ()</h3>
|
|||
|
|
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="returnvalue">MatrixEventRoomName</span></a> *
|
|||
|
|
matrix_event_room_name_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-name-get-name"></a><h3>matrix_event_room_name_get_name ()</h3>
|
|||
|
|
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
|||
|
|
matrix_event_room_name_get_name (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="type">MatrixEventRoomName</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Get and return the current value of the <span class="type">"name"</span> property.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.6.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-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="type">MatrixEventRoomName</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.6.6.4.6"></a><h4>Returns</h4>
|
|||
|
|
<p> the value of the <span class="type">"name"</span> property</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-name-set-name"></a><h3>matrix_event_room_name_set_name ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_name_set_name (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="type">MatrixEventRoomName</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">"name"</span> property to <em class="parameter"><code>value</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.6.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-MatrixEventRoomName.html#MatrixEventRoomName" title="struct MatrixEventRoomName"><span class="type">MatrixEventRoomName</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">"name"</span> property</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomName.other_details"></a><h2>Types and Values</h2>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MatrixEventRoomName"></a><h3>struct MatrixEventRoomName</h3>
|
|||
|
|
<pre class="programlisting">struct MatrixEventRoomName {
|
|||
|
|
MatrixEventState parent_instance;
|
|||
|
|
MatrixEventRoomNamePrivate * priv;
|
|||
|
|
};
|
|||
|
|
</pre>
|
|||
|
|
<p>Class to hold a m.room.name event.</p>
|
|||
|
|
<p>A room has an opaque room ID which is not human-friendly to read. A room alias is human-friendly, but not all rooms have room aliases. The room name is a human-friendly string designed to be displayed to the end-user. The room name is not unique, as multiple rooms can have the same room name set. The room name can also be set when creating a room using createRoom with the name key.</p>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MatrixEventRoomNameClass"></a><h3>struct MatrixEventRoomNameClass</h3>
|
|||
|
|
<pre class="programlisting">struct MatrixEventRoomNameClass {
|
|||
|
|
MatrixEventStateClass parent_class;
|
|||
|
|
};
|
|||
|
|
</pre>
|
|||
|
|
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomName.html#MATRIX-EVENT-TYPE-ROOM-NAME:CAPS" title="MATRIX_EVENT_TYPE_ROOM_NAME"><code class="literal">MATRIX_EVENT_TYPE_ROOM_NAME</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.6.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="MatrixEventRoomNameClass.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>
|