/usr/share/gtk-doc/html/libsecret-1/SecretPrompt.html is in libsecret-1-dev 0.18.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SecretPrompt: Libsecret Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Libsecret Library Reference Manual">
<link rel="up" href="complete.html" title="Part III. Complete API">
<link rel="prev" href="libsecret-Secret-Attributes.html" title="Secret Attributes">
<link rel="next" href="libsecret-SecretError.html" title="SecretError">
<meta name="generator" content="GTK-Doc V1.27.1 (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="#SecretPrompt.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#SecretPrompt.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#SecretPrompt.implemented-interfaces" class="shortcut">Implemented Interfaces</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="complete.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libsecret-Secret-Attributes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libsecret-SecretError.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="SecretPrompt"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SecretPrompt.top_of_page"></a>SecretPrompt</span></h2>
<p>SecretPrompt — a prompt in the Service</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="SecretPrompt.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="SecretPrompt.html#secret-prompt-perform" title="secret_prompt_perform ()">secret_prompt_perform</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GVariant</span> *
</td>
<td class="function_name">
<a class="link" href="SecretPrompt.html#secret-prompt-perform-finish" title="secret_prompt_perform_finish ()">secret_prompt_perform_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GVariant</span> *
</td>
<td class="function_name">
<a class="link" href="SecretPrompt.html#secret-prompt-perform-sync" title="secret_prompt_perform_sync ()">secret_prompt_perform_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GVariant</span> *
</td>
<td class="function_name">
<a class="link" href="SecretPrompt.html#secret-prompt-run" title="secret_prompt_run ()">secret_prompt_run</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SecretPrompt.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="SecretPrompt.html#SecretPrompt-struct" title="struct SecretPrompt">SecretPrompt</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="SecretPrompt.html#SecretPromptClass" title="struct SecretPromptClass">SecretPromptClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SecretPrompt.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GDBusProxy
<span class="lineart">╰──</span> SecretPrompt
</pre>
</div>
<div class="refsect1">
<a name="SecretPrompt.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
SecretPrompt implements
GDBusInterface, GInitable and GAsyncInitable.</p>
</div>
<div class="refsect1">
<a name="SecretPrompt.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libsecret/secret.h>
</pre>
</div>
<div class="refsect1">
<a name="SecretPrompt.description"></a><h2>Description</h2>
<p>A <a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a> represents a prompt in the Secret Service.</p>
<p>Certain actions on the Secret Service require user prompting to complete,
such as creating a collection, or unlocking a collection. When such a prompt
is necessary, then a <a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a> object is created by this library, and
passed to the <a class="link" href="SecretService.html#secret-service-prompt" title="secret_service_prompt ()"><code class="function">secret_service_prompt()</code></a> method. In this way it is handled
automatically.</p>
<p>In order to customize prompt handling, override the
SecretServiceClass::prompt_async and SecretServiceClass::prompt_finish
virtual methods of the <a class="link" href="SecretService.html" title="SecretService"><span class="type">SecretService</span></a> class.</p>
</div>
<div class="refsect1">
<a name="SecretPrompt.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="secret-prompt-perform"></a><h3>secret_prompt_perform ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
secret_prompt_perform (<em class="parameter"><code><a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *window_id</code></em>,
<em class="parameter"><code>const <span class="type">GVariantType</span> *return_type</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Runs a prompt and performs the prompting. Returns <code class="literal">TRUE</code> if the prompt
was completed and not dismissed.</p>
<p>If <em class="parameter"><code>window_id</code></em>
is non-null then it is used as an XWindow id on Linux. The API
expects this id to be converted to a string using the <code class="literal"><code class="literal">d</code></code>
printf format. The Secret Service can make its prompt transient for the window
with this id. In some Secret Service implementations this is not possible, so
the behavior depending on this should degrade gracefully.</p>
<p>This method will return immediately and complete asynchronously.</p>
<div class="refsect3">
<a name="secret-prompt-perform.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window_id</p></td>
<td class="parameter_description"><p>string form of XWindow id for parent window to be transient for. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>return_type</p></td>
<td class="parameter_description"><p>the variant type of the prompt result</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the operation completes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to be passed to the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-prompt-perform-finish"></a><h3>secret_prompt_perform_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> *
secret_prompt_perform_finish (<em class="parameter"><code><a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Complete asynchronous operation to run a prompt and perform the prompting.</p>
<p>Returns a variant result if the prompt was completed and not dismissed. The
type of result depends on the action the prompt is completing, and is
defined in the Secret Service DBus API specification.</p>
<div class="refsect3">
<a name="secret-prompt-perform-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>the asynchronous result passed to the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-prompt-perform-finish.returns"></a><h4>Returns</h4>
<p><code class="literal">NULL</code> if the prompt was dismissed or an error occurred,
a variant result if the prompt was successful. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-prompt-perform-sync"></a><h3>secret_prompt_perform_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> *
secret_prompt_perform_sync (<em class="parameter"><code><a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *window_id</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code>const <span class="type">GVariantType</span> *return_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Runs a prompt and performs the prompting. Returns a variant result if the
prompt was completed and not dismissed. The type of result depends on the
action the prompt is completing, and is defined in the Secret Service DBus
API specification.</p>
<p>If <em class="parameter"><code>window_id</code></em>
is non-null then it is used as an XWindow id on Linux. The API
expects this id to be converted to a string using the <code class="literal"><code class="literal">d</code></code>
printf format. The Secret Service can make its prompt transient for the window
with this id. In some Secret Service implementations this is not possible,
so the behavior depending on this should degrade gracefully.</p>
<p>This method may block indefinitely and should not be used in user interface
threads.</p>
<div class="refsect3">
<a name="secret-prompt-perform-sync.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window_id</p></td>
<td class="parameter_description"><p>string form of XWindow id for parent window to be transient for. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>return_type</p></td>
<td class="parameter_description"><p>the variant type of the prompt result</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-prompt-perform-sync.returns"></a><h4>Returns</h4>
<p><code class="literal">NULL</code> if the prompt was dismissed or an error occurred. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-prompt-run"></a><h3>secret_prompt_run ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> *
secret_prompt_run (<em class="parameter"><code><a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *window_id</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code>const <span class="type">GVariantType</span> *return_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Runs a prompt and performs the prompting. Returns a variant result if the
prompt was completed and not dismissed. The type of result depends on the
action the prompt is completing, and is defined in the Secret Service DBus
API specification.</p>
<p>If <em class="parameter"><code>window_id</code></em>
is non-null then it is used as an XWindow id on Linux. The API
expects this id to be converted to a string using the <code class="literal"><code class="literal">d</code></code>
printf format. The Secret Service can make its prompt transient for the window
with this id. In some Secret Service implementations this is not possible, so
the behavior depending on this should degrade gracefully.</p>
<p>This runs the dialog in a recursive mainloop. When run from a user interface
thread, this means the user interface will remain responsive. Care should be
taken that appropriate user interface actions are disabled while running the
prompt.</p>
<div class="refsect3">
<a name="secret-prompt-run.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window_id</p></td>
<td class="parameter_description"><p>string form of XWindow id for parent window to be transient for. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>return_type</p></td>
<td class="parameter_description"><p>the variant type of the prompt result</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-prompt-run.returns"></a><h4>Returns</h4>
<p><code class="literal">NULL</code> if the prompt was dismissed or an error occurred. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="SecretPrompt.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SecretPrompt-struct"></a><h3>struct SecretPrompt</h3>
<pre class="programlisting">struct SecretPrompt;</pre>
<p>A proxy object representing a prompt that the Secret Service will display
to the user.</p>
</div>
<hr>
<div class="refsect2">
<a name="SecretPromptClass"></a><h3>struct SecretPromptClass</h3>
<pre class="programlisting">struct SecretPromptClass {
GDBusProxyClass parent_class;
};
</pre>
<p>The class for <a class="link" href="SecretPrompt.html" title="SecretPrompt"><span class="type">SecretPrompt</span></a>.</p>
<div class="refsect3">
<a name="SecretPromptClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" 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></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>
|