matrix-glib-sdk/Matrix-0.0-MatrixEventRoomMessage.html

247 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>MatrixEventRoomMessage: 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-MatrixEventRoomTopic.html" title="MatrixEventRoomTopic">
<link rel="next" href="Matrix-0.0-MatrixMessageEmote.html" title="MatrixMessageEmote">
<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-MatrixEventRoomMessage.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-MatrixEventRoomTopic.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixMessageEmote.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-MatrixEventRoomMessage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomMessage.top_of_page"></a>MatrixEventRoomMessage</span></h2>
<p>MatrixEventRoomMessage — Class to hold an m.room.message event</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMessage.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-MatrixEventRoomMessage.html#MATRIX-EVENT-TYPE-ROOM-MESSAGE:CAPS" title="MATRIX_EVENT_TYPE_ROOM_MESSAGE">MATRIX_EVENT_TYPE_ROOM_MESSAGE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="returnvalue">MatrixEventRoomMessage</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#matrix-event-room-message-new" title="matrix_event_room_message_new ()">matrix_event_room_message_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixMessageBase.html#MatrixMessageBase" title="struct MatrixMessageBase"><span class="returnvalue">MatrixMessageBase</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#matrix-event-room-message-get-message" title="matrix_event_room_message_get_message ()">matrix_event_room_message_get_message</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-MatrixEventRoomMessage.html#matrix-event-room-message-set-message" title="matrix_event_room_message_set_message ()">matrix_event_room_message_set_message</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-MatrixEventRoomMessage.html#matrix-event-room-message-get-fallback-content" title="matrix_event_room_message_get_fallback_content ()">matrix_event_room_message_get_fallback_content</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMessage.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-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage">MatrixEventRoomMessage</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessageClass" title="struct MatrixEventRoomMessageClass">MatrixEventRoomMessageClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMessage.description"></a><h2>Description</h2>
<p>This event is used when sending messages in a room. Messages are not limited to be text. The `msgtype` key outlines the type of message, e.g. text, audio, image, video, etc. The `body` key is text and MUST be used with every kind of `msgtype` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMessage.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-ROOM-MESSAGE:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_MESSAGE</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_MESSAGE (matrix_event_room_message_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-message-new"></a><h3>matrix_event_room_message_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="returnvalue">MatrixEventRoomMessage</span></a> *
matrix_event_room_message_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-message-get-message"></a><h3>matrix_event_room_message_get_message ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixMessageBase.html#MatrixMessageBase" title="struct MatrixMessageBase"><span class="returnvalue">MatrixMessageBase</span></a> *
matrix_event_room_message_get_message (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"message"</span> property.</p>
<p>The message as a Matrix.Message object.</p>
<div class="refsect3">
<a name="id-1.2.42.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-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</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.42.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"message"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-message-set-message"></a><h3>matrix_event_room_message_set_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_message_set_message (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageBase.html#MatrixMessageBase" title="struct MatrixMessageBase"><span class="type">MatrixMessageBase</span></a> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"message"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The message as a Matrix.Message object.</p>
<div class="refsect3">
<a name="id-1.2.42.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-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</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">"message"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-message-get-fallback-content"></a><h3>matrix_event_room_message_get_fallback_content ()</h3>
<pre class="programlisting"><a href="../json-glib/json-glib-JSON-Node.html#JsonNode"><span class="returnvalue">JsonNode</span></a> *
matrix_event_room_message_get_fallback_content
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"fallback-content"</span> property.</p>
<p>The message as a JSON object. This gets set by Matrix.Message.Base.new_from_json if no handler is installed for the given message type.</p>
<div class="refsect3">
<a name="id-1.2.42.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-MatrixEventRoomMessage.html#MatrixEventRoomMessage" title="struct MatrixEventRoomMessage"><span class="type">MatrixEventRoomMessage</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.42.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"fallback-content"</span> property</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomMessage.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventRoomMessage"></a><h3>struct MatrixEventRoomMessage</h3>
<pre class="programlisting">struct MatrixEventRoomMessage {
MatrixEventRoom parent_instance;
MatrixEventRoomMessagePrivate * priv;
};
</pre>
<p>Class to hold an m.room.message event</p>
<p>This event is used when sending messages in a room. Messages are not limited to be text. The `msgtype` key outlines the type of message, e.g. text, audio, image, video, etc. The `body` key is text and MUST be used with every kind of `msgtype` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventRoomMessageClass"></a><h3>struct MatrixEventRoomMessageClass</h3>
<pre class="programlisting">struct MatrixEventRoomMessageClass {
MatrixEventRoomClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomMessage.html#MATRIX-EVENT-TYPE-ROOM-MESSAGE:CAPS" title="MATRIX_EVENT_TYPE_ROOM_MESSAGE"><code class="literal">MATRIX_EVENT_TYPE_ROOM_MESSAGE</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.42.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-MatrixEventRoom.html#MatrixEventRoomClass" title="struct MatrixEventRoomClass"><span class="type">MatrixEventRoomClass</span></a> <em class="structfield"><code><a name="MatrixEventRoomMessageClass.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>