32
39
<h2><span class="refentrytitle"><a name="telepathy-glib-simple-password-manager.top_of_page"></a>TpSimplePasswordManager</span></h2>
33
40
<p>TpSimplePasswordManager — a simple X-TELEPATHY-PASSWORD channel manager</p>
35
<td class="gallery_image" valign="top" align="right"></td>
42
<td valign="top" align="right"></td>
36
43
</tr></table></div>
37
<div class="refsect1">
38
<a name="telepathy-glib-simple-password-manager.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table width="100%" border="0">
41
<col width="150px" class="functions_return">
42
<col class="functions_name">
46
<td class="function_type">
47
<a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="returnvalue">TpSimplePasswordManager</span></a> *
49
<td class="function_name">
50
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-new" title="tp_simple_password_manager_new ()">tp_simple_password_manager_new</a> <span class="c_punctuation">()</span>
54
<td class="function_type">
55
<span class="returnvalue">void</span>
57
<td class="function_name">
58
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()">tp_simple_password_manager_prompt_async</a> <span class="c_punctuation">()</span>
62
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> *
64
<td class="function_name">
65
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-finish" title="tp_simple_password_manager_prompt_finish ()">tp_simple_password_manager_prompt_finish</a> <span class="c_punctuation">()</span>
69
<td class="function_type">
70
<span class="returnvalue">void</span>
72
<td class="function_name">
73
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()">tp_simple_password_manager_prompt_for_channel_async</a> <span class="c_punctuation">()</span>
77
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> *
79
<td class="function_name">
80
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-finish" title="tp_simple_password_manager_prompt_for_channel_finish ()">tp_simple_password_manager_prompt_for_channel_finish</a> <span class="c_punctuation">()</span>
86
<div class="refsect1">
87
<a name="telepathy-glib-simple-password-manager.properties"></a><h2>Properties</h2>
88
<div class="informaltable"><table border="0">
90
<col width="150px" class="properties_type">
91
<col width="300px" class="properties_name">
92
<col width="200px" class="properties_flags">
95
<td class="property_type">
96
<a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *</td>
97
<td class="property_name"><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager--connection" title="The “connection” property">connection</a></td>
98
<td class="property_flags">Read / Write / Construct Only</td>
102
<a name="TpSimplePasswordManager"></a><div class="refsect1">
103
<a name="telepathy-glib-simple-password-manager.other"></a><h2>Types and Values</h2>
104
<div class="informaltable"><table width="100%" border="0">
106
<col width="150px" class="name">
107
<col class="description">
110
<td class="datatype_keyword">struct</td>
111
<td class="function_name"><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager-struct" title="struct TpSimplePasswordManager">TpSimplePasswordManager</a></td>
44
<div class="refsynopsisdiv">
45
<a name="telepathy-glib-simple-password-manager.synopsis"></a><h2>Synopsis</h2>
46
<a name="TpSimplePasswordManager"></a><pre class="synopsis">
47
#include <telepathy-glib/telepathy-glib.h>
49
<a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager-struct" title="TpSimplePasswordManager">TpSimplePasswordManager</a>;
50
<a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="returnvalue">TpSimplePasswordManager</span></a> * <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-new" title="tp_simple_password_manager_new ()">tp_simple_password_manager_new</a>
51
(<em class="parameter"><code><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *connection</code></em>);
53
<span class="returnvalue">void</span> <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()">tp_simple_password_manager_prompt_async</a>
54
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
55
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
56
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
57
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> * <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-finish" title="tp_simple_password_manager_prompt_finish ()">tp_simple_password_manager_prompt_finish</a>
58
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
59
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
60
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
61
<span class="returnvalue">void</span> <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()">tp_simple_password_manager_prompt_for_channel_async</a>
62
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
63
<em class="parameter"><code><a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> *channel</code></em>,
64
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
65
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
66
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> * <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-finish" title="tp_simple_password_manager_prompt_for_channel_finish ()">tp_simple_password_manager_prompt_for_channel_finish</a>
67
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
68
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
69
<em class="parameter"><code><a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> **channel</code></em>,
70
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
115
73
<div class="refsect1">
116
74
<a name="telepathy-glib-simple-password-manager.object-hierarchy"></a><h2>Object Hierarchy</h2>
117
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
118
<span class="lineart">╰──</span> TpSimplePasswordManager
75
<pre class="synopsis">
76
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
77
+----TpSimplePasswordManager
121
80
<div class="refsect1">
150
115
should check whether a password parameter was given when creating
151
116
the connection through RequestConnection. If a password is present,
152
117
the connection should go ahead and use it. If it is not present,
153
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a> should be called.</p>
154
<p>Once a password is retrieved using the server authentication
118
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a> should be called.
121
Once a password is retrieved using the server authentication
155
122
channel, or an error is occurred, the callback that was passed to
156
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a> is called and the
157
connection should call <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-finish" title="tp_simple_password_manager_prompt_finish ()"><code class="function">tp_simple_password_manager_prompt_finish()</code></a>
123
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a> is called and the
124
connection should call <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-finish" title="tp_simple_password_manager_prompt_finish ()"><code class="function">tp_simple_password_manager_prompt_finish()</code></a>
158
125
to get the result of the process. If the <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> returned from
159
126
said finish function is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>, the connection can then proceed
160
127
with that password, otherwise the connection must deal with the
163
131
<div class="refsect1">
164
<a name="telepathy-glib-simple-password-manager.functions_details"></a><h2>Functions</h2>
165
<div class="refsect2">
166
<a name="tp-simple-password-manager-new"></a><h3>tp_simple_password_manager_new ()</h3>
167
<pre class="programlisting"><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="returnvalue">TpSimplePasswordManager</span></a> *
168
tp_simple_password_manager_new (<em class="parameter"><code><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *connection</code></em>);</pre>
169
<p>Creates a new simple server authentication channel manager.</p>
170
<div class="refsect3">
171
<a name="id-1.6.20.11.2.5"></a><h4>Parameters</h4>
172
<div class="informaltable"><table width="100%" border="0">
174
<col width="150px" class="parameters_name">
175
<col class="parameters_description">
176
<col width="200px" class="parameters_annotations">
179
<td class="parameter_name"><p>connection</p></td>
180
<td class="parameter_description"><p>a <a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a></p></td>
181
<td class="parameter_annotations"> </td>
185
<div class="refsect3">
186
<a name="id-1.6.20.11.2.6"></a><h4>Returns</h4>
187
<p> a new reference to a server authentication channel
193
<div class="refsect2">
194
<a name="tp-simple-password-manager-prompt-async"></a><h3>tp_simple_password_manager_prompt_async ()</h3>
195
<pre class="programlisting"><span class="returnvalue">void</span>
196
tp_simple_password_manager_prompt_async
197
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
198
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
199
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
200
<p>Pops up a new server authentication channel and handles the
201
X-TELEPATHY-PASSWORD mechanism to obtain a password for the
203
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
204
will be called. You must then
205
call <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-finish" title="tp_simple_password_manager_prompt_finish ()"><code class="function">tp_simple_password_manager_prompt_finish()</code></a> to get the
206
result of the request.</p>
207
<div class="refsect3">
208
<a name="id-1.6.20.11.3.6"></a><h4>Parameters</h4>
209
<div class="informaltable"><table width="100%" border="0">
211
<col width="150px" class="parameters_name">
212
<col class="parameters_description">
213
<col width="200px" class="parameters_annotations">
217
<td class="parameter_name"><p>self</p></td>
218
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a></p></td>
219
<td class="parameter_annotations"> </td>
222
<td class="parameter_name"><p>callback</p></td>
223
<td class="parameter_description"><p>a callback to call when the request is satisfied</p></td>
224
<td class="parameter_annotations"> </td>
227
<td class="parameter_name"><p>user_data</p></td>
228
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
230
<td class="parameter_annotations"> </td>
235
<p class="since">Since 0.13.8</p>
238
<div class="refsect2">
239
<a name="tp-simple-password-manager-prompt-finish"></a><h3>tp_simple_password_manager_prompt_finish ()</h3>
240
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> *
241
tp_simple_password_manager_prompt_finish
242
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
243
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
244
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
245
<p>Retrieve the value of the request begun with
246
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a>.</p>
247
<div class="refsect3">
248
<a name="id-1.6.20.11.4.5"></a><h4>Parameters</h4>
249
<div class="informaltable"><table width="100%" border="0">
251
<col width="150px" class="parameters_name">
252
<col class="parameters_description">
253
<col width="200px" class="parameters_annotations">
257
<td class="parameter_name"><p>self</p></td>
258
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a></p></td>
259
<td class="parameter_annotations"> </td>
262
<td class="parameter_name"><p>result</p></td>
263
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
264
<td class="parameter_annotations"> </td>
267
<td class="parameter_name"><p>error</p></td>
268
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</p></td>
269
<td class="parameter_annotations"> </td>
274
<div class="refsect3">
275
<a name="id-1.6.20.11.4.6"></a><h4>Returns</h4>
276
<p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> with the password (or byte-blob)
277
retrieved by <em class="parameter"><code>manager</code></em>
279
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
281
<p class="since">Since 0.13.8</p>
284
<div class="refsect2">
285
<a name="tp-simple-password-manager-prompt-for-channel-async"></a><h3>tp_simple_password_manager_prompt_for_channel_async ()</h3>
286
<pre class="programlisting"><span class="returnvalue">void</span>
287
tp_simple_password_manager_prompt_for_channel_async
288
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
289
<em class="parameter"><code><a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> *channel</code></em>,
290
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
291
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
292
<p>Pops up a new server authentication channel and handles the
293
X-TELEPATHY-PASSWORD mechanism to obtain a password for the
295
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
296
will be called. You must then
297
call <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-finish" title="tp_simple_password_manager_prompt_for_channel_finish ()"><code class="function">tp_simple_password_manager_prompt_for_channel_finish()</code></a> to get the
298
result of the request.</p>
299
<p>Most of the time, <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a> should be used
132
<a name="telepathy-glib-simple-password-manager.details"></a><h2>Details</h2>
133
<div class="refsect2">
134
<a name="TpSimplePasswordManager-struct"></a><h3>TpSimplePasswordManager</h3>
135
<pre class="programlisting">typedef struct _TpSimplePasswordManager TpSimplePasswordManager;</pre>
137
A helper channel manager to manage X-TELEPATHY-PASSWORD
138
ServerAuthentication channels.
140
<p class="since">Since 0.13.8</p>
143
<div class="refsect2">
144
<a name="tp-simple-password-manager-new"></a><h3>tp_simple_password_manager_new ()</h3>
145
<pre class="programlisting"><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="returnvalue">TpSimplePasswordManager</span></a> * tp_simple_password_manager_new
146
(<em class="parameter"><code><a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *connection</code></em>);</pre>
148
Creates a new simple server authentication channel manager.
150
<div class="variablelist"><table border="0" class="variablelist">
152
<col align="left" valign="top">
157
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
158
<td>a <a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a>
162
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
163
<td>a new reference to a server authentication channel
170
<div class="refsect2">
171
<a name="tp-simple-password-manager-prompt-async"></a><h3>tp_simple_password_manager_prompt_async ()</h3>
172
<pre class="programlisting"><span class="returnvalue">void</span> tp_simple_password_manager_prompt_async
173
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
174
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
175
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
177
Pops up a new server authentication channel and handles the
178
X-TELEPATHY-PASSWORD mechanism to obtain a password for the
182
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You must then
183
call <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-finish" title="tp_simple_password_manager_prompt_finish ()"><code class="function">tp_simple_password_manager_prompt_finish()</code></a> to get the
184
result of the request.
186
<div class="variablelist"><table border="0" class="variablelist">
188
<col align="left" valign="top">
193
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
194
<td>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a>
198
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
199
<td>a callback to call when the request is satisfied</td>
202
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
203
<td>data to pass to <em class="parameter"><code>callback</code></em>
208
<p class="since">Since 0.13.8</p>
211
<div class="refsect2">
212
<a name="tp-simple-password-manager-prompt-finish"></a><h3>tp_simple_password_manager_prompt_finish ()</h3>
213
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> * tp_simple_password_manager_prompt_finish
214
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
215
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
216
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
218
Retrieve the value of the request begun with
219
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a>.
221
<div class="variablelist"><table border="0" class="variablelist">
223
<col align="left" valign="top">
228
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
229
<td>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a>
233
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
234
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
238
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
239
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
242
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
243
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> with the password (or byte-blob)
244
retrieved by <em class="parameter"><code>manager</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
249
<p class="since">Since 0.13.8</p>
252
<div class="refsect2">
253
<a name="tp-simple-password-manager-prompt-for-channel-async"></a><h3>tp_simple_password_manager_prompt_for_channel_async ()</h3>
254
<pre class="programlisting"><span class="returnvalue">void</span> tp_simple_password_manager_prompt_for_channel_async
255
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
256
<em class="parameter"><code><a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> *channel</code></em>,
257
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
258
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
260
Pops up a new server authentication channel and handles the
261
X-TELEPATHY-PASSWORD mechanism to obtain a password for the
265
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You must then
266
call <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-finish" title="tp_simple_password_manager_prompt_for_channel_finish ()"><code class="function">tp_simple_password_manager_prompt_for_channel_finish()</code></a> to get the
267
result of the request.
270
Most of the time, <a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-async" title="tp_simple_password_manager_prompt_async ()"><code class="function">tp_simple_password_manager_prompt_async()</code></a> should be used
300
271
instead. This function enables applications to provide custom channels
301
272
instead of letting the password manager handle all of the channel details
302
273
automatically. This may be useful if your SASL channel needs to implement
303
additional interfaces (such as Channel.Interface.CredentialsStorage)</p>
304
<div class="refsect3">
305
<a name="id-1.6.20.11.5.7"></a><h4>Parameters</h4>
306
<div class="informaltable"><table width="100%" border="0">
274
additional interfaces (such as Channel.Interface.CredentialsStorage)
276
<div class="variablelist"><table border="0" class="variablelist">
308
<col width="150px" class="parameters_name">
309
<col class="parameters_description">
310
<col width="200px" class="parameters_annotations">
278
<col align="left" valign="top">
314
<td class="parameter_name"><p>self</p></td>
315
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a></p></td>
316
<td class="parameter_annotations"> </td>
319
<td class="parameter_name"><p>channel</p></td>
320
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a></p></td>
321
<td class="parameter_annotations"> </td>
324
<td class="parameter_name"><p>callback</p></td>
325
<td class="parameter_description"><p>a callback to call when the request is satisfied</p></td>
326
<td class="parameter_annotations"> </td>
329
<td class="parameter_name"><p>user_data</p></td>
330
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
332
<td class="parameter_annotations"> </td>
283
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
284
<td>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a>
288
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
289
<td>a <a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a>
293
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
294
<td>a callback to call when the request is satisfied</td>
297
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
298
<td>data to pass to <em class="parameter"><code>callback</code></em>
337
303
<p class="since">Since 0.13.15</p>
340
306
<div class="refsect2">
341
<a name="tp-simple-password-manager-prompt-for-channel-finish"></a><h3>tp_simple_password_manager_prompt_for_channel_finish ()</h3>
342
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> *
343
tp_simple_password_manager_prompt_for_channel_finish
344
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
345
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
346
<em class="parameter"><code><a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> **channel</code></em>,
347
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
348
<p>Retrieve the value of the request begun with
349
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()"><code class="function">tp_simple_password_manager_prompt_for_channel_async()</code></a>.</p>
350
<div class="refsect3">
351
<a name="id-1.6.20.11.6.5"></a><h4>Parameters</h4>
352
<div class="informaltable"><table width="100%" border="0">
307
<a name="tp-simple-password-manager-prompt-for-channel-finish"></a><h3>tp_simple_password_manager_prompt_for_channel_finish ()</h3>
308
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> * tp_simple_password_manager_prompt_for_channel_finish
309
(<em class="parameter"><code><a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> *self</code></em>,
310
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
311
<em class="parameter"><code><a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> **channel</code></em>,
312
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
314
Retrieve the value of the request begun with
315
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()"><code class="function">tp_simple_password_manager_prompt_for_channel_async()</code></a>.
317
<div class="variablelist"><table border="0" class="variablelist">
354
<col width="150px" class="parameters_name">
355
<col class="parameters_description">
356
<col width="200px" class="parameters_annotations">
319
<col align="left" valign="top">
360
<td class="parameter_name"><p>self</p></td>
361
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a></p></td>
362
<td class="parameter_annotations"> </td>
365
<td class="parameter_name"><p>result</p></td>
366
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
367
<td class="parameter_annotations"> </td>
370
<td class="parameter_name"><p>channel</p></td>
371
<td class="parameter_description"><p> an output location to retrieve the custom
324
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
325
<td>a <a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a>
329
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
330
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
334
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
335
<td>an output location to retrieve the custom
372
336
password channel that was passed to
373
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()"><code class="function">tp_simple_password_manager_prompt_for_channel_async()</code></a>. </p></td>
374
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
377
<td class="parameter_name"><p>error</p></td>
378
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</p></td>
379
<td class="parameter_annotations"> </td>
337
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()"><code class="function">tp_simple_password_manager_prompt_for_channel_async()</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
341
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
342
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
345
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
346
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> with the password (or byte-blob)
347
retrieved by <em class="parameter"><code>manager</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
384
<div class="refsect3">
385
<a name="id-1.6.20.11.6.6"></a><h4>Returns</h4>
386
<p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> with the password (or byte-blob)
387
retrieved by <em class="parameter"><code>manager</code></em>
389
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
391
352
<p class="since">Since 0.13.15</p>
394
355
<div class="refsect1">
395
<a name="telepathy-glib-simple-password-manager.other_details"></a><h2>Types and Values</h2>
396
<div class="refsect2">
397
<a name="TpSimplePasswordManager-struct"></a><h3>struct TpSimplePasswordManager</h3>
398
<pre class="programlisting">struct TpSimplePasswordManager;</pre>
399
<p>A helper channel manager to manage X-TELEPATHY-PASSWORD
400
ServerAuthentication channels.</p>
401
<p class="since">Since 0.13.8</p>
404
<div class="refsect1">
405
356
<a name="telepathy-glib-simple-password-manager.property-details"></a><h2>Property Details</h2>
406
357
<div class="refsect2">
407
<a name="TpSimplePasswordManager--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
408
<pre class="programlisting"> “connection” <a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a> *</pre>
358
<a name="TpSimplePasswordManager--connection"></a><h3>The <code class="literal">"connection"</code> property</h3>
359
<pre class="programlisting"> "connection" <a class="link" href="TpBaseConnection.html" title="TpBaseConnection"><span class="type">TpBaseConnection</span></a>* : Read / Write / Construct Only</pre>
409
360
<p>The connection object that owns this channel manager.</p>
410
<p>Flags: Read / Write / Construct Only</p>
414
364
<div class="footer">
416
Generated by GTK-Doc V1.20</div>
366
Generated by GTK-Doc V1.19</div>
b'\\ No newline at end of file'