675 lines
42 KiB
HTML
675 lines
42 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>MatrixEventRoomThirdPartyInvite: 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="ch01.html" title="Matrix-0.0 API Reference">
|
|||
|
|
<link rel="next" href="Matrix-0.0-MatrixMessageLocation.html" title="MatrixMessageLocation">
|
|||
|
|
<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-MatrixEventRoomThirdPartyInvite.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="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
|||
|
|
<td><a accesskey="n" href="Matrix-0.0-MatrixMessageLocation.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-MatrixEventRoomThirdPartyInvite"></a><div class="titlepage"></div>
|
|||
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|||
|
|
<td valign="top">
|
|||
|
|
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventRoomThirdPartyInvite.top_of_page"></a>MatrixEventRoomThirdPartyInvite</span></h2>
|
|||
|
|
<p>MatrixEventRoomThirdPartyInvite — Class to hold a m.room.third_party_invite event</p>
|
|||
|
|
</td>
|
|||
|
|
<td class="gallery_image" valign="top" align="right"></td>
|
|||
|
|
</tr></table></div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomThirdPartyInvite.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-MatrixEventRoomThirdPartyInvite.html#MATRIX-EVENT-TYPE-ROOM-THIRD-PARTY-INVITE:CAPS" title="MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE">MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="function_type">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="returnvalue">MatrixEventRoomThirdPartyInvite</span></a> *
|
|||
|
|
</td>
|
|||
|
|
<td class="function_name">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-new" title="matrix_event_room_third_party_invite_new ()">matrix_event_room_third_party_invite_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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-get-display-name" title="matrix_event_room_third_party_invite_get_display_name ()">matrix_event_room_third_party_invite_get_display_name</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-set-display-name" title="matrix_event_room_third_party_invite_set_display_name ()">matrix_event_room_third_party_invite_set_display_name</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-get-key-validity-url" title="matrix_event_room_third_party_invite_get_key_validity_url ()">matrix_event_room_third_party_invite_get_key_validity_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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-set-key-validity-url" title="matrix_event_room_third_party_invite_set_key_validity_url ()">matrix_event_room_third_party_invite_set_key_validity_url</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-get-public-key" title="matrix_event_room_third_party_invite_get_public_key ()">matrix_event_room_third_party_invite_get_public_key</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-set-public-key" title="matrix_event_room_third_party_invite_set_public_key ()">matrix_event_room_third_party_invite_set_public_key</a> <span class="c_punctuation">()</span>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="function_type">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="returnvalue">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *
|
|||
|
|
</td>
|
|||
|
|
<td class="function_name">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-get-public-keys" title="matrix_event_room_third_party_invite_get_public_keys ()">matrix_event_room_third_party_invite_get_public_keys</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-set-public-keys" title="matrix_event_room_third_party_invite_set_public_keys ()">matrix_event_room_third_party_invite_set_public_keys</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-get-token" title="matrix_event_room_third_party_invite_get_token ()">matrix_event_room_third_party_invite_get_token</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-set-token" title="matrix_event_room_third_party_invite_set_token ()">matrix_event_room_third_party_invite_set_token</a> <span class="c_punctuation">()</span>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="function_type">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="returnvalue">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *
|
|||
|
|
</td>
|
|||
|
|
<td class="function_name">
|
|||
|
|
<a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-dup" title="matrix_event_room_third_party_invite_public_key_dup ()">matrix_event_room_third_party_invite_public_key_dup</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-free" title="matrix_event_room_third_party_invite_public_key_free ()">matrix_event_room_third_party_invite_public_key_free</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-copy" title="matrix_event_room_third_party_invite_public_key_copy ()">matrix_event_room_third_party_invite_public_key_copy</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-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-destroy" title="matrix_event_room_third_party_invite_public_key_destroy ()">matrix_event_room_third_party_invite_public_key_destroy</a> <span class="c_punctuation">()</span>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomThirdPartyInvite.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey">MatrixEventRoomThirdPartyInvitePublicKey</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="datatype_keyword">struct</td>
|
|||
|
|
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite">MatrixEventRoomThirdPartyInvite</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="datatype_keyword">struct</td>
|
|||
|
|
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInviteClass" title="struct MatrixEventRoomThirdPartyInviteClass">MatrixEventRoomThirdPartyInviteClass</a></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomThirdPartyInvite.description"></a><h2>Description</h2>
|
|||
|
|
<p>Acts as an m.room.member invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomThirdPartyInvite.functions_details"></a><h2>Functions</h2>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MATRIX-EVENT-TYPE-ROOM-THIRD-PARTY-INVITE:CAPS"></a><h3>MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE</h3>
|
|||
|
|
<pre class="programlisting">#define MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE (matrix_event_room_third_party_invite_get_type ())
|
|||
|
|
</pre>
|
|||
|
|
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-new"></a><h3>matrix_event_room_third_party_invite_new ()</h3>
|
|||
|
|
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="returnvalue">MatrixEventRoomThirdPartyInvite</span></a> *
|
|||
|
|
matrix_event_room_third_party_invite_new
|
|||
|
|
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-get-display-name"></a><h3>matrix_event_room_third_party_invite_get_display_name ()</h3>
|
|||
|
|
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
|||
|
|
matrix_event_room_third_party_invite_get_display_name
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Get and return the current value of the <span class="type">"display-name"</span> property.</p>
|
|||
|
|
<p>A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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.2.6.4.7"></a><h4>Returns</h4>
|
|||
|
|
<p> the value of the <span class="type">"display-name"</span> property</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-set-display-name"></a><h3>matrix_event_room_third_party_invite_set_display_name ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_set_display_name
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"display-name"</span> property to <em class="parameter"><code>value</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<p>A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"display-name"</span> property</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-get-key-validity-url"></a><h3>matrix_event_room_third_party_invite_get_key_validity_url ()</h3>
|
|||
|
|
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
|||
|
|
matrix_event_room_third_party_invite_get_key_validity_url
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Get and return the current value of the <span class="type">"key-validity-url"</span> property.</p>
|
|||
|
|
<p>A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named valid.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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.2.6.6.7"></a><h4>Returns</h4>
|
|||
|
|
<p> the value of the <span class="type">"key-validity-url"</span> property</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-set-key-validity-url"></a><h3>matrix_event_room_third_party_invite_set_key_validity_url ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_set_key_validity_url
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"key-validity-url"</span> property to <em class="parameter"><code>value</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<p>A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named valid.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"key-validity-url"</span> property</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-get-public-key"></a><h3>matrix_event_room_third_party_invite_get_public_key ()</h3>
|
|||
|
|
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
|||
|
|
matrix_event_room_third_party_invite_get_public_key
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Get and return the current value of the <span class="type">"public-key"</span> property.</p>
|
|||
|
|
<p>A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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.2.6.8.7"></a><h4>Returns</h4>
|
|||
|
|
<p> the value of the <span class="type">"public-key"</span> property</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-set-public-key"></a><h3>matrix_event_room_third_party_invite_set_public_key ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_set_public_key
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"public-key"</span> property to <em class="parameter"><code>value</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<p>A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"public-key"</span> property</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-get-public-keys"></a><h3>matrix_event_room_third_party_invite_get_public_keys ()</h3>
|
|||
|
|
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="returnvalue">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *
|
|||
|
|
matrix_event_room_third_party_invite_get_public_keys
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a> *self</code></em>,
|
|||
|
|
<em class="parameter"><code><span class="type">int</span> *result_length1</code></em>);</pre>
|
|||
|
|
<p>Get and return the current value of the <span class="type">"public-keys"</span> property.</p>
|
|||
|
|
<p>Keys with which the token may be signed.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.10.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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.2.6.10.7"></a><h4>Returns</h4>
|
|||
|
|
<p> the value of the <span class="type">"public-keys"</span> property</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-set-public-keys"></a><h3>matrix_event_room_third_party_invite_set_public_keys ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_set_public_keys
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a> *self</code></em>,
|
|||
|
|
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="type">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *value</code></em>,
|
|||
|
|
<em class="parameter"><code><span class="type">int</span> value_length1</code></em>);</pre>
|
|||
|
|
<p>Set the value of the <span class="type">"public-keys"</span> property to <em class="parameter"><code>value</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<p>Keys with which the token may be signed.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.11.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"public-keys"</span> property</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-get-token"></a><h3>matrix_event_room_third_party_invite_get_token ()</h3>
|
|||
|
|
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
|||
|
|
matrix_event_room_third_party_invite_get_token
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Get and return the current value of the <span class="type">"token"</span> property.</p>
|
|||
|
|
<p>The token, of which a signature must be produced in order to join the room.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.12.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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.2.6.12.7"></a><h4>Returns</h4>
|
|||
|
|
<p> the value of the <span class="type">"token"</span> property</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-set-token"></a><h3>matrix_event_room_third_party_invite_set_token ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_set_token
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"token"</span> property to <em class="parameter"><code>value</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<p>The token, of which a signature must be produced in order to join the room.</p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.13.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-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvite" title="struct MatrixEventRoomThirdPartyInvite"><span class="type">MatrixEventRoomThirdPartyInvite</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">"token"</span> property</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-public-key-dup"></a><h3>matrix_event_room_third_party_invite_public_key_dup ()</h3>
|
|||
|
|
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="returnvalue">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *
|
|||
|
|
matrix_event_room_third_party_invite_public_key_dup
|
|||
|
|
(<em class="parameter"><code>const <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="type">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Creates a copy of self.</p>
|
|||
|
|
<p><span class="emphasis"><em>See also</em></span>: <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-copy" title="matrix_event_room_third_party_invite_public_key_copy ()"><code class="function">matrix_event_room_third_party_invite_public_key_copy()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-destroy" title="matrix_event_room_third_party_invite_public_key_destroy ()"><code class="function">matrix_event_room_third_party_invite_public_key_destroy()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-free" title="matrix_event_room_third_party_invite_public_key_free ()"><code class="function">matrix_event_room_third_party_invite_public_key_free()</code></a></p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.14.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 instance to duplicate</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr></tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.14.7"></a><h4>Returns</h4>
|
|||
|
|
<p> a copy of <em class="parameter"><code>self</code></em>
|
|||
|
|
, free with <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-free" title="matrix_event_room_third_party_invite_public_key_free ()"><code class="function">matrix_event_room_third_party_invite_public_key_free()</code></a></p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-public-key-free"></a><h3>matrix_event_room_third_party_invite_public_key_free ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_public_key_free
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="type">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Frees the heap-allocated struct.</p>
|
|||
|
|
<p><span class="emphasis"><em>See also</em></span>: <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-dup" title="matrix_event_room_third_party_invite_public_key_dup ()"><code class="function">matrix_event_room_third_party_invite_public_key_dup()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-copy" title="matrix_event_room_third_party_invite_public_key_copy ()"><code class="function">matrix_event_room_third_party_invite_public_key_copy()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-destroy" title="matrix_event_room_third_party_invite_public_key_destroy ()"><code class="function">matrix_event_room_third_party_invite_public_key_destroy()</code></a></p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.15.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 struct to free</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr></tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-public-key-copy"></a><h3>matrix_event_room_third_party_invite_public_key_copy ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_public_key_copy
|
|||
|
|
(<em class="parameter"><code>const <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="type">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *self</code></em>,
|
|||
|
|
<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="type">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *dest</code></em>);</pre>
|
|||
|
|
<p>Creates a copy of self.</p>
|
|||
|
|
<p><span class="emphasis"><em>See also</em></span>: <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-dup" title="matrix_event_room_third_party_invite_public_key_dup ()"><code class="function">matrix_event_room_third_party_invite_public_key_dup()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-destroy" title="matrix_event_room_third_party_invite_public_key_destroy ()"><code class="function">matrix_event_room_third_party_invite_public_key_destroy()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-free" title="matrix_event_room_third_party_invite_public_key_free ()"><code class="function">matrix_event_room_third_party_invite_public_key_free()</code></a></p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.16.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 struct to copy</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td class="parameter_name"><p>dest</p></td>
|
|||
|
|
<td class="parameter_description"><p>a unused struct. Use <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-destroy" title="matrix_event_room_third_party_invite_public_key_destroy ()"><code class="function">matrix_event_room_third_party_invite_public_key_destroy()</code></a> to free the content.</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="matrix-event-room-third-party-invite-public-key-destroy"></a><h3>matrix_event_room_third_party_invite_public_key_destroy ()</h3>
|
|||
|
|
<pre class="programlisting"><span class="returnvalue">void</span>
|
|||
|
|
matrix_event_room_third_party_invite_public_key_destroy
|
|||
|
|
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MatrixEventRoomThirdPartyInvitePublicKey" title="struct MatrixEventRoomThirdPartyInvitePublicKey"><span class="type">MatrixEventRoomThirdPartyInvitePublicKey</span></a> *self</code></em>);</pre>
|
|||
|
|
<p>Frees the content of the struct pointed by <em class="parameter"><code>self</code></em>
|
|||
|
|
.</p>
|
|||
|
|
<p><span class="emphasis"><em>See also</em></span>: <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-dup" title="matrix_event_room_third_party_invite_public_key_dup ()"><code class="function">matrix_event_room_third_party_invite_public_key_dup()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-copy" title="matrix_event_room_third_party_invite_public_key_copy ()"><code class="function">matrix_event_room_third_party_invite_public_key_copy()</code></a>, <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#matrix-event-room-third-party-invite-public-key-free" title="matrix_event_room_third_party_invite_public_key_free ()"><code class="function">matrix_event_room_third_party_invite_public_key_free()</code></a></p>
|
|||
|
|
<div class="refsect3">
|
|||
|
|
<a name="id-1.2.2.6.17.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 struct to destroy</p></td>
|
|||
|
|
<td class="parameter_annotations"> </td>
|
|||
|
|
</tr></tbody>
|
|||
|
|
</table></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="refsect1">
|
|||
|
|
<a name="Matrix-0.0-MatrixEventRoomThirdPartyInvite.other_details"></a><h2>Types and Values</h2>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MatrixEventRoomThirdPartyInvitePublicKey"></a><h3>struct MatrixEventRoomThirdPartyInvitePublicKey</h3>
|
|||
|
|
<pre class="programlisting">struct MatrixEventRoomThirdPartyInvitePublicKey {
|
|||
|
|
gchar* key;
|
|||
|
|
gchar* validity_url;
|
|||
|
|
};
|
|||
|
|
</pre>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MatrixEventRoomThirdPartyInvite"></a><h3>struct MatrixEventRoomThirdPartyInvite</h3>
|
|||
|
|
<pre class="programlisting">struct MatrixEventRoomThirdPartyInvite {
|
|||
|
|
MatrixEventState parent_instance;
|
|||
|
|
MatrixEventRoomThirdPartyInvitePrivate * priv;
|
|||
|
|
};
|
|||
|
|
</pre>
|
|||
|
|
<p>Class to hold a m.room.third_party_invite event</p>
|
|||
|
|
<p>Acts as an m.room.member invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.</p>
|
|||
|
|
</div>
|
|||
|
|
<hr>
|
|||
|
|
<div class="refsect2">
|
|||
|
|
<a name="MatrixEventRoomThirdPartyInviteClass"></a><h3>struct MatrixEventRoomThirdPartyInviteClass</h3>
|
|||
|
|
<pre class="programlisting">struct MatrixEventRoomThirdPartyInviteClass {
|
|||
|
|
MatrixEventStateClass parent_class;
|
|||
|
|
};
|
|||
|
|
</pre>
|
|||
|
|
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventRoomThirdPartyInvite.html#MATRIX-EVENT-TYPE-ROOM-THIRD-PARTY-INVITE:CAPS" title="MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE"><code class="literal">MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE</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.2.7.4.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-MatrixEventState.html#MatrixEventStateClass" title="struct MatrixEventStateClass"><span class="type">MatrixEventStateClass</span></a> <em class="structfield"><code><a name="MatrixEventRoomThirdPartyInviteClass.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>
|