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

361 lines
18 KiB
HTML
Raw 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>MatrixMessageLocation: 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-MatrixEventRoomThirdPartyInvite.html" title="MatrixEventRoomThirdPartyInvite">
<link rel="next" href="Matrix-0.0-MatrixHTTPAPI.html" title="MatrixHTTPAPI">
<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-MatrixMessageLocation.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-MatrixEventRoomThirdPartyInvite.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-MatrixMessageLocation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixMessageLocation.top_of_page"></a>MatrixMessageLocation</span></h2>
<p>MatrixMessageLocation — This message represents a real-world location.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageLocation.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-MatrixMessageLocation.html#MATRIX-MESSAGE-TYPE-LOCATION:CAPS" title="MATRIX_MESSAGE_TYPE_LOCATION">MATRIX_MESSAGE_TYPE_LOCATION</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="returnvalue">MatrixMessageLocation</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageLocation.html#matrix-message-location-new" title="matrix_message_location_new ()">matrix_message_location_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-MatrixMessageLocation.html#matrix-message-location-get-geo-uri" title="matrix_message_location_get_geo_uri ()">matrix_message_location_get_geo_uri</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-MatrixMessageLocation.html#matrix-message-location-set-geo-uri" title="matrix_message_location_set_geo_uri ()">matrix_message_location_set_geo_uri</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-MatrixMessageLocation.html#matrix-message-location-get-thumbnail-url" title="matrix_message_location_get_thumbnail_url ()">matrix_message_location_get_thumbnail_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-MatrixMessageLocation.html#matrix-message-location-set-thumbnail-url" title="matrix_message_location_set_thumbnail_url ()">matrix_message_location_set_thumbnail_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="returnvalue">MatrixImageInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageLocation.html#matrix-message-location-get-thumbnail-info" title="matrix_message_location_get_thumbnail_info ()">matrix_message_location_get_thumbnail_info</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-MatrixMessageLocation.html#matrix-message-location-set-thumbnail-info" title="matrix_message_location_set_thumbnail_info ()">matrix_message_location_set_thumbnail_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageLocation.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-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation">MatrixMessageLocation</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocationClass" title="struct MatrixMessageLocationClass">MatrixMessageLocationClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageLocation.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageLocation.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-MESSAGE-TYPE-LOCATION:CAPS"></a><h3>MATRIX_MESSAGE_TYPE_LOCATION</h3>
<pre class="programlisting">#define MATRIX_MESSAGE_TYPE_LOCATION (matrix_message_location_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-new"></a><h3>matrix_message_location_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="returnvalue">MatrixMessageLocation</span></a> *
matrix_message_location_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-get-geo-uri"></a><h3>matrix_message_location_get_geo_uri ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_message_location_get_geo_uri (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"geo-uri"</span> property.</p>
<p>A geo URI representing this location.</p>
<div class="refsect3">
<a name="id-1.2.3.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"geo-uri"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-set-geo-uri"></a><h3>matrix_message_location_set_geo_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_location_set_geo_uri (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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">"geo-uri"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>A geo URI representing this location.</p>
<div class="refsect3">
<a name="id-1.2.3.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-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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">"geo-uri"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-get-thumbnail-url"></a><h3>matrix_message_location_get_thumbnail_url ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_message_location_get_thumbnail_url
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"thumbnail-url"</span> property.</p>
<p>The URL to a thumbnail of the location being represented.</p>
<div class="refsect3">
<a name="id-1.2.3.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-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"thumbnail-url"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-set-thumbnail-url"></a><h3>matrix_message_location_set_thumbnail_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_location_set_thumbnail_url
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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">"thumbnail-url"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The URL to a thumbnail of the location being represented.</p>
<div class="refsect3">
<a name="id-1.2.3.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-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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">"thumbnail-url"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-get-thumbnail-info"></a><h3>matrix_message_location_get_thumbnail_info ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="returnvalue">MatrixImageInfo</span></a> *
matrix_message_location_get_thumbnail_info
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"thumbnail-info"</span> property.</p>
<p>Metadata about the location referred to in <code class="literal">thumbnail_url</code>.</p>
<div class="refsect3">
<a name="id-1.2.3.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-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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.6.8.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"thumbnail-info"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-location-set-thumbnail-info"></a><h3>matrix_message_location_set_thumbnail_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_location_set_thumbnail_info
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="type">MatrixImageInfo</span></a> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"thumbnail-info"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>Metadata about the location referred to in <code class="literal">thumbnail_url</code>.</p>
<div class="refsect3">
<a name="id-1.2.3.6.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-MatrixMessageLocation.html#MatrixMessageLocation" title="struct MatrixMessageLocation"><span class="type">MatrixMessageLocation</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">"thumbnail-info"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageLocation.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixMessageLocation"></a><h3>struct MatrixMessageLocation</h3>
<pre class="programlisting">struct MatrixMessageLocation {
MatrixMessageBase parent_instance;
MatrixMessageLocationPrivate * priv;
};
</pre>
<p>This message represents a real-world location.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixMessageLocationClass"></a><h3>struct MatrixMessageLocationClass</h3>
<pre class="programlisting">struct MatrixMessageLocationClass {
MatrixMessageBaseClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixMessageLocation.html#MATRIX-MESSAGE-TYPE-LOCATION:CAPS" title="MATRIX_MESSAGE_TYPE_LOCATION"><code class="literal">MATRIX_MESSAGE_TYPE_LOCATION</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.7.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a class="link" href="Matrix-0.0-MatrixMessageBase.html#MatrixMessageBaseClass" title="struct MatrixMessageBaseClass"><span class="type">MatrixMessageBaseClass</span></a> <em class="structfield"><code><a name="MatrixMessageLocationClass.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