136 lines
7.6 KiB
HTML
136 lines
7.6 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>MatrixMessageNotice: 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-MatrixEventRoomRedaction.html" title="MatrixEventRoomRedaction">
|
||
<link rel="next" href="Matrix-0.0-MatrixEventRoomHistoryVisibility.html" title="MatrixEventRoomHistoryVisibility">
|
||
<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-MatrixMessageNotice.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-MatrixEventRoomRedaction.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="Matrix-0.0-MatrixEventRoomHistoryVisibility.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-MatrixMessageNotice"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixMessageNotice.top_of_page"></a>MatrixMessageNotice</span></h2>
|
||
<p>MatrixMessageNotice — Message type to hold a m.notice message</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixMessageNotice.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-MatrixMessageNotice.html#MATRIX-MESSAGE-TYPE-NOTICE:CAPS" title="MATRIX_MESSAGE_TYPE_NOTICE">MATRIX_MESSAGE_TYPE_NOTICE</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="Matrix-0.0-MatrixMessageNotice.html#MatrixMessageNotice" title="struct MatrixMessageNotice"><span class="returnvalue">MatrixMessageNotice</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="Matrix-0.0-MatrixMessageNotice.html#matrix-message-notice-new" title="matrix_message_notice_new ()">matrix_message_notice_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixMessageNotice.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-MatrixMessageNotice.html#MatrixMessageNotice" title="struct MatrixMessageNotice">MatrixMessageNotice</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixMessageNotice.html#MatrixMessageNoticeClass" title="struct MatrixMessageNoticeClass">MatrixMessageNoticeClass</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixMessageNotice.description"></a><h2>Description</h2>
|
||
<p>A m.notice message should be considered similar to a plain m.text message except that clients should visually distinguish it in some way. It is intended to be used by automated clients, such as bots, bridges, and other entities, rather than humans. Additionally, such automated agents which watch a room for messages and respond to them ought to ignore m.notice messages. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages, as each responds to the other.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixMessageNotice.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="MATRIX-MESSAGE-TYPE-NOTICE:CAPS"></a><h3>MATRIX_MESSAGE_TYPE_NOTICE</h3>
|
||
<pre class="programlisting">#define MATRIX_MESSAGE_TYPE_NOTICE (matrix_message_notice_get_type ())
|
||
</pre>
|
||
<p>The type for <a class="link" href="Matrix-0.0-MatrixMessageNotice.html#MatrixMessageNotice" title="struct MatrixMessageNotice"><span class="type">MatrixMessageNotice</span></a>.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="matrix-message-notice-new"></a><h3>matrix_message_notice_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixMessageNotice.html#MatrixMessageNotice" title="struct MatrixMessageNotice"><span class="returnvalue">MatrixMessageNotice</span></a> *
|
||
matrix_message_notice_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="Matrix-0.0-MatrixMessageNotice.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="MatrixMessageNotice"></a><h3>struct MatrixMessageNotice</h3>
|
||
<pre class="programlisting">struct MatrixMessageNotice {
|
||
MatrixMessageBase parent_instance;
|
||
MatrixMessageNoticePrivate * priv;
|
||
};
|
||
</pre>
|
||
<p>Message type to hold a m.notice message</p>
|
||
<p>A m.notice message should be considered similar to a plain m.text message except that clients should visually distinguish it in some way. It is intended to be used by automated clients, such as bots, bridges, and other entities, rather than humans. Additionally, such automated agents which watch a room for messages and respond to them ought to ignore m.notice messages. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages, as each responds to the other.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="MatrixMessageNoticeClass"></a><h3>struct MatrixMessageNoticeClass</h3>
|
||
<pre class="programlisting">struct MatrixMessageNoticeClass {
|
||
MatrixMessageBaseClass parent_class;
|
||
};
|
||
</pre>
|
||
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixMessageNotice.html#MATRIX-MESSAGE-TYPE-NOTICE:CAPS" title="MATRIX_MESSAGE_TYPE_NOTICE"><code class="literal">MATRIX_MESSAGE_TYPE_NOTICE</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.33.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="MatrixMessageNoticeClass.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> |