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

318 lines
15 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>MatrixProfile: 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-MatrixMessageAudio.html" title="MatrixMessageAudio">
<link rel="next" href="Matrix-0.0-MatrixEventTyping.html" title="MatrixEventTyping">
<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-MatrixProfile.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-MatrixMessageAudio.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventTyping.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-MatrixProfile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixProfile.top_of_page"></a>MatrixProfile</span></h2>
<p>MatrixProfile — Object to hold a user's profile</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixProfile.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-MatrixProfile.html#MATRIX-TYPE-PROFILE:CAPS" title="MATRIX_TYPE_PROFILE">MATRIX_TYPE_PROFILE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="returnvalue">MatrixProfile</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixProfile.html#matrix-profile-new" title="matrix_profile_new ()">matrix_profile_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GTimeSpan</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixProfile.html#matrix-profile-get-age" title="matrix_profile_get_age ()">matrix_profile_get_age</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixProfile.html#matrix-profile-get-display-name" title="matrix_profile_get_display_name ()">matrix_profile_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-MatrixProfile.html#matrix-profile-set-display-name" title="matrix_profile_set_display_name ()">matrix_profile_set_display_name</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-MatrixProfile.html#matrix-profile-get-avatar-url" title="matrix_profile_get_avatar_url ()">matrix_profile_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-MatrixProfile.html#matrix-profile-set-avatar-url" title="matrix_profile_set_avatar_url ()">matrix_profile_set_avatar_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixProfile.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-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile">MatrixProfile</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfileClass" title="struct MatrixProfileClass">MatrixProfileClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixProfile.description"></a><h2>Description</h2>
<p>This object is used for both global and room specific profiles.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixProfile.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-TYPE-PROFILE:CAPS"></a><h3>MATRIX_TYPE_PROFILE</h3>
<pre class="programlisting">#define MATRIX_TYPE_PROFILE (matrix_profile_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-profile-new"></a><h3>matrix_profile_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="returnvalue">MatrixProfile</span></a> *
matrix_profile_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-profile-get-age"></a><h3>matrix_profile_get_age ()</h3>
<pre class="programlisting"><span class="returnvalue">GTimeSpan</span>
matrix_profile_get_age (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"age"</span> property.</p>
<div class="refsect3">
<a name="id-1.2.13.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-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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.6.4.6"></a><h4>Returns</h4>
<p> the value of the <span class="type">"age"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-profile-get-display-name"></a><h3>matrix_profile_get_display_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_profile_get_display_name (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"display-name"</span> property.</p>
<p>The human readable name of the user.</p>
<div class="refsect3">
<a name="id-1.2.13.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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.6.5.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"display-name"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-profile-set-display-name"></a><h3>matrix_profile_set_display_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_profile_set_display_name (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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">"display-name"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The human readable name of the user.</p>
<div class="refsect3">
<a name="id-1.2.13.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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-profile-get-avatar-url"></a><h3>matrix_profile_get_avatar_url ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_profile_get_avatar_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"avatar-url"</span> property.</p>
<p>The URL of the user's avatar.</p>
<div class="refsect3">
<a name="id-1.2.13.6.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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.6.7.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"avatar-url"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-profile-set-avatar-url"></a><h3>matrix_profile_set_avatar_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_profile_set_avatar_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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">"avatar-url"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The URL of the user's avatar.</p>
<div class="refsect3">
<a name="id-1.2.13.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixProfile.html#MatrixProfile" title="struct MatrixProfile"><span class="type">MatrixProfile</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>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixProfile.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixProfile"></a><h3>struct MatrixProfile</h3>
<pre class="programlisting">struct MatrixProfile {
GObject parent_instance;
MatrixProfilePrivate * priv;
};
</pre>
<p>Object to hold a user's profile</p>
<p>This object is used for both global and room specific profiles.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixProfileClass"></a><h3>struct MatrixProfileClass</h3>
<pre class="programlisting">struct MatrixProfileClass {
GObjectClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixProfile.html#MATRIX-TYPE-PROFILE:CAPS" title="MATRIX_TYPE_PROFILE"><code class="literal">MATRIX_TYPE_PROFILE</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.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="MatrixProfileClass.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