/usr/share/gtk-doc/html/snapd-glib/snapd-glib-snapd-login().html is in libsnapd-glib-dev 1.39-0ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>snapd_login(): snapd-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="snapd-glib Reference Manual">
<link rel="up" href="ch01.html" title="Snapd-GLib">
<link rel="prev" href="snapd-glib-Version-Information.html" title="Version Information">
<link rel="next" href="SnapdApp.html" title="SnapdApp">
<meta name="generator" content="GTK-Doc V1.27 (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="#snapd-glib-snapd-login().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="snapd-glib-Version-Information.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="SnapdApp.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="snapd-glib-snapd-login()"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="snapd-glib-snapd-login().top_of_page"></a>snapd_login()</span></h2>
<p>snapd_login() — Client authorization</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="snapd-glib-snapd-login().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">
<a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="returnvalue">SnapdAuthData</span></a> *
</td>
<td class="function_name">
<a class="link" href="snapd-glib-snapd-login().html#snapd-login-sync" title="snapd_login_sync ()">snapd_login_sync</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="snapd-glib-snapd-login().html#snapd-login-async" title="snapd_login_async ()">snapd_login_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="returnvalue">SnapdAuthData</span></a> *
</td>
<td class="function_name">
<a class="link" href="snapd-glib-snapd-login().html#snapd-login-finish" title="snapd_login_finish ()">snapd_login_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="snapd-glib-snapd-login().includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <snapd-glib/snapd-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="snapd-glib-snapd-login().description"></a><h2>Description</h2>
<p>Deprecated methods of authenticating with snapd.</p>
</div>
<div class="refsect1">
<a name="snapd-glib-snapd-login().functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="snapd-login-sync"></a><h3>snapd_login_sync ()</h3>
<pre class="programlisting"><a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="returnvalue">SnapdAuthData</span></a> *
snapd_login_sync (<em class="parameter"><code>const <span class="type">gchar</span> *username</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *otp</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">snapd_login_sync</code> has been deprecated since version 1.34 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="SnapdClient.html#snapd-client-login2-sync" title="snapd_client_login2_sync ()"><code class="function">snapd_client_login2_sync()</code></a></p>
</div>
<p>This call used to contact a D-Bus service to perform snapd authentication using
Polkit. This now just creates a <a class="link" href="SnapdClient.html" title="SnapdClient"><span class="type">SnapdClient</span></a> and does the call directly.</p>
<div class="refsect3">
<a name="snapd-login-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>username</p></td>
<td class="parameter_description"><p>username to log in with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>password to log in with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>otp</p></td>
<td class="parameter_description"><p>response to one-time password challenge. </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>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>. </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>error</p></td>
<td class="parameter_description"><p><span class="type">GError</span> location to store the error occurring, or <code class="literal">NULL</code>
to ignore. </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>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="snapd-login-sync.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a> or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="snapd-login-async"></a><h3>snapd_login_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
snapd_login_async (<em class="parameter"><code>const <span class="type">gchar</span> *username</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *otp</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>
<div class="warning">
<p><code class="literal">snapd_login_async</code> has been deprecated since version 1.34 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="SnapdClient.html#snapd-client-login2-async" title="snapd_client_login2_async ()"><code class="function">snapd_client_login2_async()</code></a></p>
</div>
<p>Asynchronously get authorization to install/remove snaps.
See <a class="link" href="snapd-glib-snapd-login().html#snapd-login-sync" title="snapd_login_sync ()"><code class="function">snapd_login_sync()</code></a> for more information.</p>
<div class="refsect3">
<a name="snapd-login-async.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>username</p></td>
<td class="parameter_description"><p>username to log in with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>password to log in with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>otp</p></td>
<td class="parameter_description"><p>response to one-time password challenge. </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>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>. </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>callback</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="snapd-login-finish"></a><h3>snapd_login_finish ()</h3>
<pre class="programlisting"><a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="returnvalue">SnapdAuthData</span></a> *
snapd_login_finish (<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>
<div class="warning">
<p><code class="literal">snapd_login_finish</code> has been deprecated since version 1.34 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="SnapdClient.html#snapd-client-login2-finish" title="snapd_client_login2_finish ()"><code class="function">snapd_client_login2_finish()</code></a></p>
</div>
<p>Complete login started with <a class="link" href="snapd-glib-snapd-login().html#snapd-login-async" title="snapd_login_async ()"><code class="function">snapd_login_async()</code></a>.
See <a class="link" href="snapd-glib-snapd-login().html#snapd-login-sync" title="snapd_login_sync ()"><code class="function">snapd_login_sync()</code></a> for more information.</p>
<div class="refsect3">
<a name="snapd-login-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>result</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncResult</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><span class="type">GError</span> location to store the error occurring, or <code class="literal">NULL</code> to ignore. </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>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="snapd-login-finish.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a> or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="snapd-glib-snapd-login().other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|