/usr/share/gtk-doc/html/libsignon-glib/gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html is in libsignon-glib-doc 1.13+16.04.20151209.1-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>com.google.code.AccountsSSO.SingleSignOn.AuthSession: libsignon-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libsignon-glib Reference Manual">
<link rel="up" href="signond-dbus-api.html" title="Part III. signond D-Bus API">
<link rel="prev" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html" title="com.google.code.AccountsSSO.SingleSignOn.AuthService">
<link rel="next" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html" title="com.google.code.AccountsSSO.SingleSignOn.Identity">
<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="#gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.description" class="shortcut">Description</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.signals" class="shortcut">Signals</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="signond-dbus-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-com-google-code-AccountsSSO-SingleSignOn-AuthSession.top_of_page"></a>com.google.code.AccountsSSO.SingleSignOn.AuthSession</span></h2>
<p>com.google.code.AccountsSSO.SingleSignOn.AuthSession — An authentication session for an Identity.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.queryAvailableMechanisms" title="The queryAvailableMechanisms() method">queryAvailableMechanisms</a> (IN as wantedMechanisms,
OUT as mechanisms);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.process" title="The process() method">process</a> (IN a{sv} sessionDataVa,
IN s mechanism,
OUT a{sv} sessionData);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.cancel" title="The cancel() method">cancel</a> ();
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.setId" title="The setId() method">setId</a> (IN u id);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.objectUnref" title="The objectUnref() method">objectUnref</a> ();
</pre>
</div>
<div class="refsect1">
<a name="id-1.4.4.4"></a><h2>Signals</h2>
<pre class="synopsis">
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-AuthSession.stateChanged" title='The "stateChanged" signal'>stateChanged</a> (i state,
s message);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html#gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-AuthSession.unregistered" title='The "unregistered" signal'>unregistered</a> ();
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-com-google-code-AccountsSSO-SingleSignOn-AuthSession"></a><h2>Description</h2>
<p> The signond D-Bus APIs are unstable, subject to change and should not be
used by client applications, which should use libsignon-glib or
libsignon-qt instead.
</p>
<p> Handle the client authentication process.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-com.google.code.AccountsSSO.SingleSignOn.AuthSession"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.queryAvailableMechanisms"></a><h3>The queryAvailableMechanisms() method</h3>
<pre class="programlisting">
queryAvailableMechanisms (IN as wantedMechanisms,
OUT as mechanisms);
</pre>
<p> AuthSession
<em class="parameter"><code>mechanisms</code></em>: the available authentication mechanisms
<em class="parameter"><code>wantedMechanisms</code></em>: the desired authentication mechanisms
</p>
<p> Query the available authentication mechanisms for this AuthSession. The
result will be the intersection of the desired authentication mechanisms
and those that are supported by the AuthSession.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN as <em class="parameter"><code>wantedMechanisms</code></em></code>:</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT as <em class="parameter"><code>mechanisms</code></em></code>:</span></p></td>
<td><p></p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.process"></a><h3>The process() method</h3>
<pre class="programlisting">
process (IN a{sv} sessionDataVa,
IN s mechanism,
OUT a{sv} sessionData);
</pre>
<p> Using the available parameters in the Identity or <em class="parameter"><code>sessionDataVa</code></em>, start
the authentication process by passing the parameters to the
authentication plugin.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>sessionDataVa</code></em></code>:</span></p></td>
<td><p>additional session data parameters</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>mechanism</code></em></code>:</span></p></td>
<td><p>the authentication mechanism to use</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>sessionData</code></em></code>:</span></p></td>
<td><p></p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.cancel"></a><h3>The cancel() method</h3>
<pre class="programlisting">
cancel ();
</pre>
<p> Cancel the current authentication session
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.setId"></a><h3>The setId() method</h3>
<pre class="programlisting">
setId (IN u id);
</pre>
<p> Set the ID of the AuthSession.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN u <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p>the ID to set</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthSession.objectUnref"></a><h3>The objectUnref() method</h3>
<pre class="programlisting">
objectUnref ();
</pre>
<p> Forcibly remove the AuthSession.
</p>
<div class="warning"><p>The objectUnref() method is deprecated.</p></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-signals-com.google.code.AccountsSSO.SingleSignOn.AuthSession"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-AuthSession.stateChanged"></a><h3>The "stateChanged" signal</h3>
<pre class="programlisting">
stateChanged (i state,
s message);
</pre>
<p> Emitted when the current authentication state changed, such as when the
Ideneity was signed out.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">i <em class="parameter"><code>state</code></em></code>:</span></p></td>
<td><p>the current state of the AuthSession</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">s <em class="parameter"><code>message</code></em></code>:</span></p></td>
<td><p>a message associated with the state change</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-AuthSession.unregistered"></a><h3>The "unregistered" signal</h3>
<pre class="programlisting">
unregistered ();
</pre>
<p> Emitted when the AuthSession is removed or destroyed, such as when using
objectUnref.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|