docs/reference/html/SignonAuthSession.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>libgsignon-glib Reference Manual: SignonAuthSession</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="libgsignon-glib Reference Manual">
   8 <link rel="up" href="credential-management.html" title="Credential management">
   9 <link rel="prev" href="SignonSecurityContext.html" title="SignonSecurityContext">
  10 <link rel="next" href="libgsignon-glib-SignonError.html" title="SignonError">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#SignonAuthSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#SignonAuthSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
  20                   <a href="#SignonAuthSession.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
  21                   <a href="#SignonAuthSession.signals" class="shortcut">Signals</a></span>
  22 </td>
  23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  24 <td><a accesskey="u" href="credential-management.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  25 <td><a accesskey="p" href="SignonSecurityContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  26 <td><a accesskey="n" href="libgsignon-glib-SignonError.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  27 </tr></table>
  28 <div class="refentry">
  29 <a name="SignonAuthSession"></a><div class="titlepage"></div>
  30 <div class="refnamediv"><table width="100%"><tr>
  31 <td valign="top">
  32 <h2><span class="refentrytitle"><a name="SignonAuthSession.top_of_page"></a>SignonAuthSession</span></h2>
  33 <p>SignonAuthSession — the authentication session object</p>
  34 </td>
  35 <td class="gallery_image" valign="top" align="right"></td>
  36 </tr></table></div>
  37 <div class="refsect1">
  38 <a name="SignonAuthSession.functions"></a><h2>Functions</h2>
  39 <div class="informaltable"><table width="100%" border="0">
  40 <colgroup>
  41 <col width="150px" class="functions_return">
  42 <col class="functions_name">
  43 </colgroup>
  44 <tbody>
  45 <tr>
  46 <td class="function_type">
  47 <span class="returnvalue">void</span>
  48 </td>
  49 <td class="function_name">
  50 <span class="c_punctuation">(</span><a class="link" href="SignonAuthSession.html#SignonAuthSessionProcessCb" title="SignonAuthSessionProcessCb ()">*SignonAuthSessionProcessCb</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
  51 </td>
  52 </tr>
  53 <tr>
  54 <td class="function_type">
  55 <span class="returnvalue">void</span>
  56 </td>
  57 <td class="function_name">
  58 <span class="c_punctuation">(</span><a class="link" href="SignonAuthSession.html#SignonAuthSessionQueryAvailableMechanismsCb" title="SignonAuthSessionQueryAvailableMechanismsCb ()">*SignonAuthSessionQueryAvailableMechanismsCb</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
  59 </td>
  60 </tr>
  61 <tr>
  62 <td class="function_type">
  63 <span class="returnvalue">void</span>
  64 </td>
  65 <td class="function_name">
  66 <a class="link" href="SignonAuthSession.html#signon-auth-session-cancel" title="signon_auth_session_cancel ()">signon_auth_session_cancel</a> <span class="c_punctuation">()</span>
  67 </td>
  68 </tr>
  69 <tr>
  70 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  71 </td>
  72 <td class="function_name">
  73 <a class="link" href="SignonAuthSession.html#signon-auth-session-get-method" title="signon_auth_session_get_method ()">signon_auth_session_get_method</a> <span class="c_punctuation">()</span>
  74 </td>
  75 </tr>
  76 <tr>
  77 <td class="function_type">
  78 <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="returnvalue">SignonAuthSession</span></a> *
  79 </td>
  80 <td class="function_name">
  81 <a class="link" href="SignonAuthSession.html#signon-auth-session-new" title="signon_auth_session_new ()">signon_auth_session_new</a> <span class="c_punctuation">()</span>
  82 </td>
  83 </tr>
  84 <tr>
  85 <td class="function_type">
  86 <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="returnvalue">SignonAuthSession</span></a> *
  87 </td>
  88 <td class="function_name">
  89 <a class="link" href="SignonAuthSession.html#signon-auth-session-new-for-identity" title="signon_auth_session_new_for_identity ()">signon_auth_session_new_for_identity</a> <span class="c_punctuation">()</span>
  90 </td>
  91 </tr>
  92 <tr>
  93 <td class="function_type">
  94 <span class="returnvalue">void</span>
  95 </td>
  96 <td class="function_name">
  97 <a class="link" href="SignonAuthSession.html#signon-auth-session-process" title="signon_auth_session_process ()">signon_auth_session_process</a> <span class="c_punctuation">()</span>
  98 </td>
  99 </tr>
 100 <tr>
 101 <td class="function_type">
 102 <span class="returnvalue">void</span>
 103 </td>
 104 <td class="function_name">
 105 <a class="link" href="SignonAuthSession.html#signon-auth-session-process-async" title="signon_auth_session_process_async ()">signon_auth_session_process_async</a> <span class="c_punctuation">()</span>
 106 </td>
 107 </tr>
 108 <tr>
 109 <td class="function_type">
 110 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 111 </td>
 112 <td class="function_name">
 113 <a class="link" href="SignonAuthSession.html#signon-auth-session-process-finish" title="signon_auth_session_process_finish ()">signon_auth_session_process_finish</a> <span class="c_punctuation">()</span>
 114 </td>
 115 </tr>
 116 <tr>
 117 <td class="function_type">
 118 <span class="returnvalue">void</span>
 119 </td>
 120 <td class="function_name">
 121 <a class="link" href="SignonAuthSession.html#signon-auth-session-query-available-mechanisms" title="signon_auth_session_query_available_mechanisms ()">signon_auth_session_query_available_mechanisms</a> <span class="c_punctuation">()</span>
 122 </td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <div class="refsect1">
 128 <a name="SignonAuthSession.properties"></a><h2>Properties</h2>
 129 <div class="informaltable"><table border="0">
 130 <colgroup>
 131 <col width="150px" class="properties_type">
 132 <col width="300px" class="properties_name">
 133 <col width="200px" class="properties_flags">
 134 </colgroup>
 135 <tbody><tr>
 136 <td class="property_type">
 137 <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> *</td>
 138 <td class="property_name"><a class="link" href="SignonAuthSession.html#SignonAuthSession--identity" title="The “identity” property">identity</a></td>
 139 <td class="property_flags">Read / Write / Construct Only</td>
 140 </tr></tbody>
 141 </table></div>
 142 </div>
 143 <div class="refsect1">
 144 <a name="SignonAuthSession.signals"></a><h2>Signals</h2>
 145 <div class="informaltable"><table border="0">
 146 <colgroup>
 147 <col width="150px" class="signals_return">
 148 <col width="300px" class="signals_name">
 149 <col width="200px" class="signals_flags">
 150 </colgroup>
 151 <tbody><tr>
 152 <td class="signal_type"><span class="returnvalue">void</span></td>
 153 <td class="signal_name"><a class="link" href="SignonAuthSession.html#SignonAuthSession-state-changed" title="The “state-changed” signal">state-changed</a></td>
 154 <td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
 155 </tr></tbody>
 156 </table></div>
 157 </div>
 158 <div class="refsect1">
 159 <a name="SignonAuthSession.other"></a><h2>Types and Values</h2>
 160 <div class="informaltable"><table width="100%" border="0">
 161 <colgroup>
 162 <col width="150px" class="name">
 163 <col class="description">
 164 </colgroup>
 165 <tbody>
 166 <tr>
 167 <td class="define_keyword">#define</td>
 168 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-CAPTION:CAPS" title="SIGNON_SESSION_DATA_CAPTION">SIGNON_SESSION_DATA_CAPTION</a></td>
 169 </tr>
 170 <tr>
 171 <td class="define_keyword">#define</td>
 172 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-PROXY:CAPS" title="SIGNON_SESSION_DATA_PROXY">SIGNON_SESSION_DATA_PROXY</a></td>
 173 </tr>
 174 <tr>
 175 <td class="define_keyword">#define</td>
 176 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-REALM:CAPS" title="SIGNON_SESSION_DATA_REALM">SIGNON_SESSION_DATA_REALM</a></td>
 177 </tr>
 178 <tr>
 179 <td class="define_keyword">#define</td>
 180 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-RENEW-TOKEN:CAPS" title="SIGNON_SESSION_DATA_RENEW_TOKEN">SIGNON_SESSION_DATA_RENEW_TOKEN</a></td>
 181 </tr>
 182 <tr>
 183 <td class="define_keyword">#define</td>
 184 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-SECRET:CAPS" title="SIGNON_SESSION_DATA_SECRET">SIGNON_SESSION_DATA_SECRET</a></td>
 185 </tr>
 186 <tr>
 187 <td class="define_keyword">#define</td>
 188 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-TIMEOUT:CAPS" title="SIGNON_SESSION_DATA_TIMEOUT">SIGNON_SESSION_DATA_TIMEOUT</a></td>
 189 </tr>
 190 <tr>
 191 <td class="define_keyword">#define</td>
 192 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-UI-POLICY:CAPS" title="SIGNON_SESSION_DATA_UI_POLICY">SIGNON_SESSION_DATA_UI_POLICY</a></td>
 193 </tr>
 194 <tr>
 195 <td class="define_keyword">#define</td>
 196 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-USERNAME:CAPS" title="SIGNON_SESSION_DATA_USERNAME">SIGNON_SESSION_DATA_USERNAME</a></td>
 197 </tr>
 198 <tr>
 199 <td class="define_keyword">#define</td>
 200 <td class="function_name"><a class="link" href="SignonAuthSession.html#SIGNON-SESSION-DATA-WINDOW-ID:CAPS" title="SIGNON_SESSION_DATA_WINDOW_ID">SIGNON_SESSION_DATA_WINDOW_ID</a></td>
 201 </tr>
 202 <tr>
 203 <td class="datatype_keyword">struct</td>
 204 <td class="function_name"><a class="link" href="SignonAuthSession.html#SignonAuthSession-struct" title="struct SignonAuthSession">SignonAuthSession</a></td>
 205 </tr>
 206 <tr>
 207 <td class="datatype_keyword">struct</td>
 208 <td class="function_name"><a class="link" href="SignonAuthSession.html#SignonAuthSessionClass" title="struct SignonAuthSessionClass">SignonAuthSessionClass</a></td>
 209 </tr>
 210 <tr>
 211 <td class="datatype_keyword">enum</td>
 212 <td class="function_name"><a class="link" href="SignonAuthSession.html#SignonSessionDataUiPolicy" title="enum SignonSessionDataUiPolicy">SignonSessionDataUiPolicy</a></td>
 213 </tr>
 214 </tbody>
 215 </table></div>
 216 </div>
 217 <div class="refsect1">
 218 <a name="SignonAuthSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
 219 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 220     <span class="lineart">╰──</span> SignonAuthSession
 221 </pre>
 222 </div>
 223 <div class="refsect1">
 224 <a name="SignonAuthSession.description"></a><h2>Description</h2>
 225 <p>The <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> object is responsible for handling the client
 226 authentication. <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> objects should be created from existing
 227 identities (via <a class="link" href="SignonIdentity.html#signon-identity-create-session" title="signon_identity_create_session ()"><code class="function">signon_identity_create_session()</code></a> or by passing a non-NULL identity
 228 to <a class="link" href="SignonAuthSession.html#signon-auth-session-new" title="signon_auth_session_new ()"><code class="function">signon_auth_session_new()</code></a>).</p>
 229 </div>
 230 <div class="refsect1">
 231 <a name="SignonAuthSession.functions_details"></a><h2>Functions</h2>
 232 <div class="refsect2">
 233 <a name="SignonAuthSessionProcessCb"></a><h3>SignonAuthSessionProcessCb ()</h3>
 234 <pre class="programlisting"><span class="returnvalue">void</span>
 235 <span class="c_punctuation">(</span>*SignonAuthSessionProcessCb<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>,
 236                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *session_data</code></em>,
 237                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
 238                                <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>
 239 <div class="warning"><p><code class="literal">SignonAuthSessionProcessCb</code> is deprecated and should not be used in newly-written code.</p></div>
 240 <p>This callback is invoked when the authentication plugin delivers the result
 241 of the <a class="link" href="SignonAuthSession.html#signon-auth-session-process" title="signon_auth_session_process ()"><code class="function">signon_auth_session_process()</code></a> operation.</p>
 242 <div class="refsect3">
 243 <a name="id-1.3.3.6.9.2.6"></a><h4>Parameters</h4>
 244 <div class="informaltable"><table width="100%" border="0">
 245 <colgroup>
 246 <col width="150px" class="parameters_name">
 247 <col class="parameters_description">
 248 <col width="200px" class="parameters_annotations">
 249 </colgroup>
 250 <tbody>
 251 <tr>
 252 <td class="parameter_name"><p>self</p></td>
 253 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 254 <td class="parameter_annotations"> </td>
 255 </tr>
 256 <tr>
 257 <td class="parameter_name"><p>session_data</p></td>
 258 <td class="parameter_description"><p> a dictionary with
 259 the response. </p></td>
 260 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GValue]</span></td>
 261 </tr>
 262 <tr>
 263 <td class="parameter_name"><p>error</p></td>
 264 <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> if an error occurred, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> otherwise.</p></td>
 265 <td class="parameter_annotations"> </td>
 266 </tr>
 267 <tr>
 268 <td class="parameter_name"><p>user_data</p></td>
 269 <td class="parameter_description"><p>the user data that was passed when installing this callback.</p></td>
 270 <td class="parameter_annotations"> </td>
 271 </tr>
 272 </tbody>
 273 </table></div>
 274 </div>
 275 </div>
 276 <hr>
 277 <div class="refsect2">
 278 <a name="SignonAuthSessionQueryAvailableMechanismsCb"></a><h3>SignonAuthSessionQueryAvailableMechanismsCb ()</h3>
 279 <pre class="programlisting"><span class="returnvalue">void</span>
 280 <span class="c_punctuation">(</span>*SignonAuthSessionQueryAvailableMechanismsCb<span class="c_punctuation">)</span>
 281                                (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>,
 282                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **mechanisms</code></em>,
 283                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
 284                                 <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>
 285 <p>Callback to be passed to <a class="link" href="SignonAuthSession.html#signon-auth-session-query-available-mechanisms" title="signon_auth_session_query_available_mechanisms ()"><code class="function">signon_auth_session_query_available_mechanisms()</code></a>.</p>
 286 <div class="refsect3">
 287 <a name="id-1.3.3.6.9.3.5"></a><h4>Parameters</h4>
 288 <div class="informaltable"><table width="100%" border="0">
 289 <colgroup>
 290 <col width="150px" class="parameters_name">
 291 <col class="parameters_description">
 292 <col width="200px" class="parameters_annotations">
 293 </colgroup>
 294 <tbody>
 295 <tr>
 296 <td class="parameter_name"><p>self</p></td>
 297 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 298 <td class="parameter_annotations"> </td>
 299 </tr>
 300 <tr>
 301 <td class="parameter_name"><p>mechanisms</p></td>
 302 <td class="parameter_description"><p> list of available mechanisms. </p></td>
 303 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GStrv]</span></td>
 304 </tr>
 305 <tr>
 306 <td class="parameter_name"><p>error</p></td>
 307 <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> if an error occurred, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> otherwise.</p></td>
 308 <td class="parameter_annotations"> </td>
 309 </tr>
 310 <tr>
 311 <td class="parameter_name"><p>user_data</p></td>
 312 <td class="parameter_description"><p>the user data that was passed when installing this callback.</p></td>
 313 <td class="parameter_annotations"> </td>
 314 </tr>
 315 </tbody>
 316 </table></div>
 317 </div>
 318 </div>
 319 <hr>
 320 <div class="refsect2">
 321 <a name="signon-auth-session-cancel"></a><h3>signon_auth_session_cancel ()</h3>
 322 <pre class="programlisting"><span class="returnvalue">void</span>
 323 signon_auth_session_cancel (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>);</pre>
 324 <p>Cancel the authentication session.</p>
 325 <div class="refsect3">
 326 <a name="id-1.3.3.6.9.4.5"></a><h4>Parameters</h4>
 327 <div class="informaltable"><table width="100%" border="0">
 328 <colgroup>
 329 <col width="150px" class="parameters_name">
 330 <col class="parameters_description">
 331 <col width="200px" class="parameters_annotations">
 332 </colgroup>
 333 <tbody><tr>
 334 <td class="parameter_name"><p>self</p></td>
 335 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 336 <td class="parameter_annotations"> </td>
 337 </tr></tbody>
 338 </table></div>
 339 </div>
 340 </div>
 341 <hr>
 342 <div class="refsect2">
 343 <a name="signon-auth-session-get-method"></a><h3>signon_auth_session_get_method ()</h3>
 344 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 345 signon_auth_session_get_method (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>);</pre>
 346 <p>Get the current authentication method.</p>
 347 <div class="refsect3">
 348 <a name="id-1.3.3.6.9.5.5"></a><h4>Parameters</h4>
 349 <div class="informaltable"><table width="100%" border="0">
 350 <colgroup>
 351 <col width="150px" class="parameters_name">
 352 <col class="parameters_description">
 353 <col width="200px" class="parameters_annotations">
 354 </colgroup>
 355 <tbody><tr>
 356 <td class="parameter_name"><p>self</p></td>
 357 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 358 <td class="parameter_annotations"> </td>
 359 </tr></tbody>
 360 </table></div>
 361 </div>
 362 <div class="refsect3">
 363 <a name="id-1.3.3.6.9.5.6"></a><h4>Returns</h4>
 364 <p> the authentication method being used, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</p>
 365 <p></p>
 366 </div>
 367 </div>
 368 <hr>
 369 <div class="refsect2">
 370 <a name="signon-auth-session-new"></a><h3>signon_auth_session_new ()</h3>
 371 <pre class="programlisting"><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="returnvalue">SignonAuthSession</span></a> *
 372 signon_auth_session_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>,
 373                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method_name</code></em>,
 374                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
 375 <p>Creates a new <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>, which can be used to authenticate using
 376 the specified method.</p>
 377 <div class="refsect3">
 378 <a name="id-1.3.3.6.9.6.5"></a><h4>Parameters</h4>
 379 <div class="informaltable"><table width="100%" border="0">
 380 <colgroup>
 381 <col width="150px" class="parameters_name">
 382 <col class="parameters_description">
 383 <col width="200px" class="parameters_annotations">
 384 </colgroup>
 385 <tbody>
 386 <tr>
 387 <td class="parameter_name"><p>id</p></td>
 388 <td class="parameter_description"><p>the id of the <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> to be used. Can be 0, if this session is
 389 not bound to any stored identity.</p></td>
 390 <td class="parameter_annotations"> </td>
 391 </tr>
 392 <tr>
 393 <td class="parameter_name"><p>method_name</p></td>
 394 <td class="parameter_description"><p>the name of the authentication method to be used.</p></td>
 395 <td class="parameter_annotations"> </td>
 396 </tr>
 397 <tr>
 398 <td class="parameter_name"><p>err</p></td>
 399 <td class="parameter_description"><p>a pointer to a location which will contain the error, in case this
 400 function fails.</p></td>
 401 <td class="parameter_annotations"> </td>
 402 </tr>
 403 </tbody>
 404 </table></div>
 405 </div>
 406 <div class="refsect3">
 407 <a name="id-1.3.3.6.9.6.6"></a><h4>Returns</h4>
 408 <p> a new <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p>
 409 <p></p>
 410 </div>
 411 </div>
 412 <hr>
 413 <div class="refsect2">
 414 <a name="signon-auth-session-new-for-identity"></a><h3>signon_auth_session_new_for_identity ()</h3>
 415 <pre class="programlisting"><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="returnvalue">SignonAuthSession</span></a> *
 416 signon_auth_session_new_for_identity (<em class="parameter"><code><a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> *identity</code></em>,
 417                                       <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method_name</code></em>,
 418                                       <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
 419 <p>Creates a new <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>, which can be used to authenticate using
 420 the specified method.</p>
 421 <div class="refsect3">
 422 <a name="id-1.3.3.6.9.7.5"></a><h4>Parameters</h4>
 423 <div class="informaltable"><table width="100%" border="0">
 424 <colgroup>
 425 <col width="150px" class="parameters_name">
 426 <col class="parameters_description">
 427 <col width="200px" class="parameters_annotations">
 428 </colgroup>
 429 <tbody>
 430 <tr>
 431 <td class="parameter_name"><p>identity</p></td>
 432 <td class="parameter_description"><p><a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> parent object.</p></td>
 433 <td class="parameter_annotations"> </td>
 434 </tr>
 435 <tr>
 436 <td class="parameter_name"><p>method_name</p></td>
 437 <td class="parameter_description"><p>the name of the authentication method to be used.</p></td>
 438 <td class="parameter_annotations"> </td>
 439 </tr>
 440 <tr>
 441 <td class="parameter_name"><p>err</p></td>
 442 <td class="parameter_description"><p>a pointer to a location which will contain the error, in case this
 443 function fails.</p></td>
 444 <td class="parameter_annotations"> </td>
 445 </tr>
 446 </tbody>
 447 </table></div>
 448 </div>
 449 <div class="refsect3">
 450 <a name="id-1.3.3.6.9.7.6"></a><h4>Returns</h4>
 451 <p> a new <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p>
 452 <p></p>
 453 </div>
 454 </div>
 455 <hr>
 456 <div class="refsect2">
 457 <a name="signon-auth-session-process"></a><h3>signon_auth_session_process ()</h3>
 458 <pre class="programlisting"><span class="returnvalue">void</span>
 459 signon_auth_session_process (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>,
 460                              <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *session_data</code></em>,
 461                              <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>,
 462                              <em class="parameter"><code><a class="link" href="SignonAuthSession.html#SignonAuthSessionProcessCb" title="SignonAuthSessionProcessCb ()"><span class="type">SignonAuthSessionProcessCb</span></a> cb</code></em>,
 463                              <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>
 464 <div class="warning">
 465 <p><code class="literal">signon_auth_session_process</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
 466 <p>Use <a class="link" href="SignonAuthSession.html#signon-auth-session-process-async" title="signon_auth_session_process_async ()"><code class="function">signon_auth_session_process_async()</code></a> instead.</p>
 467 </div>
 468 <p>Performs one step of the authentication process. If the <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> that
 469 this session belongs to contains a username and a password, they will be also
 470 passed to the authentication plugin, otherwise they should be set directly in
 471 <em class="parameter"><code>session_data</code></em>
 472 .
 473 <em class="parameter"><code>session_data</code></em>
 474  should be used to add additional authentication parameters to the
 475 session, or to override the parameters otherwise taken from the identity.</p>
 476 <div class="refsect3">
 477 <a name="id-1.3.3.6.9.8.6"></a><h4>Parameters</h4>
 478 <div class="informaltable"><table width="100%" border="0">
 479 <colgroup>
 480 <col width="150px" class="parameters_name">
 481 <col class="parameters_description">
 482 <col width="200px" class="parameters_annotations">
 483 </colgroup>
 484 <tbody>
 485 <tr>
 486 <td class="parameter_name"><p>self</p></td>
 487 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 488 <td class="parameter_annotations"> </td>
 489 </tr>
 490 <tr>
 491 <td class="parameter_name"><p>session_data</p></td>
 492 <td class="parameter_description"><p> a dictionary of parameters. </p></td>
 493 <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>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GValue]</span></td>
 494 </tr>
 495 <tr>
 496 <td class="parameter_name"><p>mechanism</p></td>
 497 <td class="parameter_description"><p>the authentication mechanism to be used.</p></td>
 498 <td class="parameter_annotations"> </td>
 499 </tr>
 500 <tr>
 501 <td class="parameter_name"><p>cb</p></td>
 502 <td class="parameter_description"><p> a callback which will be called with the result. </p></td>
 503 <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>
 504 </tr>
 505 <tr>
 506 <td class="parameter_name"><p>user_data</p></td>
 507 <td class="parameter_description"><p>user data to be passed to the callback.</p></td>
 508 <td class="parameter_annotations"> </td>
 509 </tr>
 510 </tbody>
 511 </table></div>
 512 </div>
 513 </div>
 514 <hr>
 515 <div class="refsect2">
 516 <a name="signon-auth-session-process-async"></a><h3>signon_auth_session_process_async ()</h3>
 517 <pre class="programlisting"><span class="returnvalue">void</span>
 518 signon_auth_session_process_async (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>,
 519                                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *session_data</code></em>,
 520                                    <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>,
 521                                    <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 522                                    <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>,
 523                                    <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>
 524 <p>Performs one step of the authentication process.
 525 <em class="parameter"><code>session_data</code></em>
 526  should be used to add additional authentication parameters to the
 527 session.</p>
 528 <p>What specific parameters should be used can be found from authentication plugins'
 529 documentation (look for parameters that are expected in <a href="../gsignond/GSignondPlugin.html#gsignond-plugin-request-initial"><code class="function">gsignond_plugin_request_initial()</code></a>
 530 for the first step, and parameters that are expected in <a href="../gsignond/GSignondPlugin.html#gsignond-plugin-request"><code class="function">gsignond_plugin_request()</code></a> for
 531 the subsequent steps). See, for example, <a href="../gsignond/GSignondPasswordPlugin.html"><span class="type">GSignondPasswordPlugin</span></a> and <a href="../gsignond/GSignondDigestPlugin.html"><span class="type">GSignondDigestPlugin</span></a>.</p>
 532 <p>If the <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> that this session belongs to contains a username and a password,
 533 the daemon will pass them to the authentication plugin, otherwise they should be set directly in
 534 <em class="parameter"><code>session_data</code></em>
 535 . The daemon also passes a list of identity's allowed realms to the plugin,
 536 and they cannot be overriden.</p>
 537 <div class="refsect3">
 538 <a name="id-1.3.3.6.9.9.7"></a><h4>Parameters</h4>
 539 <div class="informaltable"><table width="100%" border="0">
 540 <colgroup>
 541 <col width="150px" class="parameters_name">
 542 <col class="parameters_description">
 543 <col width="200px" class="parameters_annotations">
 544 </colgroup>
 545 <tbody>
 546 <tr>
 547 <td class="parameter_name"><p>self</p></td>
 548 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 549 <td class="parameter_annotations"> </td>
 550 </tr>
 551 <tr>
 552 <td class="parameter_name"><p>session_data</p></td>
 553 <td class="parameter_description"><p> a dictionary of parameters. </p></td>
 554 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 555 </tr>
 556 <tr>
 557 <td class="parameter_name"><p>mechanism</p></td>
 558 <td class="parameter_description"><p>the authentication mechanism to be used.</p></td>
 559 <td class="parameter_annotations"> </td>
 560 </tr>
 561 <tr>
 562 <td class="parameter_name"><p>cancellable</p></td>
 563 <td class="parameter_description"><p> optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
 564 <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>
 565 </tr>
 566 <tr>
 567 <td class="parameter_name"><p>callback</p></td>
 568 <td class="parameter_description"><p> a callback which will be called when the
 569 authentication reply is available. </p></td>
 570 <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>
 571 </tr>
 572 <tr>
 573 <td class="parameter_name"><p>user_data</p></td>
 574 <td class="parameter_description"><p>user data to be passed to the callback.</p></td>
 575 <td class="parameter_annotations"> </td>
 576 </tr>
 577 </tbody>
 578 </table></div>
 579 </div>
 580 <p class="since">Since 1.8</p>
 581 </div>
 582 <hr>
 583 <div class="refsect2">
 584 <a name="signon-auth-session-process-finish"></a><h3>signon_auth_session_process_finish ()</h3>
 585 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 586 signon_auth_session_process_finish (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>,
 587                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *res</code></em>,
 588                                     <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>
 589 <p>Collect the result of the <a class="link" href="SignonAuthSession.html#signon-auth-session-process-async" title="signon_auth_session_process_async ()"><code class="function">signon_auth_session_process_async()</code></a> operation.</p>
 590 <div class="refsect3">
 591 <a name="id-1.3.3.6.9.10.5"></a><h4>Parameters</h4>
 592 <div class="informaltable"><table width="100%" border="0">
 593 <colgroup>
 594 <col width="150px" class="parameters_name">
 595 <col class="parameters_description">
 596 <col width="200px" class="parameters_annotations">
 597 </colgroup>
 598 <tbody>
 599 <tr>
 600 <td class="parameter_name"><p>self</p></td>
 601 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 602 <td class="parameter_annotations"> </td>
 603 </tr>
 604 <tr>
 605 <td class="parameter_name"><p>res</p></td>
 606 <td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> obtained from the <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> passed to
 607 <a class="link" href="SignonAuthSession.html#signon-auth-session-process-async" title="signon_auth_session_process_async ()"><code class="function">signon_auth_session_process_async()</code></a>.</p></td>
 608 <td class="parameter_annotations"> </td>
 609 </tr>
 610 <tr>
 611 <td class="parameter_name"><p>error</p></td>
 612 <td class="parameter_description"><p>return location for error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 613 <td class="parameter_annotations"> </td>
 614 </tr>
 615 </tbody>
 616 </table></div>
 617 </div>
 618 <div class="refsect3">
 619 <a name="id-1.3.3.6.9.10.6"></a><h4>Returns</h4>
 620 <p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of type <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#G-VARIANT-TYPE-VARDICT:CAPS"><code class="literal">G_VARIANT_TYPE_VARDICT</code></a> containing the
 621 authentication reply. As with <a class="link" href="SignonAuthSession.html#signon-auth-session-process-async" title="signon_auth_session_process_async ()"><code class="function">signon_auth_session_process_async()</code></a>, specific
 622 parameters contained in the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> can be found from plugins' documentation:
 623 <a href="../gsignond/GSignondPlugin.html#GSignondPlugin-response-final"><span class="type">“response-final”</span></a> for the final response, and <a href="../gsignond/GSignondPlugin.html#GSignondPlugin-response"><span class="type">“response”</span></a>
 624 for the intermediate responses. See, for example, <a href="../gsignond/GSignondPasswordPlugin.html"><span class="type">GSignondPasswordPlugin</span></a>
 625 and <a href="../gsignond/GSignondDigestPlugin.html"><span class="type">GSignondDigestPlugin</span></a>.</p>
 626 <p></p>
 627 </div>
 628 <p class="since">Since 1.8</p>
 629 </div>
 630 <hr>
 631 <div class="refsect2">
 632 <a name="signon-auth-session-query-available-mechanisms"></a><h3>signon_auth_session_query_available_mechanisms ()</h3>
 633 <pre class="programlisting"><span class="returnvalue">void</span>
 634 signon_auth_session_query_available_mechanisms
 635                                (<em class="parameter"><code><a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *self</code></em>,
 636                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **wanted_mechanisms</code></em>,
 637                                 <em class="parameter"><code><a class="link" href="SignonAuthSession.html#SignonAuthSessionQueryAvailableMechanismsCb" title="SignonAuthSessionQueryAvailableMechanismsCb ()"><span class="type">SignonAuthSessionQueryAvailableMechanismsCb</span></a> cb</code></em>,
 638                                 <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>
 639 <p>Queries the mechanisms available for this authentication session. The result
 640 will be the intersection between <em class="parameter"><code>wanted_mechanisms</code></em>
 641  and the mechanisms
 642 supported by the authentication plugin (and allowed by the <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> that this
 643 session belongs to).</p>
 644 <div class="refsect3">
 645 <a name="id-1.3.3.6.9.11.5"></a><h4>Parameters</h4>
 646 <div class="informaltable"><table width="100%" border="0">
 647 <colgroup>
 648 <col width="150px" class="parameters_name">
 649 <col class="parameters_description">
 650 <col width="200px" class="parameters_annotations">
 651 </colgroup>
 652 <tbody>
 653 <tr>
 654 <td class="parameter_name"><p>self</p></td>
 655 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a>.</p></td>
 656 <td class="parameter_annotations"> </td>
 657 </tr>
 658 <tr>
 659 <td class="parameter_name"><p>wanted_mechanisms</p></td>
 660 <td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of mechanisms supported by the client.</p></td>
 661 <td class="parameter_annotations"> </td>
 662 </tr>
 663 <tr>
 664 <td class="parameter_name"><p>cb</p></td>
 665 <td class="parameter_description"><p> a callback which will be called with the result. </p></td>
 666 <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>
 667 </tr>
 668 <tr>
 669 <td class="parameter_name"><p>user_data</p></td>
 670 <td class="parameter_description"><p>user data to be passed to the callback.</p></td>
 671 <td class="parameter_annotations"> </td>
 672 </tr>
 673 </tbody>
 674 </table></div>
 675 </div>
 676 </div>
 677 </div>
 678 <div class="refsect1">
 679 <a name="SignonAuthSession.other_details"></a><h2>Types and Values</h2>
 680 <div class="refsect2">
 681 <a name="SIGNON-SESSION-DATA-CAPTION:CAPS"></a><h3>SIGNON_SESSION_DATA_CAPTION</h3>
 682 <pre class="programlisting">#define SIGNON_SESSION_DATA_CAPTION       "Caption"
 683 </pre>
 684 <p>Caption for the UI dialog.</p>
 685 </div>
 686 <hr>
 687 <div class="refsect2">
 688 <a name="SIGNON-SESSION-DATA-PROXY:CAPS"></a><h3>SIGNON_SESSION_DATA_PROXY</h3>
 689 <pre class="programlisting">#define SIGNON_SESSION_DATA_PROXY         "NetworkProxy"
 690 </pre>
 691 <p>Proxy.</p>
 692 </div>
 693 <hr>
 694 <div class="refsect2">
 695 <a name="SIGNON-SESSION-DATA-REALM:CAPS"></a><h3>SIGNON_SESSION_DATA_REALM</h3>
 696 <pre class="programlisting">#define SIGNON_SESSION_DATA_REALM         "Realm"
 697 </pre>
 698 <p>Realm.</p>
 699 </div>
 700 <hr>
 701 <div class="refsect2">
 702 <a name="SIGNON-SESSION-DATA-RENEW-TOKEN:CAPS"></a><h3>SIGNON_SESSION_DATA_RENEW_TOKEN</h3>
 703 <pre class="programlisting">#define SIGNON_SESSION_DATA_RENEW_TOKEN   "RenewToken"
 704 </pre>
 705 <p>Requests the signon plugin to obtain a new token (boolean).</p>
 706 </div>
 707 <hr>
 708 <div class="refsect2">
 709 <a name="SIGNON-SESSION-DATA-SECRET:CAPS"></a><h3>SIGNON_SESSION_DATA_SECRET</h3>
 710 <pre class="programlisting">#define SIGNON_SESSION_DATA_SECRET        "Secret"
 711 </pre>
 712 <p>Secret.</p>
 713 </div>
 714 <hr>
 715 <div class="refsect2">
 716 <a name="SIGNON-SESSION-DATA-TIMEOUT:CAPS"></a><h3>SIGNON_SESSION_DATA_TIMEOUT</h3>
 717 <pre class="programlisting">#define SIGNON_SESSION_DATA_TIMEOUT       "NetworkTimeout"
 718 </pre>
 719 <p>Network timeout, in milliseconds (uint32).</p>
 720 </div>
 721 <hr>
 722 <div class="refsect2">
 723 <a name="SIGNON-SESSION-DATA-UI-POLICY:CAPS"></a><h3>SIGNON_SESSION_DATA_UI_POLICY</h3>
 724 <pre class="programlisting">#define SIGNON_SESSION_DATA_UI_POLICY     "UiPolicy"
 725 </pre>
 726 <p>Policy for the signon process.</p>
 727 <div class="refsect3">
 728 <a name="id-1.3.3.6.10.8.5"></a><h4>Parameters</h4>
 729 <div class="informaltable"><table width="100%" border="0">
 730 <colgroup>
 731 <col width="150px" class="parameters_name">
 732 <col class="parameters_description">
 733 <col width="200px" class="parameters_annotations">
 734 </colgroup>
 735 <tbody><tr>
 736 <td class="parameter_name"><p>see_also</p></td>
 737 <td class="parameter_description"><p><a class="link" href="SignonAuthSession.html#SignonSessionDataUiPolicy" title="enum SignonSessionDataUiPolicy"><span class="type">SignonSessionDataUiPolicy</span></a></p></td>
 738 <td class="parameter_annotations"> </td>
 739 </tr></tbody>
 740 </table></div>
 741 </div>
 742 </div>
 743 <hr>
 744 <div class="refsect2">
 745 <a name="SIGNON-SESSION-DATA-USERNAME:CAPS"></a><h3>SIGNON_SESSION_DATA_USERNAME</h3>
 746 <pre class="programlisting">#define SIGNON_SESSION_DATA_USERNAME      "UserName"
 747 </pre>
 748 <p>Username.</p>
 749 </div>
 750 <hr>
 751 <div class="refsect2">
 752 <a name="SIGNON-SESSION-DATA-WINDOW-ID:CAPS"></a><h3>SIGNON_SESSION_DATA_WINDOW_ID</h3>
 753 <pre class="programlisting">#define SIGNON_SESSION_DATA_WINDOW_ID     "WindowId"
 754 </pre>
 755 <p>Platform-specific window id (for dialog transiency) - uint32.</p>
 756 </div>
 757 <hr>
 758 <div class="refsect2">
 759 <a name="SignonAuthSession-struct"></a><h3>struct SignonAuthSession</h3>
 760 <pre class="programlisting">struct SignonAuthSession;</pre>
 761 <p>Opaque struct. Use the accessor functions below.</p>
 762 </div>
 763 <hr>
 764 <div class="refsect2">
 765 <a name="SignonAuthSessionClass"></a><h3>struct SignonAuthSessionClass</h3>
 766 <pre class="programlisting">struct SignonAuthSessionClass {
 767     GObjectClass parent;
 768 };
 769 </pre>
 770 <p>Opaque struct. Use the accessor functions below.</p>
 771 <div class="refsect3">
 772 <a name="id-1.3.3.6.10.12.5"></a><h4>Members</h4>
 773 <div class="informaltable"><table width="100%" border="0">
 774 <colgroup>
 775 <col width="300px" class="struct_members_name">
 776 <col class="struct_members_description">
 777 <col width="200px" class="struct_members_annotations">
 778 </colgroup>
 779 <tbody><tr>
 780 <td class="struct_member_name"><p><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SignonAuthSessionClass.parent"></a>parent</code></em>;</p></td>
 781 <td class="struct_member_description"><p>reference to the parent class</p></td>
 782 <td class="struct_member_annotations"> </td>
 783 </tr></tbody>
 784 </table></div>
 785 </div>
 786 </div>
 787 <hr>
 788 <div class="refsect2">
 789 <a name="SignonSessionDataUiPolicy"></a><h3>enum SignonSessionDataUiPolicy</h3>
 790 <p>UI policy for the signon process, passed to the UI plugin.</p>
 791 <div class="refsect3">
 792 <a name="id-1.3.3.6.10.13.4"></a><h4>Members</h4>
 793 <div class="informaltable"><table width="100%" border="0">
 794 <colgroup>
 795 <col width="300px" class="enum_members_name">
 796 <col class="enum_members_description">
 797 <col width="200px" class="enum_members_annotations">
 798 </colgroup>
 799 <tbody>
 800 <tr>
 801 <td class="enum_member_name"><p><a name="SIGNON-POLICY-DEFAULT:CAPS"></a>SIGNON_POLICY_DEFAULT</p></td>
 802 <td class="enum_member_description">
 803 <p>The plugin can decide when to show UI.</p>
 804 </td>
 805 <td class="enum_member_annotations"> </td>
 806 </tr>
 807 <tr>
 808 <td class="enum_member_name"><p><a name="SIGNON-POLICY-REQUEST-PASSWORD:CAPS"></a>SIGNON_POLICY_REQUEST_PASSWORD</p></td>
 809 <td class="enum_member_description">
 810 <p>Force the user to enter the password.</p>
 811 </td>
 812 <td class="enum_member_annotations"> </td>
 813 </tr>
 814 <tr>
 815 <td class="enum_member_name"><p><a name="SIGNON-POLICY-NO-USER-INTERACTION:CAPS"></a>SIGNON_POLICY_NO_USER_INTERACTION</p></td>
 816 <td class="enum_member_description">
 817 <p>No UI elements will be shown to the user.</p>
 818 </td>
 819 <td class="enum_member_annotations"> </td>
 820 </tr>
 821 <tr>
 822 <td class="enum_member_name"><p><a name="SIGNON-POLICY-VALIDATION:CAPS"></a>SIGNON_POLICY_VALIDATION</p></td>
 823 <td class="enum_member_description">
 824 <p>UI elements can be shown to the user only when
 825 CAPTCHA-like security measures are required.</p>
 826 </td>
 827 <td class="enum_member_annotations"> </td>
 828 </tr>
 829 </tbody>
 830 </table></div>
 831 </div>
 832 </div>
 833 </div>
 834 <div class="refsect1">
 835 <a name="SignonAuthSession.property-details"></a><h2>Property Details</h2>
 836 <div class="refsect2">
 837 <a name="SignonAuthSession--identity"></a><h3>The <code class="literal">“identity”</code> property</h3>
 838 <pre class="programlisting">  “identity”                 <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> *</pre>
 839 <p>Identity Object construct parameter.</p>
 840 <p>Flags: Read / Write / Construct Only</p>
 841 </div>
 842 </div>
 843 <div class="refsect1">
 844 <a name="SignonAuthSession.signal-details"></a><h2>Signal Details</h2>
 845 <div class="refsect2">
 846 <a name="SignonAuthSession-state-changed"></a><h3>The <code class="literal">“state-changed”</code> signal</h3>
 847 <pre class="programlisting"><span class="returnvalue">void</span>
 848 user_function (<a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> *auth_session,
 849                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>               state,
 850                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>             *message,
 851                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)</pre>
 852 <p>Emitted when the state of the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a> changes. The state change
 853 is initiated by <a href="../gsignond/GSignondPlugin.html"><span class="type">GSignondPlugin</span></a> via <a href="../gsignond/GSignondPlugin.html#GSignondPlugin-status-changed"><span class="type">“status-changed”</span></a> signal.</p>
 854 <div class="refsect3">
 855 <a name="id-1.3.3.6.12.2.5"></a><h4>Parameters</h4>
 856 <div class="informaltable"><table width="100%" border="0">
 857 <colgroup>
 858 <col width="150px" class="parameters_name">
 859 <col class="parameters_description">
 860 <col width="200px" class="parameters_annotations">
 861 </colgroup>
 862 <tbody>
 863 <tr>
 864 <td class="parameter_name"><p>auth_session</p></td>
 865 <td class="parameter_description"><p>the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a></p></td>
 866 <td class="parameter_annotations"> </td>
 867 </tr>
 868 <tr>
 869 <td class="parameter_name"><p>state</p></td>
 870 <td class="parameter_description"><p>the current state of the <a class="link" href="SignonAuthSession.html" title="SignonAuthSession"><span class="type">SignonAuthSession</span></a></p></td>
 871 <td class="parameter_annotations"> </td>
 872 </tr>
 873 <tr>
 874 <td class="parameter_name"><p>message</p></td>
 875 <td class="parameter_description"><p>the message associated with the state change</p></td>
 876 <td class="parameter_annotations"> </td>
 877 </tr>
 878 <tr>
 879 <td class="parameter_name"><p>user_data</p></td>
 880 <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 881 <td class="parameter_annotations"> </td>
 882 </tr>
 883 </tbody>
 884 </table></div>
 885 </div>
 886 <p>Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
 887 </div>
 888 </div>
 889 </div>
 890 <div class="footer">
 891 <hr>
 892           Generated by GTK-Doc V1.20</div>
 893 </body>
 894 </html>