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

269 lines
12 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>MatrixEventCall: 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-MatrixEventRoomGuestAccess.html" title="MatrixEventRoomGuestAccess">
<link rel="next" href="Matrix-0.0-MatrixEventRoomJoinRules.html" title="MatrixEventRoomJoinRules">
<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-MatrixEventCall.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-MatrixEventRoomGuestAccess.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventRoomJoinRules.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-MatrixEventCall"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventCall.top_of_page"></a>MatrixEventCall</span></h2>
<p>MatrixEventCall — Base class for m.call.* events.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCall.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-MatrixEventCall.html#MATRIX-EVENT-TYPE-CALL:CAPS" title="MATRIX_EVENT_TYPE_CALL">MATRIX_EVENT_TYPE_CALL</a></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-MatrixEventCall.html#matrix-event-call-get-call-id" title="matrix_event_call_get_call_id ()">matrix_event_call_get_call_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-MatrixEventCall.html#matrix-event-call-set-call-id" title="matrix_event_call_set_call_id ()">matrix_event_call_set_call_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCall.html#matrix-event-call-get-version" title="matrix_event_call_get_version ()">matrix_event_call_get_version</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-MatrixEventCall.html#matrix-event-call-set-version" title="matrix_event_call_set_version ()">matrix_event_call_set_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCall.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-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall">MatrixEventCall</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCallClass" title="struct MatrixEventCallClass">MatrixEventCallClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCall.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCall.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-CALL:CAPS"></a><h3>MATRIX_EVENT_TYPE_CALL</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_CALL (matrix_event_call_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-get-call-id"></a><h3>matrix_event_call_get_call_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_call_get_call_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"call-id"</span> property.</p>
<p>The ID of the call this event relates to.</p>
<div class="refsect3">
<a name="id-1.2.24.6.3.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-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</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.24.6.3.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"call-id"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-set-call-id"></a><h3>matrix_event_call_set_call_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_call_set_call_id (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</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">"call-id"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The ID of the call this event relates to.</p>
<div class="refsect3">
<a name="id-1.2.24.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-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</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">"call-id"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-get-version"></a><h3>matrix_event_call_get_version ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
matrix_event_call_get_version (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"version"</span> property.</p>
<p>The version of the VoIP specification this message adheres to.</p>
<div class="refsect3">
<a name="id-1.2.24.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-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</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.24.6.5.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"version"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-set-version"></a><h3>matrix_event_call_set_version ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_call_set_version (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>);</pre>
<p>Set the value of the <span class="type">"version"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The version of the VoIP specification this message adheres to.</p>
<div class="refsect3">
<a name="id-1.2.24.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-MatrixEventCall.html#MatrixEventCall" title="struct MatrixEventCall"><span class="type">MatrixEventCall</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">"version"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCall.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventCall"></a><h3>struct MatrixEventCall</h3>
<pre class="programlisting">struct MatrixEventCall {
MatrixEventRoom parent_instance;
MatrixEventCallPrivate * priv;
};
</pre>
<p>Base class for m.call.* events.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventCallClass"></a><h3>struct MatrixEventCallClass</h3>
<pre class="programlisting">struct MatrixEventCallClass {
MatrixEventRoomClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventCall.html#MATRIX-EVENT-TYPE-CALL:CAPS" title="MATRIX_EVENT_TYPE_CALL"><code class="literal">MATRIX_EVENT_TYPE_CALL</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.24.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="MatrixEventCallClass.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