Initial commit for the current development version
This commit is contained in:
Gergely Polonkai
commit
3444a3b1f9
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
/_site/
|
||||
6376
Matrix-0.0-MatrixAPI.html
Normal file
6376
Matrix-0.0-MatrixAPI.html
Normal file
File diff suppressed because it is too large
Load Diff
665
Matrix-0.0-MatrixClient.html
Normal file
665
Matrix-0.0-MatrixClient.html
Normal file
@ -0,0 +1,665 @@
|
||||
<!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: MatrixClient</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-MatrixRoomMemberEvent.html" title="MatrixRoomMemberEvent">
|
||||
<link rel="next" href="Matrix-0.0-MatrixJsonCompact.html" title="MatrixJsonCompact">
|
||||
<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-MatrixClient.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixClient.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-MatrixRoomMemberEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixJsonCompact.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-MatrixClient"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixClient.top_of_page"></a>MatrixClient</span></h2>
|
||||
<p>MatrixClient — Base interface for client communication with a Matrix.org homeserver</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixClient.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="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixClient.html#matrix-client-login-with-password" title="matrix_client_login_with_password ()">matrix_client_login_with_password</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-MatrixClient.html#matrix-client-register-with-password" title="matrix_client_register_with_password ()">matrix_client_register_with_password</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-MatrixClient.html#matrix-client-logout" title="matrix_client_logout ()">matrix_client_logout</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-MatrixClient.html#matrix-client-begin-polling" title="matrix_client_begin_polling ()">matrix_client_begin_polling</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-MatrixClient.html#matrix-client-stop-polling" title="matrix_client_stop_polling ()">matrix_client_stop_polling</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-MatrixClient.html#matrix-client-emit-login-finished" title="matrix_client_emit_login_finished ()">matrix_client_emit_login_finished</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-MatrixClient.html#matrix-client-incoming-event" title="matrix_client_incoming_event ()">matrix_client_incoming_event</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-MatrixClient.html#matrix-client-connect-event" title="matrix_client_connect_event ()">matrix_client_connect_event</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<span class="c_punctuation">(</span><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClientEventCallback" title="MatrixClientEventCallback ()">*MatrixClientEventCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixClient.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"> </td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient">MatrixClient</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClientIface" title="struct MatrixClientIface">MatrixClientIface</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixClient.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixClient.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixClient.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-client-login-with-password"></a><h3>matrix_client_login_with_password ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_login_with_password (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</code></em>,
|
||||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
|
||||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</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>Authenticate with the Matrix.org server with a username and password.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.7.2.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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>username</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the username to login with </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>password</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the password to use </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-client-register-with-password"></a><h3>matrix_client_register_with_password ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_register_with_password (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</code></em>,
|
||||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
|
||||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</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>Register <em class="parameter"><code>username</code></em>
|
||||
with the homeserver as a normal user.</p>
|
||||
<p>Upon success, the user is registered and authenticated.</p>
|
||||
<p>Implementations must emit the login-finished signal when a response arrives.</p>
|
||||
<p>This method registers a normal user account. If you want to register a different kind of user, use <a class="link" href="Matrix-0.0-MatrixAPI.html#matrix-api-register-account" title="matrix_api_register_account ()"><code class="function">matrix_api_register_account()</code></a>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.7.3.8"></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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>username</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the username to register. If omitted, the server will generate one </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>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>password</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the password to use with the registration </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-client-logout"></a><h3>matrix_client_logout ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_logout (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</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>Logout from the homeserver. As Matrix.org doesn’t have such a concept, this cancels all ongoing requests and clears the authentication data (e.g. tokens).</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</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-client-begin-polling"></a><h3>matrix_client_begin_polling ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_begin_polling (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</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>Begin polling the event stream.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</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-client-stop-polling"></a><h3>matrix_client_stop_polling ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_stop_polling (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</code></em>,
|
||||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> cancel_ongoing</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>Stop polling the event stream. If <em class="parameter"><code>param</code></em>
|
||||
cancel_ongoing is </p>
|
||||
<div class="informalexample"><pre class="programlisting">
|
||||
true
|
||||
</pre></div>
|
||||
<p>
|
||||
, ongoing requests will be cancelled, too.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.7.6.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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>cancel_ongoing</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>if </p>
|
||||
<p>
|
||||
</p>
|
||||
<div class="informalexample"><pre class="programlisting">
|
||||
true
|
||||
</pre></div>
|
||||
<p>
|
||||
</p>
|
||||
<p>
|
||||
, ongoing requests will be cancelled, too </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-client-emit-login-finished"></a><h3>matrix_client_emit_login_finished ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_emit_login_finished (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</code></em>,
|
||||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> success</code></em>);</pre>
|
||||
<p>Convenience function to emits the login-finished signal.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>success</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>set to </p>
|
||||
<p>
|
||||
</p>
|
||||
<div class="informalexample"><pre class="programlisting">
|
||||
true
|
||||
</pre></div>
|
||||
<p>
|
||||
</p>
|
||||
<p>
|
||||
if login was successful </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>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-client-incoming-event"></a><h3>matrix_client_incoming_event ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_incoming_event (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</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> *raw_event</code></em>,
|
||||
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *matrix_event</code></em>);</pre>
|
||||
<p>Emits the <span class="type">“event”</span> signal.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.7.8.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-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>room_id</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the room this event is associated with </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>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>raw_event</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the raw 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>matrix_event</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the event as a Matrix.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>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-client-connect-event"></a><h3>matrix_client_connect_event ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_client_connect_event (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *self</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 class="link" href="Matrix-0.0-MatrixClient.html#MatrixClientEventCallback" title="MatrixClientEventCallback ()"><span class="type">MatrixClientEventCallback</span></a> event_callback</code></em>,
|
||||
<em class="parameter"><code><span class="type">void</span> *event_callback_target</code></em>,
|
||||
<em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> event_callback_target_destroy_notify</code></em>);</pre>
|
||||
<p>Connect a handler for events. If <em class="parameter"><code>param</code></em>
|
||||
event_gtype is Matrix.Event, all events will be sent to the callback function, otherwise only events that match the specified event type.</p>
|
||||
<p>If <em class="parameter"><code>event_gtype</code></em> is not derived from <a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a>, <em class="parameter"><code>param</code></em> callback won’t get connected.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.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>callback</p></td>
|
||||
<td class="parameter_description"><p>the allback function to connect </p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>self</p></td>
|
||||
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> instance</p></td>
|
||||
<td class="parameter_annotations"> </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 a <a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> derivative </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_callback_target</p></td>
|
||||
<td class="parameter_description"><p> user data to pass to <em class="parameter"><code>event_callback</code></em>
|
||||
. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>event_callback_target_destroy_notify</p></td>
|
||||
<td class="parameter_description"><p> function to call when <em class="parameter"><code>event_callback_target</code></em>
|
||||
is no longer needed. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>event_callback</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="MatrixClientEventCallback"></a><h3>MatrixClientEventCallback ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
<span class="c_punctuation">(</span>*MatrixClientEventCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> *client</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> *raw_event</code></em>,
|
||||
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEvent" title="struct MatrixEvent"><span class="type">MatrixEvent</span></a> *matrix_event</code></em>,
|
||||
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
|
||||
<p>Callback function delegate for the event signal.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.7.10.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>room_id</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the room the event associated with </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>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>raw_event</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the event as a raw JSON object </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>matrix_event</p></td>
|
||||
<td class="parameter_description">
|
||||
<p> . </p>
|
||||
<p>the event as a Matrix.Event object </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>client</p></td>
|
||||
<td class="parameter_description"><p> </p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>user_data</p></td>
|
||||
<td class="parameter_description"><p> data to pass to the delegate function. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixClient.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixClient"></a><h3>MatrixClient</h3>
|
||||
<pre class="programlisting">typedef struct _MatrixClient MatrixClient;</pre>
|
||||
<p>Base interface for client communication with a Matrix.org homeserver</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixClientIface"></a><h3>struct MatrixClientIface</h3>
|
||||
<pre class="programlisting">struct MatrixClientIface {
|
||||
GTypeInterface parent_iface;
|
||||
void (*login_with_password) (MatrixClient* self, const gchar* username, const gchar* password, GError** error);
|
||||
void (*register_with_password) (MatrixClient* self, const gchar* username, const gchar* password, GError** error);
|
||||
void (*logout) (MatrixClient* self, GError** error);
|
||||
void (*begin_polling) (MatrixClient* self, GError** error);
|
||||
void (*stop_polling) (MatrixClient* self, gboolean cancel_ongoing, GError** error);
|
||||
void (*login_finished) (MatrixClient* self, gboolean success);
|
||||
void (*event) (MatrixClient* self, const gchar* room_id, JsonNode* raw_event, MatrixEvent* matrix_event);
|
||||
};
|
||||
</pre>
|
||||
<p>Interface for creating <a class="link" href="Matrix-0.0-MatrixClient.html#MatrixClient" title="MatrixClient"><span class="type">MatrixClient</span></a> implementations.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.7.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-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="MatrixClientIface.parent-iface"></a>parent_iface</code></em>;</p></td>
|
||||
<td class="struct_member_description"><p>the parent interface structure</p></td>
|
||||
<td class="struct_member_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.login-with-password"></a>login_with_password</code></em> ()</p></td>
|
||||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixClient.html#matrix-client-login-with-password" title="matrix_client_login_with_password ()"><code class="function">matrix_client_login_with_password()</code></a></p></td>
|
||||
<td class="struct_member_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.register-with-password"></a>register_with_password</code></em> ()</p></td>
|
||||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixClient.html#matrix-client-register-with-password" title="matrix_client_register_with_password ()"><code class="function">matrix_client_register_with_password()</code></a></p></td>
|
||||
<td class="struct_member_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.logout"></a>logout</code></em> ()</p></td>
|
||||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixClient.html#matrix-client-logout" title="matrix_client_logout ()"><code class="function">matrix_client_logout()</code></a></p></td>
|
||||
<td class="struct_member_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.begin-polling"></a>begin_polling</code></em> ()</p></td>
|
||||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixClient.html#matrix-client-begin-polling" title="matrix_client_begin_polling ()"><code class="function">matrix_client_begin_polling()</code></a></p></td>
|
||||
<td class="struct_member_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.stop-polling"></a>stop_polling</code></em> ()</p></td>
|
||||
<td class="struct_member_description"><p>virtual method called by <a class="link" href="Matrix-0.0-MatrixClient.html#matrix-client-stop-polling" title="matrix_client_stop_polling ()"><code class="function">matrix_client_stop_polling()</code></a></p></td>
|
||||
<td class="struct_member_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.login-finished"></a>login_finished</code></em> ()</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="struct_member_name"><p><em class="structfield"><code><a name="MatrixClientIface.event"></a>event</code></em> ()</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
916
Matrix-0.0-MatrixEvent.html
Normal file
916
Matrix-0.0-MatrixEvent.html
Normal file
@ -0,0 +1,916 @@
|
||||
<!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>
|
||||
313
Matrix-0.0-MatrixHTTPAPI.html
Normal file
313
Matrix-0.0-MatrixHTTPAPI.html
Normal file
@ -0,0 +1,313 @@
|
||||
<!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: MatrixHTTPAPI</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-c-api.html" title="c-api">
|
||||
<link rel="next" href="Matrix-0.0-MatrixAPI.html" title="MatrixAPI">
|
||||
<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-MatrixHTTPAPI.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixHTTPAPI.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-c-api.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixAPI.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-MatrixHTTPAPI"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixHTTPAPI.top_of_page"></a>MatrixHTTPAPI</span></h2>
|
||||
<p>MatrixHTTPAPI — This is a class for low level communication with a Matrix.org server via HTTP.</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPAPI.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-MatrixHTTPAPI.html#MATRIX-TYPE-HTTP-API:CAPS" title="MATRIX_TYPE_HTTP_API">MATRIX_TYPE_HTTP_API</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="returnvalue">MatrixHTTPAPI</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#matrix-http-api-new" title="matrix_http_api_new ()">matrix_http_api_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-MatrixHTTPAPI.html#matrix-http-api-get-base-url" title="matrix_http_api_get_base_url ()">matrix_http_api_get_base_url</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#matrix-http-api-set-base-url" title="matrix_http_api_set_base_url ()">matrix_http_api_set_base_url</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#matrix-http-api-get-validate-certificate" title="matrix_http_api_get_validate_certificate ()">matrix_http_api_get_validate_certificate</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-MatrixHTTPAPI.html#matrix-http-api-set-validate-certificate" title="matrix_http_api_set_validate_certificate ()">matrix_http_api_set_validate_certificate</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPAPI.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-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI">MatrixHTTPAPI</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPIClass" title="struct MatrixHTTPAPIClass">MatrixHTTPAPIClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPAPI.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPAPI.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPAPI.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-HTTP-API:CAPS"></a><h3>MATRIX_TYPE_HTTP_API</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_HTTP_API (matrix_http_api_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</span></a>.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-http-api-new"></a><h3>matrix_http_api_new ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="returnvalue">MatrixHTTPAPI</span></a> *
|
||||
matrix_http_api_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_url</code></em>,
|
||||
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>);</pre>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.13.7.3.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>base_url</p></td>
|
||||
<td class="parameter_description"><p> </p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>token</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-http-api-get-base-url"></a><h3>matrix_http_api_get_base_url ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_http_api_get_base_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"base-url"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.13.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-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</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.13.7.4.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"base-url"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-http-api-set-base-url"></a><h3>matrix_http_api_set_base_url ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_http_api_set_base_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</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">"base-url"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.13.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-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</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">"base-url"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-http-api-get-validate-certificate"></a><h3>matrix_http_api_get_validate_certificate ()</h3>
|
||||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
matrix_http_api_get_validate_certificate
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"validate-certificate"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.13.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-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</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.13.7.6.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"validate-certificate"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-http-api-set-validate-certificate"></a><h3>matrix_http_api_set_validate_certificate ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_http_api_set_validate_certificate
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</span></a> *self</code></em>,
|
||||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
|
||||
<p>Set the value of the <span class="type">"validate-certificate"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.13.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-MatrixHTTPAPI.html#MatrixHTTPAPI" title="struct MatrixHTTPAPI"><span class="type">MatrixHTTPAPI</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">"validate-certificate"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPAPI.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixHTTPAPI"></a><h3>struct MatrixHTTPAPI</h3>
|
||||
<pre class="programlisting">struct MatrixHTTPAPI {
|
||||
GObject parent_instance;
|
||||
MatrixHTTPAPIPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
<p>This is a class for low level communication with a Matrix.org server via HTTP.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixHTTPAPIClass"></a><h3>struct MatrixHTTPAPIClass</h3>
|
||||
<pre class="programlisting">struct MatrixHTTPAPIClass {
|
||||
GObjectClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MATRIX-TYPE-HTTP-API:CAPS" title="MATRIX_TYPE_HTTP_API"><code class="literal">MATRIX_TYPE_HTTP_API</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.13.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="MatrixHTTPAPIClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
156
Matrix-0.0-MatrixHTTPClient.html
Normal file
156
Matrix-0.0-MatrixHTTPClient.html
Normal file
@ -0,0 +1,156 @@
|
||||
<!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: MatrixHTTPClient</title>
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
||||
<link rel="home" href="index.html" title="Matrix-0.0 Reference Manual">
|
||||
<link rel="up" href="ch01.html" title="Matrix-0.0 API Reference">
|
||||
<link rel="prev" href="Matrix-0.0-MatrixJsonCompact.html" title="MatrixJsonCompact">
|
||||
<link rel="next" href="Matrix-0.0-MatrixStateEvent.html" title="MatrixStateEvent">
|
||||
<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-MatrixHTTPClient.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixHTTPClient.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-MatrixJsonCompact.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixStateEvent.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-MatrixHTTPClient"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixHTTPClient.top_of_page"></a>MatrixHTTPClient</span></h2>
|
||||
<p>MatrixHTTPClient — An event-driven client class to communicate with HTTP based Matrix.org servers.</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPClient.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-MatrixHTTPClient.html#MATRIX-TYPE-HTTP-CLIENT:CAPS" title="MATRIX_TYPE_HTTP_CLIENT">MATRIX_TYPE_HTTP_CLIENT</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-MatrixHTTPClient.html#MatrixHTTPClient" title="struct MatrixHTTPClient"><span class="returnvalue">MatrixHTTPClient</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixHTTPClient.html#matrix-http-client-new" title="matrix_http_client_new ()">matrix_http_client_new</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPClient.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-MatrixHTTPClient.html#MatrixHTTPClient" title="struct MatrixHTTPClient">MatrixHTTPClient</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixHTTPClient.html#MatrixHTTPClientClass" title="struct MatrixHTTPClientClass">MatrixHTTPClientClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPClient.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPClient.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPClient.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-HTTP-CLIENT:CAPS"></a><h3>MATRIX_TYPE_HTTP_CLIENT</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_HTTP_CLIENT (matrix_http_client_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixHTTPClient.html#MatrixHTTPClient" title="struct MatrixHTTPClient"><span class="type">MatrixHTTPClient</span></a>.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-http-client-new"></a><h3>matrix_http_client_new ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixHTTPClient.html#MatrixHTTPClient" title="struct MatrixHTTPClient"><span class="returnvalue">MatrixHTTPClient</span></a> *
|
||||
matrix_http_client_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_url</code></em>);</pre>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.9.7.3.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>base_url</p></td>
|
||||
<td class="parameter_description"><p> </p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr></tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixHTTPClient.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixHTTPClient"></a><h3>struct MatrixHTTPClient</h3>
|
||||
<pre class="programlisting">struct MatrixHTTPClient {
|
||||
MatrixHTTPAPI parent_instance;
|
||||
MatrixHTTPClientPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
<p>An event-driven client class to communicate with HTTP based Matrix.org servers.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixHTTPClientClass"></a><h3>struct MatrixHTTPClientClass</h3>
|
||||
<pre class="programlisting">struct MatrixHTTPClientClass {
|
||||
MatrixHTTPAPIClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixHTTPClient.html#MATRIX-TYPE-HTTP-CLIENT:CAPS" title="MATRIX_TYPE_HTTP_CLIENT"><code class="literal">MATRIX_TYPE_HTTP_CLIENT</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.9.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 class="link" href="Matrix-0.0-MatrixHTTPAPI.html#MatrixHTTPAPIClass" title="struct MatrixHTTPAPIClass"><span class="type">MatrixHTTPAPIClass</span></a> <em class="structfield"><code><a name="MatrixHTTPClientClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
4642
Matrix-0.0-MatrixJsonCompact.html
Normal file
4642
Matrix-0.0-MatrixJsonCompact.html
Normal file
File diff suppressed because it is too large
Load Diff
441
Matrix-0.0-MatrixPresenceEvent.html
Normal file
441
Matrix-0.0-MatrixPresenceEvent.html
Normal file
@ -0,0 +1,441 @@
|
||||
<!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: MatrixPresenceEvent</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-MatrixRoomEvent.html" title="MatrixRoomEvent">
|
||||
<link rel="next" href="Matrix-0.0-matrix-enums.html" title="matrix-enums">
|
||||
<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-MatrixPresenceEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixPresenceEvent.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-MatrixRoomEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-matrix-enums.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-MatrixPresenceEvent"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixPresenceEvent.top_of_page"></a>MatrixPresenceEvent</span></h2>
|
||||
<p>MatrixPresenceEvent — Class for representing presence events</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixPresenceEvent.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-MatrixPresenceEvent.html#MATRIX-TYPE-PRESENCE-EVENT:CAPS" title="MATRIX_TYPE_PRESENCE_EVENT">MATRIX_TYPE_PRESENCE_EVENT</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="returnvalue">MatrixPresenceEvent</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#matrix-presence-event-new" title="matrix_presence_event_new ()">matrix_presence_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-MatrixPresenceEvent.html#matrix-presence-event-get-avatar-url" title="matrix_presence_event_get_avatar_url ()">matrix_presence_event_get_avatar_url</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#matrix-presence-event-set-avatar-url" title="matrix_presence_event_set_avatar_url ()">matrix_presence_event_set_avatar_url</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-MatrixPresenceEvent.html#matrix-presence-event-get-display-name" title="matrix_presence_event_get_display_name ()">matrix_presence_event_get_display_name</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#matrix-presence-event-set-display-name" title="matrix_presence_event_set_display_name ()">matrix_presence_event_set_display_name</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-MatrixPresenceEvent.html#matrix-presence-event-get-last-active-ago" title="matrix_presence_event_get_last_active_ago ()">matrix_presence_event_get_last_active_ago</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-MatrixPresenceEvent.html#matrix-presence-event-set-last-active-ago" title="matrix_presence_event_set_last_active_ago ()">matrix_presence_event_set_last_active_ago</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-matrix-enums.html#MatrixPresence" title="enum MatrixPresence"><span class="returnvalue">MatrixPresence</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#matrix-presence-event-get-presence" title="matrix_presence_event_get_presence ()">matrix_presence_event_get_presence</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-MatrixPresenceEvent.html#matrix-presence-event-set-presence" title="matrix_presence_event_set_presence ()">matrix_presence_event_set_presence</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixPresenceEvent.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent">MatrixPresenceEvent</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEventClass" title="struct MatrixPresenceEventClass">MatrixPresenceEventClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixPresenceEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixPresenceEvent.description"></a><h2>Description</h2>
|
||||
<p>The presence event class.</p>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixPresenceEvent.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-PRESENCE-EVENT:CAPS"></a><h3>MATRIX_TYPE_PRESENCE_EVENT</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_PRESENCE_EVENT (matrix_presence_event_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a>.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-new"></a><h3>matrix_presence_event_new ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="returnvalue">MatrixPresenceEvent</span></a> *
|
||||
matrix_presence_event_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-get-avatar-url"></a><h3>matrix_presence_event_get_avatar_url ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_presence_event_get_avatar_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"avatar-url"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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.3.7.4.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"avatar-url"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-set-avatar-url"></a><h3>matrix_presence_event_set_avatar_url ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_presence_event_set_avatar_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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">"avatar-url"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> instance to modify</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>value</p></td>
|
||||
<td class="parameter_description"><p>the new value of the <span class="type">"avatar-url"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-get-display-name"></a><h3>matrix_presence_event_get_display_name ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_presence_event_get_display_name
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"display-name"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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.3.7.6.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"display-name"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-set-display-name"></a><h3>matrix_presence_event_set_display_name ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_presence_event_set_display_name
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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">"display-name"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> instance to modify</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>value</p></td>
|
||||
<td class="parameter_description"><p>the new value of the <span class="type">"display-name"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-get-last-active-ago"></a><h3>matrix_presence_event_get_last_active_ago ()</h3>
|
||||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> *
|
||||
matrix_presence_event_get_last_active_ago
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"last-active-ago"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.7.8.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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.3.7.8.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"last-active-ago"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-set-last-active-ago"></a><h3>matrix_presence_event_set_last_active_ago ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_presence_event_set_last_active_ago
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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">"last-active-ago"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.7.9.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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">"last-active-ago"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-get-presence"></a><h3>matrix_presence_event_get_presence ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixPresence" title="enum MatrixPresence"><span class="returnvalue">MatrixPresence</span></a>
|
||||
matrix_presence_event_get_presence (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"presence"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.7.10.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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.3.7.10.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"presence"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-presence-event-set-presence"></a><h3>matrix_presence_event_set_presence ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_presence_event_set_presence (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</span></a> *self</code></em>,
|
||||
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixPresence" title="enum MatrixPresence"><span class="type">MatrixPresence</span></a> value</code></em>);</pre>
|
||||
<p>Set the value of the <span class="type">"presence"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.7.11.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-MatrixPresenceEvent.html#MatrixPresenceEvent" title="struct MatrixPresenceEvent"><span class="type">MatrixPresenceEvent</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">"presence"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixPresenceEvent.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixPresenceEvent"></a><h3>struct MatrixPresenceEvent</h3>
|
||||
<pre class="programlisting">struct MatrixPresenceEvent {
|
||||
MatrixEvent parent_instance;
|
||||
MatrixPresenceEventPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
<p>Class for representing presence events</p>
|
||||
<p>The presence event class.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixPresenceEventClass"></a><h3>struct MatrixPresenceEventClass</h3>
|
||||
<pre class="programlisting">struct MatrixPresenceEventClass {
|
||||
MatrixEventClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixPresenceEvent.html#MATRIX-TYPE-PRESENCE-EVENT:CAPS" title="MATRIX_TYPE_PRESENCE_EVENT"><code class="literal">MATRIX_TYPE_PRESENCE_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.3.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 class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEventClass" title="struct MatrixEventClass"><span class="type">MatrixEventClass</span></a> <em class="structfield"><code><a name="MatrixPresenceEventClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
125
Matrix-0.0-MatrixRoomEvent.html
Normal file
125
Matrix-0.0-MatrixRoomEvent.html
Normal file
@ -0,0 +1,125 @@
|
||||
<!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: MatrixRoomEvent</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="ch01.html" title="Matrix-0.0 API Reference">
|
||||
<link rel="next" href="Matrix-0.0-MatrixPresenceEvent.html" title="MatrixPresenceEvent">
|
||||
<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-MatrixRoomEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixRoomEvent.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="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixPresenceEvent.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-MatrixRoomEvent"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixRoomEvent.top_of_page"></a>MatrixRoomEvent</span></h2>
|
||||
<p>MatrixRoomEvent — 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-MatrixRoomEvent.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-MatrixRoomEvent.html#MATRIX-TYPE-ROOM-EVENT:CAPS" title="MATRIX_TYPE_ROOM_EVENT">MATRIX_TYPE_ROOM_EVENT</a></td>
|
||||
</tr></tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomEvent.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-MatrixRoomEvent.html#MatrixRoomEvent" title="struct MatrixRoomEvent">MatrixRoomEvent</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixRoomEvent.html#MatrixRoomEventClass" title="struct MatrixRoomEventClass">MatrixRoomEventClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomEvent.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomEvent.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-ROOM-EVENT:CAPS"></a><h3>MATRIX_TYPE_ROOM_EVENT</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_ROOM_EVENT (matrix_room_event_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixRoomEvent.html#MatrixRoomEvent" title="struct MatrixRoomEvent"><span class="type">MatrixRoomEvent</span></a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomEvent.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomEvent"></a><h3>struct MatrixRoomEvent</h3>
|
||||
<pre class="programlisting">struct MatrixRoomEvent {
|
||||
MatrixEvent parent_instance;
|
||||
MatrixRoomEventPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
<p>Abstract base class for room events.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomEventClass"></a><h3>struct MatrixRoomEventClass</h3>
|
||||
<pre class="programlisting">struct MatrixRoomEventClass {
|
||||
MatrixEventClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixRoomEvent.html#MATRIX-TYPE-ROOM-EVENT:CAPS" title="MATRIX_TYPE_ROOM_EVENT"><code class="literal">MATRIX_TYPE_ROOM_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.2.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 class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEventClass" title="struct MatrixEventClass"><span class="type">MatrixEventClass</span></a> <em class="structfield"><code><a name="MatrixRoomEventClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
444
Matrix-0.0-MatrixRoomMemberEvent.html
Normal file
444
Matrix-0.0-MatrixRoomMemberEvent.html
Normal file
@ -0,0 +1,444 @@
|
||||
<!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: MatrixRoomMemberEvent</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-MatrixEvent.html" title="MatrixEvent">
|
||||
<link rel="next" href="Matrix-0.0-MatrixClient.html" title="MatrixClient">
|
||||
<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-MatrixRoomMemberEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixRoomMemberEvent.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-MatrixEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixClient.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-MatrixRoomMemberEvent"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixRoomMemberEvent.top_of_page"></a>MatrixRoomMemberEvent</span></h2>
|
||||
<p>MatrixRoomMemberEvent — Class for representing a room membership events</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMemberEvent.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-MatrixRoomMemberEvent.html#MATRIX-TYPE-ROOM-MEMBER-EVENT:CAPS" title="MATRIX_TYPE_ROOM_MEMBER_EVENT">MATRIX_TYPE_ROOM_MEMBER_EVENT</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="returnvalue">MatrixRoomMemberEvent</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#matrix-room-member-event-new" title="matrix_room_member_event_new ()">matrix_room_member_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-MatrixRoomMemberEvent.html#matrix-room-member-event-get-state-key" title="matrix_room_member_event_get_state_key ()">matrix_room_member_event_get_state_key</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-MatrixRoomMemberEvent.html#matrix-room-member-event-set-state-key" title="matrix_room_member_event_set_state_key ()">matrix_room_member_event_set_state_key</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-matrix-enums.html#MatrixRoomMembership" title="enum MatrixRoomMembership"><span class="returnvalue">MatrixRoomMembership</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#matrix-room-member-event-get-membership" title="matrix_room_member_event_get_membership ()">matrix_room_member_event_get_membership</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#matrix-room-member-event-set-membership" title="matrix_room_member_event_set_membership ()">matrix_room_member_event_set_membership</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-MatrixRoomMemberEvent.html#matrix-room-member-event-get-avatar-url" title="matrix_room_member_event_get_avatar_url ()">matrix_room_member_event_get_avatar_url</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#matrix-room-member-event-set-avatar-url" title="matrix_room_member_event_set_avatar_url ()">matrix_room_member_event_set_avatar_url</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-MatrixRoomMemberEvent.html#matrix-room-member-event-get-display-name" title="matrix_room_member_event_get_display_name ()">matrix_room_member_event_get_display_name</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">void</span>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#matrix-room-member-event-set-display-name" title="matrix_room_member_event_set_display_name ()">matrix_room_member_event_set_display_name</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMemberEvent.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent">MatrixRoomMemberEvent</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEventClass" title="struct MatrixRoomMemberEventClass">MatrixRoomMemberEventClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMemberEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMemberEvent.description"></a><h2>Description</h2>
|
||||
<p>The room membership event class.</p>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMemberEvent.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-ROOM-MEMBER-EVENT:CAPS"></a><h3>MATRIX_TYPE_ROOM_MEMBER_EVENT</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_ROOM_MEMBER_EVENT (matrix_room_member_event_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a>.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-new"></a><h3>matrix_room_member_event_new ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="returnvalue">MatrixRoomMemberEvent</span></a> *
|
||||
matrix_room_member_event_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-get-state-key"></a><h3>matrix_room_member_event_get_state_key ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_room_member_event_get_state_key
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"state-key"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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.7.4.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"state-key"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-set-state-key"></a><h3>matrix_room_member_event_set_state_key ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_room_member_event_set_state_key
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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">"state-key"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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">"state-key"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-get-membership"></a><h3>matrix_room_member_event_get_membership ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixRoomMembership" title="enum MatrixRoomMembership"><span class="returnvalue">MatrixRoomMembership</span></a>
|
||||
matrix_room_member_event_get_membership
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"membership"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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.7.6.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"membership"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-set-membership"></a><h3>matrix_room_member_event_set_membership ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_room_member_event_set_membership
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> *self</code></em>,
|
||||
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixRoomMembership" title="enum MatrixRoomMembership"><span class="type">MatrixRoomMembership</span></a> value</code></em>);</pre>
|
||||
<p>Set the value of the <span class="type">"membership"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> instance to modify</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>value</p></td>
|
||||
<td class="parameter_description"><p>the new value of the <span class="type">"membership"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-get-avatar-url"></a><h3>matrix_room_member_event_get_avatar_url ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_room_member_event_get_avatar_url
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"avatar-url"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.7.8.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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.7.8.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"avatar-url"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-set-avatar-url"></a><h3>matrix_room_member_event_set_avatar_url ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_room_member_event_set_avatar_url
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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">"avatar-url"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.7.9.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> instance to modify</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>value</p></td>
|
||||
<td class="parameter_description"><p>the new value of the <span class="type">"avatar-url"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-get-display-name"></a><h3>matrix_room_member_event_get_display_name ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_room_member_event_get_display_name
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"display-name"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.7.10.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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.7.10.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"display-name"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-member-event-set-display-name"></a><h3>matrix_room_member_event_set_display_name ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_room_member_event_set_display_name
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</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">"display-name"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.6.7.11.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-MatrixRoomMemberEvent.html#MatrixRoomMemberEvent" title="struct MatrixRoomMemberEvent"><span class="type">MatrixRoomMemberEvent</span></a> instance to modify</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>value</p></td>
|
||||
<td class="parameter_description"><p>the new value of the <span class="type">"display-name"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMemberEvent.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomMemberEvent"></a><h3>struct MatrixRoomMemberEvent</h3>
|
||||
<pre class="programlisting">struct MatrixRoomMemberEvent {
|
||||
MatrixRoomEvent parent_instance;
|
||||
MatrixRoomMemberEventPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
<p>Class for representing a room membership events</p>
|
||||
<p>The room membership event class.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomMemberEventClass"></a><h3>struct MatrixRoomMemberEventClass</h3>
|
||||
<pre class="programlisting">struct MatrixRoomMemberEventClass {
|
||||
MatrixRoomEventClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixRoomMemberEvent.html#MATRIX-TYPE-ROOM-MEMBER-EVENT:CAPS" title="MATRIX_TYPE_ROOM_MEMBER_EVENT"><code class="literal">MATRIX_TYPE_ROOM_MEMBER_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.6.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 class="link" href="Matrix-0.0-MatrixRoomEvent.html#MatrixRoomEventClass" title="struct MatrixRoomEventClass"><span class="type">MatrixRoomEventClass</span></a> <em class="structfield"><code><a name="MatrixRoomMemberEventClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
288
Matrix-0.0-MatrixRoomMessageEvent.html
Normal file
288
Matrix-0.0-MatrixRoomMessageEvent.html
Normal file
@ -0,0 +1,288 @@
|
||||
<!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: MatrixRoomMessageEvent</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-MatrixStateEvent.html" title="MatrixStateEvent">
|
||||
<link rel="next" href="Matrix-0.0-c-api.html" title="c-api">
|
||||
<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-MatrixRoomMessageEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixRoomMessageEvent.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-MatrixStateEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-c-api.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-MatrixRoomMessageEvent"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixRoomMessageEvent.top_of_page"></a>MatrixRoomMessageEvent</span></h2>
|
||||
<p>MatrixRoomMessageEvent</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMessageEvent.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-MatrixRoomMessageEvent.html#MATRIX-TYPE-ROOM-MESSAGE-EVENT:CAPS" title="MATRIX_TYPE_ROOM_MESSAGE_EVENT">MATRIX_TYPE_ROOM_MESSAGE_EVENT</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="returnvalue">MatrixRoomMessageEvent</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#matrix-room-message-event-new" title="matrix_room_message_event_new ()">matrix_room_message_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-MatrixRoomMessageEvent.html#matrix-room-message-event-get-msg-type" title="matrix_room_message_event_get_msg_type ()">matrix_room_message_event_get_msg_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-MatrixRoomMessageEvent.html#matrix-room-message-event-set-msg-type" title="matrix_room_message_event_set_msg_type ()">matrix_room_message_event_set_msg_type</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-MatrixRoomMessageEvent.html#matrix-room-message-event-get-body" title="matrix_room_message_event_get_body ()">matrix_room_message_event_get_body</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-MatrixRoomMessageEvent.html#matrix-room-message-event-set-body" title="matrix_room_message_event_set_body ()">matrix_room_message_event_set_body</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMessageEvent.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-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent">MatrixRoomMessageEvent</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEventClass" title="struct MatrixRoomMessageEventClass">MatrixRoomMessageEventClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMessageEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMessageEvent.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMessageEvent.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-ROOM-MESSAGE-EVENT:CAPS"></a><h3>MATRIX_TYPE_ROOM_MESSAGE_EVENT</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_ROOM_MESSAGE_EVENT (matrix_room_message_event_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</span></a>.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-message-event-new"></a><h3>matrix_room_message_event_new ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="returnvalue">MatrixRoomMessageEvent</span></a> *
|
||||
matrix_room_message_event_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-message-event-get-msg-type"></a><h3>matrix_room_message_event_get_msg_type ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_room_message_event_get_msg_type
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"msg-type"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.11.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-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</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.11.7.4.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"msg-type"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-message-event-set-msg-type"></a><h3>matrix_room_message_event_set_msg_type ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_room_message_event_set_msg_type
|
||||
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</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">"msg-type"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.11.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-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</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">"msg-type"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-message-event-get-body"></a><h3>matrix_room_message_event_get_body ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_room_message_event_get_body (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"body"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.11.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-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</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.11.7.6.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"body"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-room-message-event-set-body"></a><h3>matrix_room_message_event_set_body ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_room_message_event_set_body (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</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">"body"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.11.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-MatrixRoomMessageEvent.html#MatrixRoomMessageEvent" title="struct MatrixRoomMessageEvent"><span class="type">MatrixRoomMessageEvent</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">"body"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixRoomMessageEvent.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomMessageEvent"></a><h3>struct MatrixRoomMessageEvent</h3>
|
||||
<pre class="programlisting">struct MatrixRoomMessageEvent {
|
||||
MatrixRoomEvent parent_instance;
|
||||
MatrixRoomMessageEventPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomMessageEventClass"></a><h3>struct MatrixRoomMessageEventClass</h3>
|
||||
<pre class="programlisting">struct MatrixRoomMessageEventClass {
|
||||
MatrixRoomEventClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixRoomMessageEvent.html#MATRIX-TYPE-ROOM-MESSAGE-EVENT:CAPS" title="MATRIX_TYPE_ROOM_MESSAGE_EVENT"><code class="literal">MATRIX_TYPE_ROOM_MESSAGE_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.11.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 class="link" href="Matrix-0.0-MatrixRoomEvent.html#MatrixRoomEventClass" title="struct MatrixRoomEventClass"><span class="type">MatrixRoomEventClass</span></a> <em class="structfield"><code><a name="MatrixRoomMessageEventClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
287
Matrix-0.0-MatrixStateEvent.html
Normal file
287
Matrix-0.0-MatrixStateEvent.html
Normal file
@ -0,0 +1,287 @@
|
||||
<!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: MatrixStateEvent</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-MatrixHTTPClient.html" title="MatrixHTTPClient">
|
||||
<link rel="next" href="Matrix-0.0-MatrixRoomMessageEvent.html" title="MatrixRoomMessageEvent">
|
||||
<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-MatrixStateEvent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-MatrixStateEvent.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-MatrixHTTPClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixRoomMessageEvent.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-MatrixStateEvent"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixStateEvent.top_of_page"></a>MatrixStateEvent</span></h2>
|
||||
<p>MatrixStateEvent</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixStateEvent.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-MatrixStateEvent.html#MATRIX-TYPE-STATE-EVENT:CAPS" title="MATRIX_TYPE_STATE_EVENT">MATRIX_TYPE_STATE_EVENT</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="returnvalue">MatrixStateEvent</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-MatrixStateEvent.html#matrix-state-event-new" title="matrix_state_event_new ()">matrix_state_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-MatrixStateEvent.html#matrix-state-event-get-state-key" title="matrix_state_event_get_state_key ()">matrix_state_event_get_state_key</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-MatrixStateEvent.html#matrix-state-event-set-state-key" title="matrix_state_event_set_state_key ()">matrix_state_event_set_state_key</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-MatrixStateEvent.html#matrix-state-event-get-content" title="matrix_state_event_get_content ()">matrix_state_event_get_content</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-MatrixStateEvent.html#matrix-state-event-set-content" title="matrix_state_event_set_content ()">matrix_state_event_set_content</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixStateEvent.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent">MatrixStateEvent</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">struct</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEventClass" title="struct MatrixStateEventClass">MatrixStateEventClass</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixStateEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixStateEvent.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixStateEvent.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MATRIX-TYPE-STATE-EVENT:CAPS"></a><h3>MATRIX_TYPE_STATE_EVENT</h3>
|
||||
<pre class="programlisting">#define MATRIX_TYPE_STATE_EVENT (matrix_state_event_get_type ())
|
||||
</pre>
|
||||
<p>The type for <a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a>.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-state-event-new"></a><h3>matrix_state_event_new ()</h3>
|
||||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="returnvalue">MatrixStateEvent</span></a> *
|
||||
matrix_state_event_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-state-event-get-state-key"></a><h3>matrix_state_event_get_state_key ()</h3>
|
||||
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||||
matrix_state_event_get_state_key (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"state-key"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.10.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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.10.7.4.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"state-key"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-state-event-set-state-key"></a><h3>matrix_state_event_set_state_key ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_state_event_set_state_key (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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">"state-key"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.10.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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">"state-key"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-state-event-get-content"></a><h3>matrix_state_event_get_content ()</h3>
|
||||
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
|
||||
matrix_state_event_get_content (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a> *self</code></em>);</pre>
|
||||
<p>Get and return the current value of the <span class="type">"content"</span> property.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.10.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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.10.7.6.6"></a><h4>Returns</h4>
|
||||
<p> the value of the <span class="type">"content"</span> property</p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-state-event-set-content"></a><h3>matrix_state_event_set_content ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
matrix_state_event_set_content (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</span></a> *self</code></em>,
|
||||
<em class="parameter"><code><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="type">JsonNode</span></a> *value</code></em>);</pre>
|
||||
<p>Set the value of the <span class="type">"content"</span> property to <em class="parameter"><code>value</code></em>
|
||||
.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.10.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-MatrixStateEvent.html#MatrixStateEvent" title="struct MatrixStateEvent"><span class="type">MatrixStateEvent</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">"content"</span> property</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-MatrixStateEvent.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixStateEvent"></a><h3>struct MatrixStateEvent</h3>
|
||||
<pre class="programlisting">struct MatrixStateEvent {
|
||||
MatrixEvent parent_instance;
|
||||
MatrixStateEventPrivate * priv;
|
||||
};
|
||||
</pre>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixStateEventClass"></a><h3>struct MatrixStateEventClass</h3>
|
||||
<pre class="programlisting">struct MatrixStateEventClass {
|
||||
MatrixEventClass parent_class;
|
||||
};
|
||||
</pre>
|
||||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixStateEvent.html#MATRIX-TYPE-STATE-EVENT:CAPS" title="MATRIX_TYPE_STATE_EVENT"><code class="literal">MATRIX_TYPE_STATE_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.10.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 class="link" href="Matrix-0.0-MatrixEvent.html#MatrixEventClass" title="struct MatrixEventClass"><span class="type">MatrixEventClass</span></a> <em class="structfield"><code><a name="MatrixStateEventClass.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.20</div>
|
||||
</body>
|
||||
</html>
|
||||
54
Matrix-0.0-c-api.html
Normal file
54
Matrix-0.0-c-api.html
Normal file
@ -0,0 +1,54 @@
|
||||
<!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: c-api</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-MatrixRoomMessageEvent.html" title="MatrixRoomMessageEvent">
|
||||
<link rel="next" href="Matrix-0.0-MatrixHTTPAPI.html" title="MatrixHTTPAPI">
|
||||
<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-c-api.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-c-api.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-MatrixRoomMessageEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixHTTPAPI.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-c-api"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-c-api.top_of_page"></a>c-api</span></h2>
|
||||
<p>c-api</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-c-api.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-c-api.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-c-api.functions_details"></a><h2>Functions</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-c-api.other_details"></a><h2>Types and Values</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
800
Matrix-0.0-matrix-enums.html
Normal file
800
Matrix-0.0-matrix-enums.html
Normal file
@ -0,0 +1,800 @@
|
||||
<!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: matrix-enums</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-MatrixPresenceEvent.html" title="MatrixPresenceEvent">
|
||||
<link rel="next" href="Matrix-0.0-MatrixEvent.html" title="MatrixEvent">
|
||||
<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-matrix-enums.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||||
<a href="#Matrix-0.0-matrix-enums.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-MatrixPresenceEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixEvent.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-matrix-enums"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2><span class="refentrytitle"><a name="Matrix-0.0-matrix-enums.top_of_page"></a>matrix-enums</span></h2>
|
||||
<p>matrix-enums</p>
|
||||
</td>
|
||||
<td class="gallery_image" valign="top" align="right"></td>
|
||||
</tr></table></div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-matrix-enums.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="function_type">
|
||||
<a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="Matrix-0.0-matrix-enums.html#matrix-error-quark" title="matrix_error_quark ()">matrix_error_quark</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr></tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-matrix-enums.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">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixAccountKind" title="enum MatrixAccountKind">MatrixAccountKind</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixEventDirection" title="enum MatrixEventDirection">MatrixEventDirection</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixEventFormat" title="enum MatrixEventFormat">MatrixEventFormat</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixPresence" title="enum MatrixPresence">MatrixPresence</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixPusherConditionKind" title="enum MatrixPusherConditionKind">MatrixPusherConditionKind</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixPusherKind" title="enum MatrixPusherKind">MatrixPusherKind</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixReceiptType" title="enum MatrixReceiptType">MatrixReceiptType</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixResizeMethod" title="enum MatrixResizeMethod">MatrixResizeMethod</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixRoomMembership" title="enum MatrixRoomMembership">MatrixRoomMembership</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixRoomPreset" title="enum MatrixRoomPreset">MatrixRoomPreset</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixRoomVisibility" title="enum MatrixRoomVisibility">MatrixRoomVisibility</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixSearchOrder" title="enum MatrixSearchOrder">MatrixSearchOrder</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixSearchKey" title="enum MatrixSearchKey">MatrixSearchKey</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixSearchGroupBy" title="enum MatrixSearchGroupBy">MatrixSearchGroupBy</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="datatype_keyword">enum</td>
|
||||
<td class="function_name"><a class="link" href="Matrix-0.0-matrix-enums.html#MatrixError" title="enum MatrixError">MatrixError</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-matrix-enums.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen">
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-matrix-enums.description"></a><h2>Description</h2>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-matrix-enums.functions_details"></a><h2>Functions</h2>
|
||||
<div class="refsect2">
|
||||
<a name="matrix-error-quark"></a><h3>matrix_error_quark ()</h3>
|
||||
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
|
||||
matrix_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="Matrix-0.0-matrix-enums.other_details"></a><h2>Types and Values</h2>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixAccountKind"></a><h3>enum MatrixAccountKind</h3>
|
||||
<p>User account types.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.2.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ACCOUNT-KIND-DEFAULT:CAPS"></a>MATRIX_ACCOUNT_KIND_DEFAULT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ACCOUNT-KIND-USER:CAPS"></a>MATRIX_ACCOUNT_KIND_USER</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ACCOUNT-KIND-GUEST:CAPS"></a>MATRIX_ACCOUNT_KIND_GUEST</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixEventDirection"></a><h3>enum MatrixEventDirection</h3>
|
||||
<p>Direction of events when requesting an event context.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.3.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-EVENT-DIRECTION-FORWARD:CAPS"></a>MATRIX_EVENT_DIRECTION_FORWARD</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-EVENT-DIRECTION-BACKWARD:CAPS"></a>MATRIX_EVENT_DIRECTION_BACKWARD</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixEventFormat"></a><h3>enum MatrixEventFormat</h3>
|
||||
<p>Event format received when synchronizing.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.4.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-EVENT-FORMAT-DEFAULT:CAPS"></a>MATRIX_EVENT_FORMAT_DEFAULT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-EVENT-FORMAT-CLIENT:CAPS"></a>MATRIX_EVENT_FORMAT_CLIENT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-EVENT-FORMAT-FEDERATION:CAPS"></a>MATRIX_EVENT_FORMAT_FEDERATION</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixPresence"></a><h3>enum MatrixPresence</h3>
|
||||
<p>Presence values for <a class="link" href="Matrix-0.0-MatrixAPI.html#matrix-api-set-user-presence" title="matrix_api_set_user_presence ()"><code class="function">matrix_api_set_user_presence()</code></a> and other presence related queries.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.5.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PRESENCE-UNKNOWN:CAPS"></a>MATRIX_PRESENCE_UNKNOWN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PRESENCE-ONLINE:CAPS"></a>MATRIX_PRESENCE_ONLINE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PRESENCE-OFFLINE:CAPS"></a>MATRIX_PRESENCE_OFFLINE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PRESENCE-UNAVAILABLE:CAPS"></a>MATRIX_PRESENCE_UNAVAILABLE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PRESENCE-FREE-FOR-CHAT:CAPS"></a>MATRIX_PRESENCE_FREE_FOR_CHAT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixPusherConditionKind"></a><h3>enum MatrixPusherConditionKind</h3>
|
||||
<p>Condition types for pushers.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.6.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-CONDITION-KIND-EVENT-MATCH:CAPS"></a>MATRIX_PUSHER_CONDITION_KIND_EVENT_MATCH</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-CONDITION-KIND-PROFILE-TAG:CAPS"></a>MATRIX_PUSHER_CONDITION_KIND_PROFILE_TAG</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-CONDITION-KIND-CONTAINS-DISPLAY-NAME:CAPS"></a>MATRIX_PUSHER_CONDITION_KIND_CONTAINS_DISPLAY_NAME</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-CONDITION-KIND-ROOM-MEMBER-COUNT:CAPS"></a>MATRIX_PUSHER_CONDITION_KIND_ROOM_MEMBER_COUNT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixPusherKind"></a><h3>enum MatrixPusherKind</h3>
|
||||
<p>Pusher types.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.7.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-KIND-OVERRIDE:CAPS"></a>MATRIX_PUSHER_KIND_OVERRIDE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-KIND-SENDER:CAPS"></a>MATRIX_PUSHER_KIND_SENDER</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-KIND-ROOM:CAPS"></a>MATRIX_PUSHER_KIND_ROOM</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-KIND-CONTENT:CAPS"></a>MATRIX_PUSHER_KIND_CONTENT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-PUSHER-KIND-UNDERRIDE:CAPS"></a>MATRIX_PUSHER_KIND_UNDERRIDE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixReceiptType"></a><h3>enum MatrixReceiptType</h3>
|
||||
<p>Receipt types of acknowledgment.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.8.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody><tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-RECEIPT-TYPE-READ:CAPS"></a>MATRIX_RECEIPT_TYPE_READ</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr></tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixResizeMethod"></a><h3>enum MatrixResizeMethod</h3>
|
||||
<p>Resizing methods for <a class="link" href="Matrix-0.0-MatrixAPI.html#matrix-api-media-thumbnail" title="matrix_api_media_thumbnail ()"><code class="function">matrix_api_media_thumbnail()</code></a>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.9.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-RESIZE-METHOD-DEFAULT:CAPS"></a>MATRIX_RESIZE_METHOD_DEFAULT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-RESIZE-METHOD-CROP:CAPS"></a>MATRIX_RESIZE_METHOD_CROP</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-RESIZE-METHOD-SCALE:CAPS"></a>MATRIX_RESIZE_METHOD_SCALE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomMembership"></a><h3>enum MatrixRoomMembership</h3>
|
||||
<p>Room membership types.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.10.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-MEMBERSHIP-UNKNOWN:CAPS"></a>MATRIX_ROOM_MEMBERSHIP_UNKNOWN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-MEMBERSHIP-INVITE:CAPS"></a>MATRIX_ROOM_MEMBERSHIP_INVITE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-MEMBERSHIP-JOIN:CAPS"></a>MATRIX_ROOM_MEMBERSHIP_JOIN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-MEMBERSHIP-LEAVE:CAPS"></a>MATRIX_ROOM_MEMBERSHIP_LEAVE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-MEMBERSHIP-BAN:CAPS"></a>MATRIX_ROOM_MEMBERSHIP_BAN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-MEMBERSHIP-KNOCK:CAPS"></a>MATRIX_ROOM_MEMBERSHIP_KNOCK</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomPreset"></a><h3>enum MatrixRoomPreset</h3>
|
||||
<p>Preset values for <a class="link" href="Matrix-0.0-MatrixAPI.html#matrix-api-create-room" title="matrix_api_create_room ()"><code class="function">matrix_api_create_room()</code></a> calls.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.11.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-PRESET-NONE:CAPS"></a>MATRIX_ROOM_PRESET_NONE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-PRESET-PRIVATE:CAPS"></a>MATRIX_ROOM_PRESET_PRIVATE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-PRESET-TRUSTED-PRIVATE:CAPS"></a>MATRIX_ROOM_PRESET_TRUSTED_PRIVATE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-PRESET-PUBLIC:CAPS"></a>MATRIX_ROOM_PRESET_PUBLIC</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixRoomVisibility"></a><h3>enum MatrixRoomVisibility</h3>
|
||||
<p>Visibility values for room creation. Not to be confused with join rules.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.12.4"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-VISIBILITY-DEFAULT:CAPS"></a>MATRIX_ROOM_VISIBILITY_DEFAULT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-VISIBILITY-PUBLIC:CAPS"></a>MATRIX_ROOM_VISIBILITY_PUBLIC</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ROOM-VISIBILITY-PRIVATE:CAPS"></a>MATRIX_ROOM_VISIBILITY_PRIVATE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixSearchOrder"></a><h3>enum MatrixSearchOrder</h3>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.13.3"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-ORDER-RECENT:CAPS"></a>MATRIX_SEARCH_ORDER_RECENT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-ORDER-RANK:CAPS"></a>MATRIX_SEARCH_ORDER_RANK</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixSearchKey"></a><h3>enum MatrixSearchKey</h3>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.14.3"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-KEY-CONTENT-BODY:CAPS"></a>MATRIX_SEARCH_KEY_CONTENT_BODY</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-KEY-CONTENT-NAME:CAPS"></a>MATRIX_SEARCH_KEY_CONTENT_NAME</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-KEY-CONTENT-TOPIC:CAPS"></a>MATRIX_SEARCH_KEY_CONTENT_TOPIC</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixSearchGroupBy"></a><h3>enum MatrixSearchGroupBy</h3>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.15.3"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-GROUP-BY-ROOM-ID:CAPS"></a>MATRIX_SEARCH_GROUP_BY_ROOM_ID</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-SEARCH-GROUP-BY-SENDER:CAPS"></a>MATRIX_SEARCH_GROUP_BY_SENDER</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="MatrixError"></a><h3>enum MatrixError</h3>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.4.8.16.3"></a><h4>Members</h4>
|
||||
<div class="informaltable"><table width="100%" border="0">
|
||||
<colgroup>
|
||||
<col width="300px" class="enum_members_name">
|
||||
<col class="enum_members_description">
|
||||
<col width="200px" class="enum_members_annotations">
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-NONE:CAPS"></a>MATRIX_ERROR_NONE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-COMMUNICATION-ERROR:CAPS"></a>MATRIX_ERROR_COMMUNICATION_ERROR</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-INCOMPLETE:CAPS"></a>MATRIX_ERROR_INCOMPLETE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-BAD-REQUEST:CAPS"></a>MATRIX_ERROR_BAD_REQUEST</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-BAD-RESPONSE:CAPS"></a>MATRIX_ERROR_BAD_RESPONSE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-INVALID-ROOM-ID:CAPS"></a>MATRIX_ERROR_INVALID_ROOM_ID</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-UNKNOWN-VALUE:CAPS"></a>MATRIX_ERROR_UNKNOWN_VALUE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-INVALID-TYPE:CAPS"></a>MATRIX_ERROR_INVALID_TYPE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-UNSUPPORTED:CAPS"></a>MATRIX_ERROR_UNSUPPORTED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-INVALID-FORMAT:CAPS"></a>MATRIX_ERROR_INVALID_FORMAT</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-MISSING-TOKEN:CAPS"></a>MATRIX_ERROR_M_MISSING_TOKEN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-FORBIDDEN:CAPS"></a>MATRIX_ERROR_M_FORBIDDEN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-UNKNOWN:CAPS"></a>MATRIX_ERROR_M_UNKNOWN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-UNKNOWN-TOKEN:CAPS"></a>MATRIX_ERROR_M_UNKNOWN_TOKEN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-NOT-JSON:CAPS"></a>MATRIX_ERROR_M_NOT_JSON</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-UNRECOGNIZED:CAPS"></a>MATRIX_ERROR_M_UNRECOGNIZED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-UNAUTHORIZED:CAPS"></a>MATRIX_ERROR_M_UNAUTHORIZED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-BAD-JSON:CAPS"></a>MATRIX_ERROR_M_BAD_JSON</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-USER-IN-USE:CAPS"></a>MATRIX_ERROR_M_USER_IN_USE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-ROOM-IN-USE:CAPS"></a>MATRIX_ERROR_M_ROOM_IN_USE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-BAD-PAGINATION:CAPS"></a>MATRIX_ERROR_M_BAD_PAGINATION</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-BAD-STATE:CAPS"></a>MATRIX_ERROR_M_BAD_STATE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-NOT-FOUND:CAPS"></a>MATRIX_ERROR_M_NOT_FOUND</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-GUEST-ACCESS-FORBIDDEN:CAPS"></a>MATRIX_ERROR_M_GUEST_ACCESS_FORBIDDEN</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-LIMIT-EXCEEDED:CAPS"></a>MATRIX_ERROR_M_LIMIT_EXCEEDED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-CAPTCHA-NEEDED:CAPS"></a>MATRIX_ERROR_M_CAPTCHA_NEEDED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-CAPTCHA-INVALID:CAPS"></a>MATRIX_ERROR_M_CAPTCHA_INVALID</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-MISSING-PARAM:CAPS"></a>MATRIX_ERROR_M_MISSING_PARAM</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-TOO-LARGE:CAPS"></a>MATRIX_ERROR_M_TOO_LARGE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-EXCLUSIVE:CAPS"></a>MATRIX_ERROR_M_EXCLUSIVE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-THREEPID-AUTH-FAILED:CAPS"></a>MATRIX_ERROR_M_THREEPID_AUTH_FAILED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-THREEPID-IN-USE:CAPS"></a>MATRIX_ERROR_M_THREEPID_IN_USE</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-M-INVALID-USERNAME:CAPS"></a>MATRIX_ERROR_M_INVALID_USERNAME</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-UNSPECIFIED:CAPS"></a>MATRIX_ERROR_UNSPECIFIED</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="enum_member_name"><p><a name="MATRIX-ERROR-UNKNOWN-ERROR:CAPS"></a>MATRIX_ERROR_UNKNOWN_ERROR</p></td>
|
||||
<td> </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
54
annotation-glossary.html
Normal file
54
annotation-glossary.html
Normal file
@ -0,0 +1,54 @@
|
||||
<!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: Annotation Glossary</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="index.html" title="Matrix-0.0 Reference Manual">
|
||||
<link rel="prev" href="deprecated-api-index.html" title="Index of deprecated API">
|
||||
<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"><span id="nav_glossary"><a class="shortcut" href="#glsA">A</a>
|
||||
<span class="dim">|</span>
|
||||
<a class="shortcut" href="#glsC">C</a>
|
||||
<span class="dim">|</span>
|
||||
<a class="shortcut" href="#glsE">E</a>
|
||||
<span class="dim">|</span>
|
||||
<a class="shortcut" href="#glsI">I</a>
|
||||
<span class="dim">|</span>
|
||||
<a class="shortcut" href="#glsT">T</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><img src="up-insensitive.png" width="16" height="16" border="0"></td>
|
||||
<td><a accesskey="p" href="deprecated-api-index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
|
||||
</tr></table>
|
||||
<div class="glossary">
|
||||
<div class="titlepage"><div><div><h1 class="title">
|
||||
<a name="annotation-glossary"></a>Annotation Glossary</h1></div></div></div>
|
||||
<a name="glsA"></a><h3 class="title">A</h3>
|
||||
<dt><span class="glossterm"><a name="annotation-glossterm-allow-none"></a>allow-none</span></dt>
|
||||
<dd class="glossdef"><p>NULL is ok, both for passing and for returning.</p></dd>
|
||||
<a name="glsC"></a><h3 class="title">C</h3>
|
||||
<dt><span class="glossterm"><a name="annotation-glossterm-closure"></a>closure</span></dt>
|
||||
<dd class="glossdef"><p>This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.</p></dd>
|
||||
<a name="glsE"></a><h3 class="title">E</h3>
|
||||
<dt><span class="glossterm"><a name="annotation-glossterm-error-domains"></a>error-domains</span></dt>
|
||||
<dd class="glossdef"><p>Typed errors. Similar to throws in Java.</p></dd>
|
||||
<a name="glsI"></a><h3 class="title">I</h3>
|
||||
<dt><span class="glossterm"><a name="annotation-glossterm-in"></a>in</span></dt>
|
||||
<dd class="glossdef"><p>Parameter for input. Default is <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>.</p></dd>
|
||||
<a name="glsT"></a><h3 class="title">T</h3>
|
||||
<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20full"></a>transfer full</span></dt>
|
||||
<dd class="glossdef"><p>Free data after the code is done.</p></dd>
|
||||
<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20none"></a>transfer none</span></dt>
|
||||
<dd class="glossdef"><p>Don't free data after the code is done.</p></dd>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
1303
api-index-full.html
Normal file
1303
api-index-full.html
Normal file
File diff suppressed because it is too large
Load Diff
71
ch01.html
Normal file
71
ch01.html
Normal file
@ -0,0 +1,71 @@
|
||||
<!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: Matrix-0.0 API Reference</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="index.html" title="Matrix-0.0 Reference Manual">
|
||||
<link rel="prev" href="index.html" title="Matrix-0.0 Reference Manual">
|
||||
<link rel="next" href="Matrix-0.0-MatrixRoomEvent.html" title="MatrixRoomEvent">
|
||||
<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"></td>
|
||||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||||
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
|
||||
<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="Matrix-0.0-MatrixRoomEvent.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||||
</tr></table>
|
||||
<div class="chapter">
|
||||
<div class="titlepage"><div><div><h1 class="title">
|
||||
<a name="id-1.2"></a>Matrix-0.0 API Reference</h1></div></div></div>
|
||||
<div class="toc"><dl class="toc">
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixRoomEvent.html">MatrixRoomEvent</a></span><span class="refpurpose"> — Abstract base class for room events.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixPresenceEvent.html">MatrixPresenceEvent</a></span><span class="refpurpose"> — Class for representing presence events</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-matrix-enums.html">matrix-enums</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixEvent.html">MatrixEvent</a></span><span class="refpurpose"> — Base class for Matrix events.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixRoomMemberEvent.html">MatrixRoomMemberEvent</a></span><span class="refpurpose"> — Class for representing a room membership events</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixClient.html">MatrixClient</a></span><span class="refpurpose"> — Base interface for client communication with a Matrix.org homeserver</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixJsonCompact.html">MatrixJsonCompact</a></span><span class="refpurpose"> — Abstract parent class for classes that can be saved to JSON.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixHTTPClient.html">MatrixHTTPClient</a></span><span class="refpurpose"> — An event-driven client class to communicate with HTTP based Matrix.org servers.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixStateEvent.html">MatrixStateEvent</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixRoomMessageEvent.html">MatrixRoomMessageEvent</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-c-api.html">c-api</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixHTTPAPI.html">MatrixHTTPAPI</a></span><span class="refpurpose"> — This is a class for low level communication with a Matrix.org server via HTTP.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixAPI.html">MatrixAPI</a></span><span class="refpurpose"> — Base interface for all Client/Server API functionality.</span>
|
||||
</dt>
|
||||
</dl></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
31
deprecated-api-index.html
Normal file
31
deprecated-api-index.html
Normal file
@ -0,0 +1,31 @@
|
||||
<!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: Index of deprecated API</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="index.html" title="Matrix-0.0 Reference Manual">
|
||||
<link rel="prev" href="api-index-full.html" title="API Index">
|
||||
<link rel="next" href="annotation-glossary.html" title="Annotation Glossary">
|
||||
<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"></td>
|
||||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||||
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
|
||||
<td><a accesskey="p" href="api-index-full.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||||
<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||||
</tr></table>
|
||||
<div class="index">
|
||||
<div class="titlepage"><div><div><h1 class="title">
|
||||
<a name="deprecated-api-index"></a>Index of deprecated API</h1></div></div></div>
|
||||
<a name="idx"></a>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
77
index.html
Normal file
77
index.html
Normal file
@ -0,0 +1,77 @@
|
||||
<!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: 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="next" href="ch01.html" title="Matrix-0.0 API Reference">
|
||||
<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">
|
||||
<div class="book">
|
||||
<div class="titlepage">
|
||||
<div>
|
||||
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Matrix-0.0 Reference Manual</p></th></tr></table></div>
|
||||
<div><p class="releaseinfo">
|
||||
for Matrix-0.0 0.0.1.20160304.
|
||||
The latest version of this documentation can be found on-line at
|
||||
<a class="ulink" href="http://gergelypolonkai.github.io/matrix-glib-sdk/index.html" target="_top">http://gergely.polonkai.eu/matrix-glib-sdk/</a>.
|
||||
</p></div>
|
||||
</div>
|
||||
<hr>
|
||||
</div>
|
||||
<div class="toc"><dl class="toc">
|
||||
<dt><span class="chapter"><a href="ch01.html">Matrix-0.0 API Reference</a></span></dt>
|
||||
<dd><dl>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixRoomEvent.html">MatrixRoomEvent</a></span><span class="refpurpose"> — Abstract base class for room events.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixPresenceEvent.html">MatrixPresenceEvent</a></span><span class="refpurpose"> — Class for representing presence events</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-matrix-enums.html">matrix-enums</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixEvent.html">MatrixEvent</a></span><span class="refpurpose"> — Base class for Matrix events.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixRoomMemberEvent.html">MatrixRoomMemberEvent</a></span><span class="refpurpose"> — Class for representing a room membership events</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixClient.html">MatrixClient</a></span><span class="refpurpose"> — Base interface for client communication with a Matrix.org homeserver</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixJsonCompact.html">MatrixJsonCompact</a></span><span class="refpurpose"> — Abstract parent class for classes that can be saved to JSON.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixHTTPClient.html">MatrixHTTPClient</a></span><span class="refpurpose"> — An event-driven client class to communicate with HTTP based Matrix.org servers.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixStateEvent.html">MatrixStateEvent</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixRoomMessageEvent.html">MatrixRoomMessageEvent</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-c-api.html">c-api</a></span><span class="refpurpose"></span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixHTTPAPI.html">MatrixHTTPAPI</a></span><span class="refpurpose"> — This is a class for low level communication with a Matrix.org server via HTTP.</span>
|
||||
</dt>
|
||||
<dt>
|
||||
<span class="refentrytitle"><a href="Matrix-0.0-MatrixAPI.html">MatrixAPI</a></span><span class="refpurpose"> — Base interface for all Client/Server API functionality.</span>
|
||||
</dt>
|
||||
</dl></dd>
|
||||
<dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt>
|
||||
<dt><span class="index"><a href="deprecated-api-index.html">Index of deprecated API</a></span></dt>
|
||||
<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt>
|
||||
</dl></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>
|
||||
Generated by GTK-Doc V1.20</div>
|
||||
</body>
|
||||
</html>
|
||||
BIN
left-insensitive.png
Normal file
BIN
left-insensitive.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 329 B |
BIN
right-insensitive.png
Normal file
BIN
right-insensitive.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 233 B |
461
style.css
Normal file
461
style.css
Normal file
@ -0,0 +1,461 @@
|
||||
body
|
||||
{
|
||||
font-family: cantarell, sans-serif;
|
||||
}
|
||||
.synopsis, .classsynopsis
|
||||
{
|
||||
/* tango:aluminium 1/2 */
|
||||
background: #eeeeec;
|
||||
background: rgba(238, 238, 236, 0.5);
|
||||
border: solid 1px rgb(238, 238, 236);
|
||||
padding: 0.5em;
|
||||
}
|
||||
.programlisting
|
||||
{
|
||||
/* tango:sky blue 0/1 */
|
||||
/* fallback for no rgba support */
|
||||
background: #e6f3ff;
|
||||
border: solid 1px #729fcf;
|
||||
background: rgba(114, 159, 207, 0.1);
|
||||
border: solid 1px rgba(114, 159, 207, 0.2);
|
||||
padding: 0.5em;
|
||||
}
|
||||
.variablelist
|
||||
{
|
||||
padding: 4px;
|
||||
margin-left: 3em;
|
||||
}
|
||||
.variablelist td:first-child
|
||||
{
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
@media screen {
|
||||
sup a.footnote
|
||||
{
|
||||
position: relative;
|
||||
top: 0em ! important;
|
||||
}
|
||||
/* this is needed so that the local anchors are displayed below the naviagtion */
|
||||
div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name]
|
||||
{
|
||||
display: inline-block;
|
||||
position: relative;
|
||||
top:-5em;
|
||||
}
|
||||
/* this seems to be a bug in the xsl style sheets when generating indexes */
|
||||
div.index div.index
|
||||
{
|
||||
top: 0em;
|
||||
}
|
||||
/* make space for the fixed navigation bar and add space at the bottom so that
|
||||
* link targets appear somewhat close to top
|
||||
*/
|
||||
body
|
||||
{
|
||||
padding-top: 5em;
|
||||
padding-bottom: 500px;
|
||||
max-width: 60em;
|
||||
}
|
||||
p
|
||||
{
|
||||
max-width: 60em;
|
||||
}
|
||||
/* style and size the navigation bar */
|
||||
table.navigation#top
|
||||
{
|
||||
position: fixed;
|
||||
background: #e2e2e2;
|
||||
border-bottom: solid 1px #babdb6;
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
top: 0;
|
||||
left: 0;
|
||||
height: 3em;
|
||||
z-index: 10;
|
||||
}
|
||||
.navigation a, .navigation a:visited
|
||||
{
|
||||
/* tango:sky blue 3 */
|
||||
color: #204a87;
|
||||
}
|
||||
.navigation a:hover
|
||||
{
|
||||
/* tango:sky blue 2 */
|
||||
color: #3465a4;
|
||||
}
|
||||
td.shortcuts
|
||||
{
|
||||
/* tango:sky blue 2 */
|
||||
color: #3465a4;
|
||||
font-size: 80%;
|
||||
white-space: nowrap;
|
||||
}
|
||||
td.shortcuts .dim
|
||||
{
|
||||
color: #babdb6;
|
||||
}
|
||||
}
|
||||
@media screen and (min-width: 60em) {
|
||||
/* screen larger than 60em */
|
||||
body { margin: auto; }
|
||||
}
|
||||
@media screen and (max-width: 60em) {
|
||||
/* screen less than 60em */
|
||||
#nav_hierarchy { display: none; }
|
||||
#nav_interfaces { display: none; }
|
||||
#nav_prerequisites { display: none; }
|
||||
#nav_derived_interfaces { display: none; }
|
||||
#nav_implementations { display: none; }
|
||||
#nav_child_properties { display: none; }
|
||||
#nav_style_properties { display: none; }
|
||||
#nav_index { display: none; }
|
||||
#nav_glossary { display: none; }
|
||||
.gallery_image { display: none; }
|
||||
.property_flags { display: none; }
|
||||
.signal_flags { display: none; }
|
||||
.parameter_annotations { display: none; }
|
||||
.enum_member_annotations { display: none; }
|
||||
.struct_member_annotations { display: none; }
|
||||
.union_member_annotations { display: none; }
|
||||
/* now that a column is hidden, optimize space */
|
||||
col.parameters_name { width: auto; }
|
||||
col.parameters_description { width: auto; }
|
||||
col.struct_members_name { width: auto; }
|
||||
col.struct_members_description { width: auto; }
|
||||
col.enum_members_name { width: auto; }
|
||||
col.enum_members_description { width: auto; }
|
||||
col.union_members_name { width: auto; }
|
||||
col.union_members_description { width: auto; }
|
||||
}
|
||||
@media print {
|
||||
table.navigation {
|
||||
visibility: collapse;
|
||||
display: none;
|
||||
}
|
||||
div.titlepage table.navigation {
|
||||
visibility: visible;
|
||||
display: table;
|
||||
background: #e2e2e2;
|
||||
border: solid 1px #babdb6;
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
top: 0;
|
||||
left: 0;
|
||||
height: 3em;
|
||||
}
|
||||
}
|
||||
|
||||
.navigation .title
|
||||
{
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
div.gallery-float
|
||||
{
|
||||
float: left;
|
||||
padding: 10px;
|
||||
}
|
||||
div.gallery-float img
|
||||
{
|
||||
border-style: none;
|
||||
}
|
||||
div.gallery-spacer
|
||||
{
|
||||
clear: both;
|
||||
}
|
||||
|
||||
a, a:visited
|
||||
{
|
||||
text-decoration: none;
|
||||
/* tango:sky blue 2 */
|
||||
color: #3465a4;
|
||||
}
|
||||
a:hover
|
||||
{
|
||||
text-decoration: underline;
|
||||
/* tango:sky blue 1 */
|
||||
color: #729fcf;
|
||||
}
|
||||
|
||||
div.informaltable table
|
||||
{
|
||||
border-collapse: separate;
|
||||
border-spacing: 20px 3px;
|
||||
border: none;
|
||||
}
|
||||
|
||||
div.informaltable table td, div.informaltable table th
|
||||
{
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.function_type,
|
||||
.variable_type,
|
||||
.property_type,
|
||||
.signal_type,
|
||||
.parameter_name,
|
||||
.struct_member_name,
|
||||
.union_member_name,
|
||||
.define_keyword,
|
||||
.datatype_keyword,
|
||||
.typedef_keyword
|
||||
{
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* dim non-primary columns */
|
||||
.c_punctuation,
|
||||
.function_type,
|
||||
.variable_type,
|
||||
.property_type,
|
||||
.signal_type,
|
||||
.define_keyword,
|
||||
.datatype_keyword,
|
||||
.typedef_keyword,
|
||||
.property_flags,
|
||||
.signal_flags,
|
||||
.parameter_annotations,
|
||||
.enum_member_annotations,
|
||||
.struct_member_annotations,
|
||||
.union_member_annotations
|
||||
{
|
||||
color: #888a85;
|
||||
}
|
||||
|
||||
.function_type a,
|
||||
.function_type a:visited,
|
||||
.function_type a:hover,
|
||||
.property_type a,
|
||||
.property_type a:visited,
|
||||
.property_type a:hover,
|
||||
.signal_type a,
|
||||
.signal_type a:visited,
|
||||
.signal_type a:hover,
|
||||
.signal_flags a,
|
||||
.signal_flags a:visited,
|
||||
.signal_flags a:hover
|
||||
{
|
||||
color: #729fcf;
|
||||
}
|
||||
|
||||
div.table table
|
||||
{
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0px;
|
||||
/* tango:aluminium 3 */
|
||||
border: solid 1px #babdb6;
|
||||
}
|
||||
|
||||
div.table table td, div.table table th
|
||||
{
|
||||
/* tango:aluminium 3 */
|
||||
border: solid 1px #babdb6;
|
||||
padding: 3px;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
div.table table th
|
||||
{
|
||||
/* tango:aluminium 2 */
|
||||
background-color: #d3d7cf;
|
||||
}
|
||||
|
||||
h4
|
||||
{
|
||||
color: #555753;
|
||||
}
|
||||
|
||||
hr
|
||||
{
|
||||
/* tango:aluminium 1 */
|
||||
color: #d3d7cf;
|
||||
background: #d3d7cf;
|
||||
border: none 0px;
|
||||
height: 1px;
|
||||
clear: both;
|
||||
margin: 2.0em 0em 2.0em 0em;
|
||||
}
|
||||
|
||||
dl.toc dt
|
||||
{
|
||||
padding-bottom: 0.25em;
|
||||
}
|
||||
|
||||
dl.toc > dd > dl > dt
|
||||
{
|
||||
padding-top: 0.25em;
|
||||
padding-bottom: 0.25em;
|
||||
}
|
||||
|
||||
dl.toc > dt
|
||||
{
|
||||
padding-top: 1em;
|
||||
padding-bottom: 0.5em;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.parameter
|
||||
{
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
.footer
|
||||
{
|
||||
padding-top: 3.5em;
|
||||
/* tango:aluminium 3 */
|
||||
color: #babdb6;
|
||||
text-align: center;
|
||||
font-size: 80%;
|
||||
}
|
||||
|
||||
.informalfigure,
|
||||
.figure
|
||||
{
|
||||
margin: 1em;
|
||||
}
|
||||
|
||||
.informalexample,
|
||||
.example
|
||||
{
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.warning
|
||||
{
|
||||
/* tango:orange 0/1 */
|
||||
background: #ffeed9;
|
||||
background: rgba(252, 175, 62, 0.1);
|
||||
border-color: #ffb04f;
|
||||
border-color: rgba(252, 175, 62, 0.2);
|
||||
}
|
||||
.note
|
||||
{
|
||||
/* tango:chameleon 0/0.5 */
|
||||
background: #d8ffb2;
|
||||
background: rgba(138, 226, 52, 0.1);
|
||||
border-color: #abf562;
|
||||
border-color: rgba(138, 226, 52, 0.2);
|
||||
}
|
||||
div.blockquote
|
||||
{
|
||||
border-color: #eeeeec;
|
||||
}
|
||||
.note, .warning, div.blockquote
|
||||
{
|
||||
padding: 0.5em;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
margin: 2em;
|
||||
}
|
||||
.note p, .warning p
|
||||
{
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.warning h3.title,
|
||||
div.note h3.title
|
||||
{
|
||||
display: none;
|
||||
}
|
||||
|
||||
p + div.section
|
||||
{
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
div.refnamediv,
|
||||
div.refsynopsisdiv,
|
||||
div.refsect1,
|
||||
div.refsect2,
|
||||
div.toc,
|
||||
div.section
|
||||
{
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
/* blob links */
|
||||
h2 .extralinks, h3 .extralinks
|
||||
{
|
||||
float: right;
|
||||
/* tango:aluminium 3 */
|
||||
color: #babdb6;
|
||||
font-size: 80%;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.lineart
|
||||
{
|
||||
color: #d3d7cf;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.annotation
|
||||
{
|
||||
/* tango:aluminium 5 */
|
||||
color: #555753;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.structfield
|
||||
{
|
||||
font-style: normal;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
/* code listings */
|
||||
|
||||
.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */
|
||||
.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */
|
||||
.listing_code .programlisting .function { color: #000000; font-weight: bold; }
|
||||
.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */
|
||||
.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */
|
||||
.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */
|
||||
.listing_code .programlisting .normal { color: #000000; }
|
||||
.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */
|
||||
.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */
|
||||
.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */
|
||||
.listing_code .programlisting .type { color: #000000; }
|
||||
.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */
|
||||
.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */
|
||||
|
||||
.listing_frame {
|
||||
/* tango:sky blue 1 */
|
||||
border: solid 1px #729fcf;
|
||||
border: solid 1px rgba(114, 159, 207, 0.2);
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
.listing_lines, .listing_code {
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0px;
|
||||
padding: 0.5em;
|
||||
}
|
||||
.listing_lines {
|
||||
/* this just adds visual clutter and
|
||||
takes precious room from small screens */
|
||||
display: none;
|
||||
}
|
||||
.listing_lines {
|
||||
/* tango:sky blue 0.5 */
|
||||
background: #a6c5e3;
|
||||
background: rgba(114, 159, 207, 0.2);
|
||||
/* tango:aluminium 6 */
|
||||
color: #2e3436;
|
||||
}
|
||||
.listing_code {
|
||||
/* tango:sky blue 0 */
|
||||
background: #e6f3ff;
|
||||
background: rgba(114, 159, 207, 0.1);
|
||||
}
|
||||
.listing_code .programlisting {
|
||||
/* override from previous */
|
||||
border: none 0px;
|
||||
padding: 0px;
|
||||
background: none;
|
||||
}
|
||||
.listing_lines pre, .listing_code pre {
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
BIN
up-insensitive.png
Normal file
BIN
up-insensitive.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 293 B |
Loading…
Reference in New Issue
Block a user