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

569 lines
27 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>MatrixEventRoom: 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-MatrixEventRoomMember.html" title="MatrixEventRoomMember">
<link rel="next" href="Matrix-0.0-MatrixMessageBase.html" title="MatrixMessageBase">
<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-MatrixEventRoom.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-MatrixEventRoomMember.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixMessageBase.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-MatrixEventRoom"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoom.top_of_page"></a>MatrixEventRoom</span></h2>
<p>MatrixEventRoom — Abstract base class for room events.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoom.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-MatrixEventRoom.html#MATRIX-EVENT-TYPE-ROOM:CAPS" title="MATRIX_EVENT_TYPE_ROOM">MATRIX_EVENT_TYPE_ROOM</a></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-MatrixEventRoom.html#matrix-event-room-get-event-id" title="matrix_event_room_get_event_id ()">matrix_event_room_get_event_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-MatrixEventRoom.html#matrix-event-room-set-event-id" title="matrix_event_room_set_event_id ()">matrix_event_room_set_event_id</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-MatrixEventRoom.html#matrix-event-room-get-room-id" title="matrix_event_room_get_room_id ()">matrix_event_room_get_room_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-MatrixEventRoom.html#matrix-event-room-set-room-id" title="matrix_event_room_set_room_id ()">matrix_event_room_set_room_id</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-MatrixEventRoom.html#matrix-event-room-get-sender" title="matrix_event_room_get_sender ()">matrix_event_room_get_sender</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-MatrixEventRoom.html#matrix-event-room-set-sender" title="matrix_event_room_set_sender ()">matrix_event_room_set_sender</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">glong</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoom.html#matrix-event-room-get-age" title="matrix_event_room_get_age ()">matrix_event_room_get_age</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-MatrixEventRoom.html#matrix-event-room-set-age" title="matrix_event_room_set_age ()">matrix_event_room_set_age</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-MatrixEventRoom.html#matrix-event-room-get-redacted-because" title="matrix_event_room_get_redacted_because ()">matrix_event_room_get_redacted_because</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-MatrixEventRoom.html#matrix-event-room-set-redacted-because" title="matrix_event_room_set_redacted_because ()">matrix_event_room_set_redacted_because</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-MatrixEventRoom.html#matrix-event-room-get-transaction-id" title="matrix_event_room_get_transaction_id ()">matrix_event_room_get_transaction_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-MatrixEventRoom.html#matrix-event-room-set-transaction-id" title="matrix_event_room_set_transaction_id ()">matrix_event_room_set_transaction_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoom.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom">MatrixEventRoom</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoomClass" title="struct MatrixEventRoomClass">MatrixEventRoomClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoom.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoom.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-ROOM:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM (matrix_event_room_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-get-event-id"></a><h3>matrix_event_room_get_event_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_get_event_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"event-id"</span> property.</p>
<p>A globally unique event ID. Required.</p>
<div class="refsect3">
<a name="id-1.2.17.6.3.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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.17.6.3.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"event-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-set-event-id"></a><h3>matrix_event_room_set_event_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_set_event_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"event-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>A globally unique event ID. Required.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"event-id"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-get-room-id"></a><h3>matrix_event_room_get_room_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_get_room_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"room-id"</span> property.</p>
<p>The ID of the room associated with this event. Required, but it may be stripped by HS implementations from some APIs if they reside under a key marked with the room ID.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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.17.6.5.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"room-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-set-room-id"></a><h3>matrix_event_room_set_room_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_set_room_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"room-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The ID of the room associated with this event. Required, but it may be stripped by HS implementations from some APIs if they reside under a key marked with the room ID.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"room-id"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-get-sender"></a><h3>matrix_event_room_get_sender ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_get_sender (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"sender"</span> property.</p>
<p>The fully qualified Matrix ID of the user who sent the event. Required.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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.17.6.7.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"sender"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-set-sender"></a><h3>matrix_event_room_set_sender ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_set_sender (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"sender"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The fully qualified Matrix ID of the user who sent the event. Required.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"sender"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-get-age"></a><h3>matrix_event_room_get_age ()</h3>
<pre class="programlisting"><span class="returnvalue">glong</span>
matrix_event_room_get_age (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"age"</span> property.</p>
<p>The time, in milliseconds, that has elapsed since the event was sent. This is part of the unsigned event data.</p>
<p>This value will be omitted from the generated event JSON if less than zero.</p>
<div class="refsect3">
<a name="id-1.2.17.6.9.7"></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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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.17.6.9.8"></a><h4>Returns</h4>
<p> the value of the <span class="type">"age"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-set-age"></a><h3>matrix_event_room_set_age ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_set_age (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">glong</span> value</code></em>);</pre>
<p>Set the value of the <span class="type">"age"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The time, in milliseconds, that has elapsed since the event was sent. This is part of the unsigned event data.</p>
<p>This value will be omitted from the generated event JSON if less than zero.</p>
<div class="refsect3">
<a name="id-1.2.17.6.10.7"></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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"age"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-get-redacted-because"></a><h3>matrix_event_room_get_redacted_because ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_get_redacted_because
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"redacted-because"</span> property.</p>
<p>The reason this event was redacted, if it was redacted.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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.17.6.11.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"redacted-because"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-set-redacted-because"></a><h3>matrix_event_room_set_redacted_because ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_set_redacted_because
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"redacted-because"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The reason this event was redacted, if it was redacted.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"redacted-because"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-get-transaction-id"></a><h3>matrix_event_room_get_transaction_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_get_transaction_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"transaction-id"</span> property.</p>
<p>The client-supplied transaction ID. This should only be set if the client being given the event is the same one which sent it.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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.17.6.13.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"transaction-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-set-transaction-id"></a><h3>matrix_event_room_set_transaction_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_set_transaction_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"transaction-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The client-supplied transaction ID. This should only be set if the client being given the event is the same one which sent it.</p>
<div class="refsect3">
<a name="id-1.2.17.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-MatrixEventRoom.html#MatrixEventRoom" title="struct MatrixEventRoom"><span class="type">MatrixEventRoom</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">"transaction-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-MatrixEventRoom.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventRoom"></a><h3>struct MatrixEventRoom</h3>
<pre class="programlisting">struct MatrixEventRoom {
MatrixEventBase parent_instance;
MatrixEventRoomPrivate * priv;
};
</pre>
<p>Abstract base class for room events.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventRoomClass"></a><h3>struct MatrixEventRoomClass</h3>
<pre class="programlisting">struct MatrixEventRoomClass {
MatrixEventBaseClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoom.html#MATRIX-EVENT-TYPE-ROOM:CAPS" title="MATRIX_EVENT_TYPE_ROOM"><code class="literal">MATRIX_EVENT_TYPE_ROOM</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.17.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-MatrixEventBase.html#MatrixEventBaseClass" title="struct MatrixEventBaseClass"><span class="type">MatrixEventBaseClass</span></a> <em class="structfield"><code><a name="MatrixEventRoomClass.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