docs/reference/html/SignonAuthService.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: SignonAuthService</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="credential-management.html" title="Credential management">
  10 <link rel="next" href="SignonIdentity.html" title="SignonIdentity">
  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="#SignonAuthService.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#SignonAuthService.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="credential-management.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="credential-management.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="SignonIdentity.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="SignonAuthService"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="SignonAuthService.top_of_page"></a>SignonAuthService</span></h2>
  31 <p>SignonAuthService — the authorization service object</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="SignonAuthService.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <span class="returnvalue">void</span>
  46 </td>
  47 <td class="function_name">
  48 <span class="c_punctuation">(</span><a class="link" href="SignonAuthService.html#SignonQueryMethodsCb" title="SignonQueryMethodsCb ()">*SignonQueryMethodsCb</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <span class="returnvalue">void</span>
  54 </td>
  55 <td class="function_name">
  56 <span class="c_punctuation">(</span><a class="link" href="SignonAuthService.html#SignonQueryMechanismCb" title="SignonQueryMechanismCb ()">*SignonQueryMechanismCb</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <span class="c_punctuation">(</span><a class="link" href="SignonAuthService.html#SignonQueryIdentitiesCb" title="SignonQueryIdentitiesCb ()">*SignonQueryIdentitiesCb</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="returnvalue">SignonAuthService</span></a> *
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="SignonAuthService.html#signon-auth-service-new" title="signon_auth_service_new ()">signon_auth_service_new</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <span class="returnvalue">void</span>
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="SignonAuthService.html#signon-auth-service-query-methods" title="signon_auth_service_query_methods ()">signon_auth_service_query_methods</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">
  85 <span class="returnvalue">void</span>
  86 </td>
  87 <td class="function_name">
  88 <a class="link" href="SignonAuthService.html#signon-auth-service-query-mechanisms" title="signon_auth_service_query_mechanisms ()">signon_auth_service_query_mechanisms</a> <span class="c_punctuation">()</span>
  89 </td>
  90 </tr>
  91 <tr>
  92 <td class="function_type">
  93 <span class="returnvalue">void</span>
  94 </td>
  95 <td class="function_name">
  96 <a class="link" href="SignonAuthService.html#signon-auth-service-query-identities" title="signon_auth_service_query_identities ()">signon_auth_service_query_identities</a> <span class="c_punctuation">()</span>
  97 </td>
  98 </tr>
  99 </tbody>
 100 </table></div>
 101 </div>
 102 <div class="refsect1">
 103 <a name="SignonAuthService.other"></a><h2>Types and Values</h2>
 104 <div class="informaltable"><table width="100%" border="0">
 105 <colgroup>
 106 <col width="150px" class="name">
 107 <col class="description">
 108 </colgroup>
 109 <tbody>
 110 <tr>
 111 <td class="datatype_keyword">struct</td>
 112 <td class="function_name"><a class="link" href="SignonAuthService.html#SignonAuthServiceClass" title="struct SignonAuthServiceClass">SignonAuthServiceClass</a></td>
 113 </tr>
 114 <tr>
 115 <td class="datatype_keyword">struct</td>
 116 <td class="function_name"><a class="link" href="SignonAuthService.html#SignonAuthService-struct" title="struct SignonAuthService">SignonAuthService</a></td>
 117 </tr>
 118 <tr>
 119 <td class="typedef_keyword">typedef</td>
 120 <td class="function_name"><a class="link" href="SignonAuthService.html#SignonIdentityList" title="SignonIdentityList">SignonIdentityList</a></td>
 121 </tr>
 122 <tr>
 123 <td class="typedef_keyword">typedef</td>
 124 <td class="function_name"><a class="link" href="SignonAuthService.html#SignonIdentityFilter" title="SignonIdentityFilter">SignonIdentityFilter</a></td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 </div>
 129 <div class="refsect1">
 130 <a name="SignonAuthService.object-hierarchy"></a><h2>Object Hierarchy</h2>
 131 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 132     <span class="lineart">╰──</span> SignonAuthService
 133 </pre>
 134 </div>
 135 <div class="refsect1">
 136 <a name="SignonAuthService.description"></a><h2>Description</h2>
 137 <p>The <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> is the main object in this library. It provides top-level
 138 functions to query existing identities, available methods and their mechanisms.</p>
 139 </div>
 140 <div class="refsect1">
 141 <a name="SignonAuthService.functions_details"></a><h2>Functions</h2>
 142 <div class="refsect2">
 143 <a name="SignonQueryMethodsCb"></a><h3>SignonQueryMethodsCb ()</h3>
 144 <pre class="programlisting"><span class="returnvalue">void</span>
 145 <span class="c_punctuation">(</span>*SignonQueryMethodsCb<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> *auth_service</code></em>,
 146                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **methods</code></em>,
 147                          <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>,
 148                          <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>
 149 <p>Callback to be passed to <a class="link" href="SignonAuthService.html#signon-auth-service-query-methods" title="signon_auth_service_query_methods ()"><code class="function">signon_auth_service_query_methods()</code></a>.</p>
 150 <div class="refsect3">
 151 <a name="id-1.3.3.2.7.2.5"></a><h4>Parameters</h4>
 152 <div class="informaltable"><table width="100%" border="0">
 153 <colgroup>
 154 <col width="150px" class="parameters_name">
 155 <col class="parameters_description">
 156 <col width="200px" class="parameters_annotations">
 157 </colgroup>
 158 <tbody>
 159 <tr>
 160 <td class="parameter_name"><p>auth_service</p></td>
 161 <td class="parameter_description"><p>the <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p></td>
 162 <td class="parameter_annotations"> </td>
 163 </tr>
 164 <tr>
 165 <td class="parameter_name"><p>methods</p></td>
 166 <td class="parameter_description"><p> list of available methods. </p></td>
 167 <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>
 168 </tr>
 169 <tr>
 170 <td class="parameter_name"><p>error</p></td>
 171 <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>
 172 <td class="parameter_annotations"> </td>
 173 </tr>
 174 <tr>
 175 <td class="parameter_name"><p>user_data</p></td>
 176 <td class="parameter_description"><p>the user data that was passed when installing this callback.</p></td>
 177 <td class="parameter_annotations"> </td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 </div>
 183 <hr>
 184 <div class="refsect2">
 185 <a name="SignonQueryMechanismCb"></a><h3>SignonQueryMechanismCb ()</h3>
 186 <pre class="programlisting"><span class="returnvalue">void</span>
 187 <span class="c_punctuation">(</span>*SignonQueryMechanismCb<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> *auth_service</code></em>,
 188                            <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</code></em>,
 189                            <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>,
 190                            <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>,
 191                            <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>
 192 <p>Callback to be passed to <a class="link" href="SignonAuthService.html#signon-auth-service-query-mechanisms" title="signon_auth_service_query_mechanisms ()"><code class="function">signon_auth_service_query_mechanisms()</code></a>.</p>
 193 <div class="refsect3">
 194 <a name="id-1.3.3.2.7.3.5"></a><h4>Parameters</h4>
 195 <div class="informaltable"><table width="100%" border="0">
 196 <colgroup>
 197 <col width="150px" class="parameters_name">
 198 <col class="parameters_description">
 199 <col width="200px" class="parameters_annotations">
 200 </colgroup>
 201 <tbody>
 202 <tr>
 203 <td class="parameter_name"><p>auth_service</p></td>
 204 <td class="parameter_description"><p>the <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p></td>
 205 <td class="parameter_annotations"> </td>
 206 </tr>
 207 <tr>
 208 <td class="parameter_name"><p>method</p></td>
 209 <td class="parameter_description"><p>the authentication method being inspected.</p></td>
 210 <td class="parameter_annotations"> </td>
 211 </tr>
 212 <tr>
 213 <td class="parameter_name"><p>mechanisms</p></td>
 214 <td class="parameter_description"><p> list of available mechanisms. </p></td>
 215 <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>
 216 </tr>
 217 <tr>
 218 <td class="parameter_name"><p>error</p></td>
 219 <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>
 220 <td class="parameter_annotations"> </td>
 221 </tr>
 222 <tr>
 223 <td class="parameter_name"><p>user_data</p></td>
 224 <td class="parameter_description"><p>the user data that was passed when installing this callback.</p></td>
 225 <td class="parameter_annotations"> </td>
 226 </tr>
 227 </tbody>
 228 </table></div>
 229 </div>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="SignonQueryIdentitiesCb"></a><h3>SignonQueryIdentitiesCb ()</h3>
 234 <pre class="programlisting"><span class="returnvalue">void</span>
 235 <span class="c_punctuation">(</span>*SignonQueryIdentitiesCb<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> *auth_service</code></em>,
 236                             <em class="parameter"><code><a class="link" href="SignonAuthService.html#SignonIdentityList" title="SignonIdentityList"><span class="type">SignonIdentityList</span></a> *identities</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 <p>Callback to be passed to <a class="link" href="SignonAuthService.html#signon-auth-service-query-identities" title="signon_auth_service_query_identities ()"><code class="function">signon_auth_service_query_identities()</code></a>.</p>
 240 <div class="refsect3">
 241 <a name="id-1.3.3.2.7.4.5"></a><h4>Parameters</h4>
 242 <div class="informaltable"><table width="100%" border="0">
 243 <colgroup>
 244 <col width="150px" class="parameters_name">
 245 <col class="parameters_description">
 246 <col width="200px" class="parameters_annotations">
 247 </colgroup>
 248 <tbody>
 249 <tr>
 250 <td class="parameter_name"><p>auth_service</p></td>
 251 <td class="parameter_description"><p>the <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p></td>
 252 <td class="parameter_annotations"> </td>
 253 </tr>
 254 <tr>
 255 <td class="parameter_name"><p>identities</p></td>
 256 <td class="parameter_description"><p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> based list of <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>. </p></td>
 257 <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>
 258 </tr>
 259 <tr>
 260 <td class="parameter_name"><p>error</p></td>
 261 <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>
 262 <td class="parameter_annotations"> </td>
 263 </tr>
 264 <tr>
 265 <td class="parameter_name"><p>user_data</p></td>
 266 <td class="parameter_description"><p>the user data that was passed when installing this callback.</p></td>
 267 <td class="parameter_annotations"> </td>
 268 </tr>
 269 </tbody>
 270 </table></div>
 271 </div>
 272 </div>
 273 <hr>
 274 <div class="refsect2">
 275 <a name="signon-auth-service-new"></a><h3>signon_auth_service_new ()</h3>
 276 <pre class="programlisting"><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="returnvalue">SignonAuthService</span></a> *
 277 signon_auth_service_new ();</pre>
 278 <p>Create a new <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p>
 279 <div class="refsect3">
 280 <a name="id-1.3.3.2.7.5.5"></a><h4>Returns</h4>
 281 <p> an instance of an <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p>
 282 <p></p>
 283 </div>
 284 </div>
 285 <hr>
 286 <div class="refsect2">
 287 <a name="signon-auth-service-query-methods"></a><h3>signon_auth_service_query_methods ()</h3>
 288 <pre class="programlisting"><span class="returnvalue">void</span>
 289 signon_auth_service_query_methods (<em class="parameter"><code><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> *auth_service</code></em>,
 290                                    <em class="parameter"><code><a class="link" href="SignonAuthService.html#SignonQueryMethodsCb" title="SignonQueryMethodsCb ()"><span class="type">SignonQueryMethodsCb</span></a> cb</code></em>,
 291                                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 292 <p>Lists all the available authentication methods.</p>
 293 <div class="refsect3">
 294 <a name="id-1.3.3.2.7.6.5"></a><h4>Parameters</h4>
 295 <div class="informaltable"><table width="100%" border="0">
 296 <colgroup>
 297 <col width="150px" class="parameters_name">
 298 <col class="parameters_description">
 299 <col width="200px" class="parameters_annotations">
 300 </colgroup>
 301 <tbody>
 302 <tr>
 303 <td class="parameter_name"><p>auth_service</p></td>
 304 <td class="parameter_description"><p>the <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p></td>
 305 <td class="parameter_annotations"> </td>
 306 </tr>
 307 <tr>
 308 <td class="parameter_name"><p>cb</p></td>
 309 <td class="parameter_description"><p> callback to be invoked. </p></td>
 310 <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>
 311 </tr>
 312 <tr>
 313 <td class="parameter_name"><p>user_data</p></td>
 314 <td class="parameter_description"><p>user data.</p></td>
 315 <td class="parameter_annotations"> </td>
 316 </tr>
 317 </tbody>
 318 </table></div>
 319 </div>
 320 </div>
 321 <hr>
 322 <div class="refsect2">
 323 <a name="signon-auth-service-query-mechanisms"></a><h3>signon_auth_service_query_mechanisms ()</h3>
 324 <pre class="programlisting"><span class="returnvalue">void</span>
 325 signon_auth_service_query_mechanisms (<em class="parameter"><code><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> *auth_service</code></em>,
 326                                       <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</code></em>,
 327                                       <em class="parameter"><code><a class="link" href="SignonAuthService.html#SignonQueryMechanismCb" title="SignonQueryMechanismCb ()"><span class="type">SignonQueryMechanismCb</span></a> cb</code></em>,
 328                                       <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>
 329 <p>Lists all the available mechanisms for an authentication method.</p>
 330 <div class="refsect3">
 331 <a name="id-1.3.3.2.7.7.5"></a><h4>Parameters</h4>
 332 <div class="informaltable"><table width="100%" border="0">
 333 <colgroup>
 334 <col width="150px" class="parameters_name">
 335 <col class="parameters_description">
 336 <col width="200px" class="parameters_annotations">
 337 </colgroup>
 338 <tbody>
 339 <tr>
 340 <td class="parameter_name"><p>auth_service</p></td>
 341 <td class="parameter_description"><p>the <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p></td>
 342 <td class="parameter_annotations"> </td>
 343 </tr>
 344 <tr>
 345 <td class="parameter_name"><p>method</p></td>
 346 <td class="parameter_description"><p>the name of the method whose mechanisms must be
 347 retrieved.</p></td>
 348 <td class="parameter_annotations"> </td>
 349 </tr>
 350 <tr>
 351 <td class="parameter_name"><p>cb</p></td>
 352 <td class="parameter_description"><p> callback to be invoked. </p></td>
 353 <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>
 354 </tr>
 355 <tr>
 356 <td class="parameter_name"><p>user_data</p></td>
 357 <td class="parameter_description"><p>user data.</p></td>
 358 <td class="parameter_annotations"> </td>
 359 </tr>
 360 </tbody>
 361 </table></div>
 362 </div>
 363 </div>
 364 <hr>
 365 <div class="refsect2">
 366 <a name="signon-auth-service-query-identities"></a><h3>signon_auth_service_query_identities ()</h3>
 367 <pre class="programlisting"><span class="returnvalue">void</span>
 368 signon_auth_service_query_identities (<em class="parameter"><code><a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a> *auth_service</code></em>,
 369                                       <em class="parameter"><code><a class="link" href="SignonAuthService.html#SignonIdentityFilter" title="SignonIdentityFilter"><span class="type">SignonIdentityFilter</span></a> *filter</code></em>,
 370                                       <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> *application_context</code></em>,
 371                                       <em class="parameter"><code><a class="link" href="SignonAuthService.html#SignonQueryIdentitiesCb" title="SignonQueryIdentitiesCb ()"><span class="type">SignonQueryIdentitiesCb</span></a> cb</code></em>,
 372                                       <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>
 373 <p>Query available identities, possibly applying a filter. </p>
 374 <p><em class="parameter"><code>filter</code></em>
 375  is a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> that contains filter conditions in the form of
 376 string keys and <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> values. Currently the following keys are supported:</p>
 377 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 378 <li class="listitem"><p>"Owner". The value should be a <a class="link" href="SignonSecurityContext.html" title="SignonSecurityContext"><span class="type">SignonSecurityContext</span></a> (use
 379 <a class="link" href="SignonSecurityContext.html#signon-security-context-build-variant" title="signon_security_context_build_variant ()"><code class="function">signon_security_context_build_variant()</code></a> to create a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>).
 380 Identites whose owner doesn't match will be filtered out. This key has
 381 effect only if the requesting application is a keychain application as determined
 382 by <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/GSignondAccessControlManager.html"><span class="type">GSignondAccessControlManager</span></a>.</p></li>
 383 <li class="listitem"><p>"Type". The value should be a <a class="link" href="SignonIdentityInfo.html#SignonIdentityType" title="enum SignonIdentityType"><span class="type">SignonIdentityType</span></a>.</p></li>
 384 <li class="listitem"><p>"Caption". The value is a string, and only those identites whose caption
 385 begins with the supplied value will be returned.</p></li>
 386 </ul></div>
 387 <p>The meaning of <em class="parameter"><code>application_context</code></em>
 388  is explained in <a class="link" href="SignonSecurityContext.html" title="SignonSecurityContext"><span class="type">SignonSecurityContext</span></a>.
 389 It is used by <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/GSignondAccessControlManager.html"><span class="type">GSignondAccessControlManager</span></a> to determine if the requesting
 390 application is a keychain application. If it is, then all identites will be
 391 returned (subject to "Owner" key in <em class="parameter"><code>filter</code></em>
 392 ). If it's not, then only the
 393 identites which the application owns will be returned (but "Type" and "Caption"
 394 can still be set in the <em class="parameter"><code>filter</code></em>
 395 ).</p>
 396 <div class="refsect3">
 397 <a name="id-1.3.3.2.7.8.8"></a><h4>Parameters</h4>
 398 <div class="informaltable"><table width="100%" border="0">
 399 <colgroup>
 400 <col width="150px" class="parameters_name">
 401 <col class="parameters_description">
 402 <col width="200px" class="parameters_annotations">
 403 </colgroup>
 404 <tbody>
 405 <tr>
 406 <td class="parameter_name"><p>auth_service</p></td>
 407 <td class="parameter_description"><p>the <a class="link" href="SignonAuthService.html" title="SignonAuthService"><span class="type">SignonAuthService</span></a>.</p></td>
 408 <td class="parameter_annotations"> </td>
 409 </tr>
 410 <tr>
 411 <td class="parameter_name"><p>filter</p></td>
 412 <td class="parameter_description"><p>filter variant dictionary based on <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>.</p></td>
 413 <td class="parameter_annotations"> </td>
 414 </tr>
 415 <tr>
 416 <td class="parameter_name"><p>application_context</p></td>
 417 <td class="parameter_description"><p>application security context, can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 418 <td class="parameter_annotations"> </td>
 419 </tr>
 420 <tr>
 421 <td class="parameter_name"><p>cb</p></td>
 422 <td class="parameter_description"><p> callback to be invoked. </p></td>
 423 <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>
 424 </tr>
 425 <tr>
 426 <td class="parameter_name"><p>user_data</p></td>
 427 <td class="parameter_description"><p>user data.</p></td>
 428 <td class="parameter_annotations"> </td>
 429 </tr>
 430 </tbody>
 431 </table></div>
 432 </div>
 433 </div>
 434 </div>
 435 <div class="refsect1">
 436 <a name="SignonAuthService.other_details"></a><h2>Types and Values</h2>
 437 <div class="refsect2">
 438 <a name="SignonAuthServiceClass"></a><h3>struct SignonAuthServiceClass</h3>
 439 <pre class="programlisting">struct SignonAuthServiceClass {
 440     GObjectClass parent_class;
 441 };
 442 </pre>
 443 <p>Opaque struct. Use the accessor functions below.</p>
 444 <div class="refsect3">
 445 <a name="id-1.3.3.2.8.2.5"></a><h4>Members</h4>
 446 <div class="informaltable"><table width="100%" border="0">
 447 <colgroup>
 448 <col width="300px" class="struct_members_name">
 449 <col class="struct_members_description">
 450 <col width="200px" class="struct_members_annotations">
 451 </colgroup>
 452 <tbody><tr>
 453 <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="SignonAuthServiceClass.parent-class"></a>parent_class</code></em>;</p></td>
 454 <td class="struct_member_description"><p>a reference to the parent class</p></td>
 455 <td class="struct_member_annotations"> </td>
 456 </tr></tbody>
 457 </table></div>
 458 </div>
 459 </div>
 460 <hr>
 461 <div class="refsect2">
 462 <a name="SignonAuthService-struct"></a><h3>struct SignonAuthService</h3>
 463 <pre class="programlisting">struct SignonAuthService;</pre>
 464 <p>Opaque struct. Use the accessor functions below.</p>
 465 </div>
 466 <hr>
 467 <div class="refsect2">
 468 <a name="SignonIdentityList"></a><h3>SignonIdentityList</h3>
 469 <pre class="programlisting">typedef GList SignonIdentityList;
 470 </pre>
 471 <p>GList of <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a> items.</p>
 472 </div>
 473 <hr>
 474 <div class="refsect2">
 475 <a name="SignonIdentityFilter"></a><h3>SignonIdentityFilter</h3>
 476 <pre class="programlisting">typedef GHashTable SignonIdentityFilter;
 477 </pre>
 478 <p><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> based filter variant dictionary.</p>
 479 </div>
 480 </div>
 481 </div>
 482 <div class="footer">
 483 <hr>
 484           Generated by GTK-Doc V1.20</div>
 485 </body>
 486 </html>