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

288 lines
16 KiB
HTML
Raw Permalink Normal View History

Update GTK Doc with current develop
2016-03-17 16:47:46 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixEventRoomRedaction: 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-MatrixEventCallHangup.html" title="MatrixEventCallHangup">
<link rel="next" href="Matrix-0.0-MatrixMessageNotice.html" title="MatrixMessageNotice">
<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-MatrixEventRoomRedaction.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-MatrixEventCallHangup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixMessageNotice.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-MatrixEventRoomRedaction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomRedaction.top_of_page"></a>MatrixEventRoomRedaction</span></h2>
<p>MatrixEventRoomRedaction — Class to hold a m.room.redaction event</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomRedaction.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-MatrixEventRoomRedaction.html#MATRIX-EVENT-TYPE-ROOM-REDACTION:CAPS" title="MATRIX_EVENT_TYPE_ROOM_REDACTION">MATRIX_EVENT_TYPE_ROOM_REDACTION</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="returnvalue">MatrixEventRoomRedaction</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#matrix-event-room-redaction-new" title="matrix_event_room_redaction_new ()">matrix_event_room_redaction_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-MatrixEventRoomRedaction.html#matrix-event-room-redaction-get-reason" title="matrix_event_room_redaction_get_reason ()">matrix_event_room_redaction_get_reason</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-MatrixEventRoomRedaction.html#matrix-event-room-redaction-set-reason" title="matrix_event_room_redaction_set_reason ()">matrix_event_room_redaction_set_reason</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-MatrixEventRoomRedaction.html#matrix-event-room-redaction-get-redacted-event-id" title="matrix_event_room_redaction_get_redacted_event_id ()">matrix_event_room_redaction_get_redacted_event_id</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-MatrixEventRoomRedaction.html#matrix-event-room-redaction-set-redacted-event-id" title="matrix_event_room_redaction_set_redacted_event_id ()">matrix_event_room_redaction_set_redacted_event_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomRedaction.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-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction">MatrixEventRoomRedaction</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedactionClass" title="struct MatrixEventRoomRedactionClass">MatrixEventRoomRedactionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomRedaction.description"></a><h2>Description</h2>
<p>Events can be redacted by either room or server admins. Redacting an event means that all keys not required by the protocol are stripped off, allowing admins to remove offensive or illegal content that may have been attached to any event. This cannot be undone, allowing server owners to physically delete the offending data. There is also a concept of a moderator hiding a message event, which can be undone, but cannot be applied to state events. The event that has been redacted is specified in the redacts event level key.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomRedaction.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-ROOM-REDACTION:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_REDACTION</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_REDACTION (matrix_event_room_redaction_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-redaction-new"></a><h3>matrix_event_room_redaction_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="returnvalue">MatrixEventRoomRedaction</span></a> *
matrix_event_room_redaction_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-redaction-get-reason"></a><h3>matrix_event_room_redaction_get_reason ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_redaction_get_reason
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"reason"</span> property.</p>
<p>The reason for the redaction, if any.</p>
<div class="refsect3">
<a name="id-1.2.32.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-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</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.32.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"reason"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-redaction-set-reason"></a><h3>matrix_event_room_redaction_set_reason ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_redaction_set_reason
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</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">"reason"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The reason for the redaction, if any.</p>
<div class="refsect3">
<a name="id-1.2.32.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-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</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">"reason"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-redaction-get-redacted-event-id"></a><h3>matrix_event_room_redaction_get_redacted_event_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_room_redaction_get_redacted_event_id
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"redacted-event-id"</span> property.</p>
<p>The event ID that was redacted.</p>
<div class="refsect3">
<a name="id-1.2.32.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-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</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.32.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"redacted-event-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-room-redaction-set-redacted-event-id"></a><h3>matrix_event_room_redaction_set_redacted_event_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_room_redaction_set_redacted_event_id
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</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">"redacted-event-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The event ID that was redacted.</p>
<div class="refsect3">
<a name="id-1.2.32.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-MatrixEventRoomRedaction.html#MatrixEventRoomRedaction" title="struct MatrixEventRoomRedaction"><span class="type">MatrixEventRoomRedaction</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">"redacted-event-id"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventRoomRedaction.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventRoomRedaction"></a><h3>struct MatrixEventRoomRedaction</h3>
<pre class="programlisting">struct MatrixEventRoomRedaction {
MatrixEventRoom parent_instance;
MatrixEventRoomRedactionPrivate * priv;
};
</pre>
<p>Class to hold a m.room.redaction event</p>
<p>Events can be redacted by either room or server admins. Redacting an event means that all keys not required by the protocol are stripped off, allowing admins to remove offensive or illegal content that may have been attached to any event. This cannot be undone, allowing server owners to physically delete the offending data. There is also a concept of a moderator hiding a message event, which can be undone, but cannot be applied to state events. The event that has been redacted is specified in the redacts event level key.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventRoomRedactionClass"></a><h3>struct MatrixEventRoomRedactionClass</h3>
<pre class="programlisting">struct MatrixEventRoomRedactionClass {
MatrixEventRoomClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomRedaction.html#MATRIX-EVENT-TYPE-ROOM-REDACTION:CAPS" title="MATRIX_EVENT_TYPE_ROOM_REDACTION"><code class="literal">MATRIX_EVENT_TYPE_ROOM_REDACTION</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.32.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="MatrixEventRoomRedactionClass.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 Copy Permalink