916 lines
44 KiB
HTML
916 lines
44 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>Matrix-0.0 Reference Manual: MatrixEvent</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-matrix-enums.html" title="matrix-enums">
|
||
<link rel="next" href="Matrix-0.0-MatrixRoomMemberEvent.html" title="MatrixRoomMemberEvent">
|
||
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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-MatrixEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#Matrix-0.0-MatrixEvent.object-hierarchy" class="shortcut">Object Hierarchy</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-matrix-enums.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="Matrix-0.0-MatrixRoomMemberEvent.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-MatrixEvent"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEvent.top_of_page"></a>MatrixEvent</span></h2>
|
||
<p>MatrixEvent — Base class for Matrix events.</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEvent.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-MatrixEvent.html#MATRIX-TYPE-EVENT:CAPS" title="MATRIX_TYPE_EVENT">MATRIX_TYPE_EVENT</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-from-json" title="matrix_event_from_json ()">matrix_event_from_json</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-MatrixEvent.html#matrix-event-to-json" title="matrix_event_to_json ()">matrix_event_to_json</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-MatrixEvent.html#matrix-event-set-custom-field" title="matrix_event_set_custom_field ()">matrix_event_set_custom_field</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-MatrixEvent.html#matrix-event-get-custom-field" title="matrix_event_get_custom_field ()">matrix_event_get_custom_field</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-MatrixEvent.html#matrix-event-delete-custom-field" title="matrix_event_delete_custom_field ()">matrix_event_delete_custom_field</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="returnvalue">MatrixEvent</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-new" title="matrix_event_new ()">matrix_event_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-get-sender" title="matrix_event_get_sender ()">matrix_event_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-MatrixEvent.html#matrix-event-set-sender" title="matrix_event_set_sender ()">matrix_event_set_sender</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-get-room-id" title="matrix_event_get_room_id ()">matrix_event_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-MatrixEvent.html#matrix-event-set-room-id" title="matrix_event_set_room_id ()">matrix_event_set_room_id</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-get-event-type" title="matrix_event_get_event_type ()">matrix_event_get_event_type</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-get-origin-server-ts" title="matrix_event_get_origin_server_ts ()">matrix_event_get_origin_server_ts</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-MatrixEvent.html#matrix-event-set-origin-server-ts" title="matrix_event_set_origin_server_ts ()">matrix_event_set_origin_server_ts</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="Matrix-0.0-MatrixJsonCompact.html#MatrixUnsignedEventData" title="struct MatrixUnsignedEventData"><span class="returnvalue">MatrixUnsignedEventData</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-get-unsigned-data" title="matrix_event_get_unsigned_data ()">matrix_event_get_unsigned_data</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-MatrixEvent.html#matrix-event-set-unsigned-data" title="matrix_event_set_unsigned_data ()">matrix_event_set_unsigned_data</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-MatrixEvent.html#matrix-event-get-json" title="matrix_event_get_json ()">matrix_event_get_json</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="returnvalue">MatrixEvent</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-new-from-json" title="matrix_event_new_from_json ()">matrix_event_new_from_json</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-get-handler" title="matrix_event_get_handler ()">matrix_event_get_handler</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-MatrixEvent.html#matrix-event-register-type" title="matrix_event_register_type ()">matrix_event_register_type</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-MatrixEvent.html#matrix-event-unregister-type" title="matrix_event_unregister_type ()">matrix_event_unregister_type</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEvent.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent">MatrixEvent</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEventClass" title="struct MatrixEventClass">MatrixEventClass</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen">
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEvent.description"></a><h2>Description</h2>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEvent.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="MATRIX-TYPE-EVENT:CAPS"></a><h3>MATRIX_TYPE_EVENT</h3>
|
||
<pre class="programlisting">#define MATRIX_TYPE_EVENT (matrix_event_get_type ())
|
||
</pre>
|
||
<p>The type for <a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a>.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-from-json"></a><h3>matrix_event_from_json ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_from_json (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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> *json_data</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||
<p>Subclasses should implement this function to initialize themselves from JSON data.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.3.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> instance</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>json_data</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>error</p></td>
|
||
<td class="parameter_description"><p> location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> MatrixError]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-to-json"></a><h3>matrix_event_to_json ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_to_json (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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> *json_data</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||
<p>Subclasses should implement this to export their data to JSON.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> instance</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>json_data</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>error</p></td>
|
||
<td class="parameter_description"><p> location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> MatrixError]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-set-custom-field"></a><h3>matrix_event_set_custom_field ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_set_custom_field (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field_name</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 a value for a custom field.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> instance</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>field_name</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>value</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-get-custom-field"></a><h3>matrix_event_get_custom_field ()</h3>
|
||
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
|
||
matrix_event_get_custom_field (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field_name</code></em>);</pre>
|
||
<p>Get the value of a custom field.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.6.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> instance</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>field_name</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-delete-custom-field"></a><h3>matrix_event_delete_custom_field ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_delete_custom_field (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field_name</code></em>);</pre>
|
||
<p>Delete a custom field.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> instance</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>field_name</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-new"></a><h3>matrix_event_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="returnvalue">MatrixEvent</span></a> *
|
||
matrix_event_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-get-sender"></a><h3>matrix_event_get_sender ()</h3>
|
||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
matrix_event_get_sender (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>);</pre>
|
||
<p>Get and return the current value of the <span class="type">"sender"</span> property.</p>
|
||
<p>The Matrix ID of the events sender.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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.5.7.9.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"sender"</span> property</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-set-sender"></a><h3>matrix_event_set_sender ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_set_sender (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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 Matrix ID of the events sender.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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-get-room-id"></a><h3>matrix_event_get_room_id ()</h3>
|
||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
matrix_event_get_room_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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 this event is associated with.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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.5.7.11.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"room-id"</span> property</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-set-room-id"></a><h3>matrix_event_set_room_id ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_set_room_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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 this event is associated with.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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-get-event-type"></a><h3>matrix_event_get_event_type ()</h3>
|
||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
matrix_event_get_event_type (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>);</pre>
|
||
<p>Get and return the current value of the <span class="type">"event-type"</span> property.</p>
|
||
<p>The type of the event.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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.5.7.13.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"event-type"</span> property</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-get-origin-server-ts"></a><h3>matrix_event_get_origin_server_ts ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> *
|
||
matrix_event_get_origin_server_ts (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>);</pre>
|
||
<p>Get and return the current value of the <span class="type">"origin-server-ts"</span> property.</p>
|
||
<p>The timestamp of the event on the originating server.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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.5.7.14.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"origin-server-ts"</span> property</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-set-origin-server-ts"></a><h3>matrix_event_set_origin_server_ts ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_set_origin_server_ts (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *value</code></em>);</pre>
|
||
<p>Set the value of the <span class="type">"origin-server-ts"</span> property to <em class="parameter"><code>value</code></em>
|
||
.</p>
|
||
<p>The timestamp of the event on the originating server.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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">"origin-server-ts"</span> property</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-get-unsigned-data"></a><h3>matrix_event_get_unsigned_data ()</h3>
|
||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixJsonCompact.html#MatrixUnsignedEventData" title="struct MatrixUnsignedEventData"><span class="returnvalue">MatrixUnsignedEventData</span></a> *
|
||
matrix_event_get_unsigned_data (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>);</pre>
|
||
<p>Get and return the current value of the <span class="type">"unsigned-data"</span> property.</p>
|
||
<p>The unsigned part of the event.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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.5.7.16.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"unsigned-data"</span> property</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-set-unsigned-data"></a><h3>matrix_event_set_unsigned_data ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_set_unsigned_data (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>,
|
||
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixJsonCompact.html#MatrixUnsignedEventData" title="struct MatrixUnsignedEventData"><span class="type">MatrixUnsignedEventData</span></a> *value</code></em>);</pre>
|
||
<p>Set the value of the <span class="type">"unsigned-data"</span> property to <em class="parameter"><code>value</code></em>
|
||
.</p>
|
||
<p>The unsigned part of the event.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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">"unsigned-data"</span> property</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-get-json"></a><h3>matrix_event_get_json ()</h3>
|
||
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
|
||
matrix_event_get_json (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *self</code></em>);</pre>
|
||
<p>Get and return the current value of the <span class="type">"json"</span> property.</p>
|
||
<p>The event as a JSON node.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.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-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</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.5.7.18.7"></a><h4>Returns</h4>
|
||
<p> the value of the <span class="type">"json"</span> property</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-new-from-json"></a><h3>matrix_event_new_from_json ()</h3>
|
||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="returnvalue">MatrixEvent</span></a> *
|
||
matrix_event_new_from_json (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
|
||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *room_id</code></em>,
|
||
<em class="parameter"><code><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="type">JsonNode</span></a> *json_data</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.19.4"></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>event_type</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>room_id</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>json_data</p></td>
|
||
<td class="parameter_description"><p> </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>error</p></td>
|
||
<td class="parameter_description"><p> location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> MatrixError]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-get-handler"></a><h3>matrix_event_get_handler ()</h3>
|
||
<pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
|
||
matrix_event_get_handler (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>);</pre>
|
||
<p>Get the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the class that is registered to handle events with type <em class="parameter"><code>param</code></em>
|
||
event_type.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.20.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>event_type</p></td>
|
||
<td class="parameter_description">
|
||
<p> . </p>
|
||
<p>the event type to look up </p>
|
||
<p>. </p>
|
||
</td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.20.6"></a><h4>Returns</h4>
|
||
<p>a <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> or <a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> if no handler is registered </p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-register-type"></a><h3>matrix_event_register_type ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_register_type (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
|
||
<em class="parameter"><code><a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> event_gtype</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||
<p>Registers <em class="parameter"><code>param</code></em>
|
||
event_type to be handled by the type <em class="parameter"><code>param</code></em>
|
||
event_gtype.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.21.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>event_type</p></td>
|
||
<td class="parameter_description">
|
||
<p> . </p>
|
||
<p>the type of the event </p>
|
||
<p>. </p>
|
||
</td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>event_gtype</p></td>
|
||
<td class="parameter_description">
|
||
<p> . </p>
|
||
<p>the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the event’s handler </p>
|
||
<p>. </p>
|
||
</td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>error</p></td>
|
||
<td class="parameter_description"><p> location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> MatrixError]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-event-unregister-type"></a><h3>matrix_event_unregister_type ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
matrix_event_unregister_type (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>);</pre>
|
||
<p>Unregister <em class="parameter"><code>param</code></em>
|
||
event_type.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.2.5.7.22.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>event_type</p></td>
|
||
<td class="parameter_description">
|
||
<p> . </p>
|
||
<p>the event type to remove </p>
|
||
<p>. </p>
|
||
</td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixEvent.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="MatrixEvent"></a><h3>struct MatrixEvent</h3>
|
||
<pre class="programlisting">struct MatrixEvent {
|
||
GObject parent_instance;
|
||
MatrixEventPrivate * priv;
|
||
gchar* _sender;
|
||
gchar* _room_id;
|
||
};
|
||
</pre>
|
||
<p>Base class for Matrix events.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="MatrixEventClass"></a><h3>struct MatrixEventClass</h3>
|
||
<pre class="programlisting">struct MatrixEventClass {
|
||
GObjectClass parent_class;
|
||
void (*from_json) (MatrixEvent* self, JsonNode* json_data, GError** error);
|
||
void (*to_json) (MatrixEvent* self, JsonNode* json_data, GError** error);
|
||
};
|
||
</pre>
|
||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEvent.html#MATRIX-TYPE-EVENT:CAPS" title="MATRIX_TYPE_EVENT"><code class="literal">MATRIX_TYPE_EVENT</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.5.8.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 href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="MatrixEventClass.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>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixEventClass.from-json"></a>from_json</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-from-json" title="matrix_event_from_json ()"><code class="function">matrix_event_from_json()</code></a></p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixEventClass.to-json"></a>to_json</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixEvent.html#matrix-event-to-json" title="matrix_event_to_json ()"><code class="function">matrix_event_to_json()</code></a></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.20</div>
|
||
</body>
|
||
</html> |