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

304 lines
14 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixHTTPAPI: Matrix-0.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Matrix-0.0 Reference Manual">
<link rel="up" href="ch01.html" title="Matrix-0.0 API Reference">
<link rel="prev" href="Matrix-0.0-MatrixMessageLocation.html" title="MatrixMessageLocation">
<link rel="next" href="Matrix-0.0-MatrixEventCallInvite.html" title="MatrixEventCallInvite">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#Matrix-0.0-MatrixHTTPAPI.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Matrix-0.0-MatrixMessageLocation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventCallInvite.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 <span class="returnvalue">gchar</span> *
</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">
<span class="returnvalue">gboolean</span>
</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.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 <span class="type">gchar</span> *base_url</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.4.6.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 <span class="returnvalue">gchar</span> *
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.4.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-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.4.6.4.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"base-url"</span> property</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 <span class="type">gchar</span> *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.4.6.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-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"><span class="returnvalue">gboolean</span>
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.4.6.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.4.6.6.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"validate-certificate"</span> property</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><span class="type">gboolean</span> 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.4.6.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.4.7.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GObjectClass</span> <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.24</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink