docs/html/gsignond-GSignondSessionData.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>GSignondSessionData</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch03.html" title="GSignond API for writing authentication plugins">
   9 <link rel="prev" href="gsignond-GSignondDictionary.html" title="GSignondDictionary">
  10 <link rel="next" href="gsignond-GSignondSignonuiData.html" title="GSignondSignonuiData">
  11 <meta name="generator" content="GTK-Doc V1.19.1 (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">
  17 <a href="#" class="shortcut">Top</a>
  18                    |
  19                   <a href="#gsignond-GSignondSessionData.description" class="shortcut">Description</a>
  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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gsignond-GSignondDictionary.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gsignond-GSignondSignonuiData.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="gsignond-GSignondSessionData"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="gsignond-GSignondSessionData.top_of_page"></a>GSignondSessionData</span></h2>
  31 <p>GSignondSessionData — definitions for authentication session parameters</p>
  32 </td>
  33 <td valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsynopsisdiv">
  36 <a name="gsignond-GSignondSessionData.synopsis"></a><h2>Synopsis</h2>
  37 <pre class="synopsis">
  38 #include &lt;gsignond/gsignond-session-data.h&gt;
  39
  40 typedef             <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData">GSignondSessionData</a>;
  41 enum                <a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy">GSignondUiPolicy</a>;
  42 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-caption" title="gsignond_session_data_get_caption ()">gsignond_session_data_get_caption</a>   (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);
  43 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-proxy" title="gsignond_session_data_get_network_proxy ()">gsignond_session_data_get_network_proxy</a>
  44                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);
  45 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-network-timeout" title="gsignond_session_data_get_network_timeout ()">gsignond_session_data_get_network_timeout</a>
  46                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  47                                                          <em class="parameter"><code><span class="type">guint32</span> *network_timeout</code></em>);
  48 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-realm" title="gsignond_session_data_get_realm ()">gsignond_session_data_get_realm</a>     (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-renew-token" title="gsignond_session_data_get_renew_token ()">gsignond_session_data_get_renew_token</a>
  50                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  51                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *renew_token</code></em>);
  52 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-secret" title="gsignond_session_data_get_secret ()">gsignond_session_data_get_secret</a>    (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);
  53 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-ui-policy" title="gsignond_session_data_get_ui_policy ()">gsignond_session_data_get_ui_policy</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> *ui_policy</code></em>);
  55 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-username" title="gsignond_session_data_get_username ()">gsignond_session_data_get_username</a>  (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);
  56 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-window-id" title="gsignond_session_data_get_window_id ()">gsignond_session_data_get_window_id</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  57                                                          <em class="parameter"><code><span class="type">guint32</span> *window_id</code></em>);
  58 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-caption" title="gsignond_session_data_set_caption ()">gsignond_session_data_set_caption</a>   (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  59                                                          <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> *caption</code></em>);
  60 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-proxy" title="gsignond_session_data_set_network_proxy ()">gsignond_session_data_set_network_proxy</a>
  61                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  62                                                          <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> *network_proxy</code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-network-timeout" title="gsignond_session_data_set_network_timeout ()">gsignond_session_data_set_network_timeout</a>
  64                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  65                                                          <em class="parameter"><code><span class="type">guint32</span> network_timeout</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-realm" title="gsignond_session_data_set_realm ()">gsignond_session_data_set_realm</a>     (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  67                                                          <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> *realm</code></em>);
  68 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-renew-token" title="gsignond_session_data_set_renew_token ()">gsignond_session_data_set_renew_token</a>
  69                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  70                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> renew_token</code></em>);
  71 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-secret" title="gsignond_session_data_set_secret ()">gsignond_session_data_set_secret</a>    (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  72                                                          <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> *secret</code></em>);
  73 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-ui-policy" title="gsignond_session_data_set_ui_policy ()">gsignond_session_data_set_ui_policy</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  74                                                          <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> ui_policy</code></em>);
  75 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-username" title="gsignond_session_data_set_username ()">gsignond_session_data_set_username</a>  (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  76                                                          <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> *username</code></em>);
  77 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-window-id" title="gsignond_session_data_set_window_id ()">gsignond_session_data_set_window_id</a> (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
  78                                                          <em class="parameter"><code><span class="type">guint32</span> window_id</code></em>);
  79 </pre>
  80 </div>
  81 <div class="refsect1">
  82 <a name="gsignond-GSignondSessionData.description"></a><h2>Description</h2>
  83 <p>
  84 This file provides commonly used parameters for authentication sessions.
  85 For each of those a getter and setter is defined, on <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a>
  86 container. The plugins may not use all of these parameters, and they commonly
  87 require additional, custom parameters which are set using <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
  88 setters with explicit key string.
  89 </p>
  90 </div>
  91 <div class="refsect1">
  92 <a name="gsignond-GSignondSessionData.details"></a><h2>Details</h2>
  93 <div class="refsect2">
  94 <a name="GSignondSessionData"></a><h3>GSignondSessionData</h3>
  95 <pre class="programlisting">typedef GSignondDictionary GSignondSessionData;
  96 </pre>
  97 <p>
  98 <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> is simply a typedef for <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>, which
  99 means the developers may also freely use methods associated with that structure,
 100 in particular for creating a <a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> object with
 101 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()"><code class="function">gsignond_dictionary_new()</code></a>.
 102 </p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="GSignondUiPolicy"></a><h3>enum GSignondUiPolicy</h3>
 107 <pre class="programlisting">typedef enum {
 108     GSIGNOND_UI_POLICY_DEFAULT = 0,
 109     GSIGNOND_UI_POLICY_REQUEST_PASSWORD,
 110     GSIGNOND_UI_POLICY_NO_USER_INTERACTION,
 111     GSIGNOND_UI_POLICY_VALIDATION
 112 } GSignondUiPolicy;
 113 </pre>
 114 <p>
 115 Policy setting to define how plugins should handle interaction with the user.
 116 </p>
 117 <div class="variablelist"><table border="0">
 118 <col align="left" valign="top">
 119 <tbody>
 120 <tr>
 121 <td><p><a name="GSIGNOND-UI-POLICY-DEFAULT:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_DEFAULT</code></span></p></td>
 122 <td>use a default user interaction scenario
 123 </td>
 124 </tr>
 125 <tr>
 126 <td><p><a name="GSIGNOND-UI-POLICY-REQUEST-PASSWORD:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_REQUEST_PASSWORD</code></span></p></td>
 127 <td>force an authorization request from the user;
 128 any cached access tokens should be discarded by the plugin.
 129 </td>
 130 </tr>
 131 <tr>
 132 <td><p><a name="GSIGNOND-UI-POLICY-NO-USER-INTERACTION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_NO_USER_INTERACTION</code></span></p></td>
 133 <td>force no interaction with the user
 134 </td>
 135 </tr>
 136 <tr>
 137 <td><p><a name="GSIGNOND-UI-POLICY-VALIDATION:CAPS"></a><span class="term"><code class="literal">GSIGNOND_UI_POLICY_VALIDATION</code></span></p></td>
 138 <td>interaction with the user is only allowed
 139 for validation captchas and similar security measures
 140 </td>
 141 </tr>
 142 </tbody>
 143 </table></div>
 144 </div>
 145 <hr>
 146 <div class="refsect2">
 147 <a name="gsignond-session-data-get-caption"></a><h3>gsignond_session_data_get_caption ()</h3>
 148 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gsignond_session_data_get_caption   (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
 149 <p>
 150 A getter for a caption associated with the authentication session.
 151 Caption tells the user which application/credentials/provider is requestion
 152 authentication.
 153 </p>
 154 <div class="variablelist"><table border="0">
 155 <col align="left" valign="top">
 156 <tbody>
 157 <tr>
 158 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 159 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 163 <td>(transfer none)</td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="gsignond-session-data-get-network-proxy"></a><h3>gsignond_session_data_get_network_proxy ()</h3>
 171 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gsignond_session_data_get_network_proxy
 172                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
 173 <p>
 174 A getter for a network proxy setting associated with the authentication session.
 175 If this property is not set, the default system proxy settings should be used.
 176 </p>
 177 <div class="variablelist"><table border="0">
 178 <col align="left" valign="top">
 179 <tbody>
 180 <tr>
 181 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 182 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 186 <td>(transfer none)</td>
 187 </tr>
 188 </tbody>
 189 </table></div>
 190 </div>
 191 <hr>
 192 <div class="refsect2">
 193 <a name="gsignond-session-data-get-network-timeout"></a><h3>gsignond_session_data_get_network_timeout ()</h3>
 194 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_session_data_get_network_timeout
 195                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 196                                                          <em class="parameter"><code><span class="type">guint32</span> *network_timeout</code></em>);</pre>
 197 <p>
 198 A getter for a network timeout setting associated with the authentication session.
 199 This can be used to change the default timeout in case of unresponsive servers.
 200 </p>
 201 <div class="variablelist"><table border="0">
 202 <col align="left" valign="top">
 203 <tbody>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 206 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 207 </tr>
 208 <tr>
 209 <td><p><span class="term"><em class="parameter"><code>network_timeout</code></em> :</span></p></td>
 210 <td>the value for the parameter is written here</td>
 211 </tr>
 212 <tr>
 213 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 214 <td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td>
 215 </tr>
 216 </tbody>
 217 </table></div>
 218 </div>
 219 <hr>
 220 <div class="refsect2">
 221 <a name="gsignond-session-data-get-realm"></a><h3>gsignond_session_data_get_realm ()</h3>
 222 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gsignond_session_data_get_realm     (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
 223 <p>
 224 A getter for a realm associated with the authentication session.
 225 </p>
 226 <div class="variablelist"><table border="0">
 227 <col align="left" valign="top">
 228 <tbody>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 231 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 232 </tr>
 233 <tr>
 234 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 235 <td>(transfer none)</td>
 236 </tr>
 237 </tbody>
 238 </table></div>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="gsignond-session-data-get-renew-token"></a><h3>gsignond_session_data_get_renew_token ()</h3>
 243 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_session_data_get_renew_token
 244                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 245                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *renew_token</code></em>);</pre>
 246 <p>
 247 A getter for a renew token property associated with the authentication session.
 248 This property tells the plugin to discard any cached tokens and start
 249 the authentication process anew.
 250 </p>
 251 <div class="variablelist"><table border="0">
 252 <col align="left" valign="top">
 253 <tbody>
 254 <tr>
 255 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 256 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 257 </tr>
 258 <tr>
 259 <td><p><span class="term"><em class="parameter"><code>renew_token</code></em> :</span></p></td>
 260 <td>the value for the parameter is written here</td>
 261 </tr>
 262 <tr>
 263 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 264 <td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td>
 265 </tr>
 266 </tbody>
 267 </table></div>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="gsignond-session-data-get-secret"></a><h3>gsignond_session_data_get_secret ()</h3>
 272 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gsignond_session_data_get_secret    (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
 273 <p>
 274 A getter for a secret (e.g. a password) associated with the authentication session.
 275 </p>
 276 <div class="variablelist"><table border="0">
 277 <col align="left" valign="top">
 278 <tbody>
 279 <tr>
 280 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 281 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 282 </tr>
 283 <tr>
 284 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 285 <td>(transfer none)</td>
 286 </tr>
 287 </tbody>
 288 </table></div>
 289 </div>
 290 <hr>
 291 <div class="refsect2">
 292 <a name="gsignond-session-data-get-ui-policy"></a><h3>gsignond_session_data_get_ui_policy ()</h3>
 293 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_session_data_get_ui_policy (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 294                                                          <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> *ui_policy</code></em>);</pre>
 295 <p>
 296 A getter for UI policy setting associated with the authentication session.
 297 The UI policy indicates how the authentication plugin should interact with the user.
 298 </p>
 299 <div class="variablelist"><table border="0">
 300 <col align="left" valign="top">
 301 <tbody>
 302 <tr>
 303 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 304 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 305 </tr>
 306 <tr>
 307 <td><p><span class="term"><em class="parameter"><code>ui_policy</code></em> :</span></p></td>
 308 <td>the value for the parameter is written here</td>
 309 </tr>
 310 <tr>
 311 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 312 <td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td>
 313 </tr>
 314 </tbody>
 315 </table></div>
 316 </div>
 317 <hr>
 318 <div class="refsect2">
 319 <a name="gsignond-session-data-get-username"></a><h3>gsignond_session_data_get_username ()</h3>
 320 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gsignond_session_data_get_username  (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
 321 <p>
 322 A getter for a username associated with the authentication session.
 323 </p>
 324 <div class="variablelist"><table border="0">
 325 <col align="left" valign="top">
 326 <tbody>
 327 <tr>
 328 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 329 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 330 </tr>
 331 <tr>
 332 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 333 <td>(transfer none)</td>
 334 </tr>
 335 </tbody>
 336 </table></div>
 337 </div>
 338 <hr>
 339 <div class="refsect2">
 340 <a name="gsignond-session-data-get-window-id"></a><h3>gsignond_session_data_get_window_id ()</h3>
 341 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_session_data_get_window_id (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 342                                                          <em class="parameter"><code><span class="type">guint32</span> *window_id</code></em>);</pre>
 343 <p>
 344 A getter for a window id setting associated with the authentication session.
 345 This can be used to embed the user interaction window produced by the authentication
 346 session into an application window.
 347 </p>
 348 <div class="variablelist"><table border="0">
 349 <col align="left" valign="top">
 350 <tbody>
 351 <tr>
 352 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 353 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 354 </tr>
 355 <tr>
 356 <td><p><span class="term"><em class="parameter"><code>window_id</code></em> :</span></p></td>
 357 <td>the value for the parameter is written here</td>
 358 </tr>
 359 <tr>
 360 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 361 <td>whether the key-value pair exists in the <em class="parameter"><code>data</code></em> dictionary or not.</td>
 362 </tr>
 363 </tbody>
 364 </table></div>
 365 </div>
 366 <hr>
 367 <div class="refsect2">
 368 <a name="gsignond-session-data-set-caption"></a><h3>gsignond_session_data_set_caption ()</h3>
 369 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_caption   (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</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> *caption</code></em>);</pre>
 371 <p>
 372 A setter for a caption associated with the authentication session.
 373 Caption tells the user which application/credentials/provider is requestion
 374 authentication.
 375 </p>
 376 <div class="variablelist"><table border="0">
 377 <col align="left" valign="top">
 378 <tbody>
 379 <tr>
 380 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 381 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 382 </tr>
 383 <tr>
 384 <td><p><span class="term"><em class="parameter"><code>caption</code></em> :</span></p></td>
 385 <td>a caption to set</td>
 386 </tr>
 387 </tbody>
 388 </table></div>
 389 </div>
 390 <hr>
 391 <div class="refsect2">
 392 <a name="gsignond-session-data-set-network-proxy"></a><h3>gsignond_session_data_set_network_proxy ()</h3>
 393 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_network_proxy
 394                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 395                                                          <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> *network_proxy</code></em>);</pre>
 396 <p>
 397 A setter for a network proxy setting associated with the authentication session.
 398 If this property is not set, the default system proxy settings should be used.
 399 </p>
 400 <div class="variablelist"><table border="0">
 401 <col align="left" valign="top">
 402 <tbody>
 403 <tr>
 404 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 405 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 406 </tr>
 407 <tr>
 408 <td><p><span class="term"><em class="parameter"><code>network_proxy</code></em> :</span></p></td>
 409 <td>network proxy to use</td>
 410 </tr>
 411 </tbody>
 412 </table></div>
 413 </div>
 414 <hr>
 415 <div class="refsect2">
 416 <a name="gsignond-session-data-set-network-timeout"></a><h3>gsignond_session_data_set_network_timeout ()</h3>
 417 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_network_timeout
 418                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 419                                                          <em class="parameter"><code><span class="type">guint32</span> network_timeout</code></em>);</pre>
 420 <p>
 421 A setter for a network timeout setting associated with the authentication session.
 422 This can be used to change the default timeout in case of unresponsive servers.
 423 </p>
 424 <div class="variablelist"><table border="0">
 425 <col align="left" valign="top">
 426 <tbody>
 427 <tr>
 428 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 429 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 430 </tr>
 431 <tr>
 432 <td><p><span class="term"><em class="parameter"><code>network_timeout</code></em> :</span></p></td>
 433 <td>network timeout to use</td>
 434 </tr>
 435 </tbody>
 436 </table></div>
 437 </div>
 438 <hr>
 439 <div class="refsect2">
 440 <a name="gsignond-session-data-set-realm"></a><h3>gsignond_session_data_set_realm ()</h3>
 441 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_realm     (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 442                                                          <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> *realm</code></em>);</pre>
 443 <p>
 444 A setter for a realm associated with the authentication session.
 445 </p>
 446 <div class="variablelist"><table border="0">
 447 <col align="left" valign="top">
 448 <tbody>
 449 <tr>
 450 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 451 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 452 </tr>
 453 <tr>
 454 <td><p><span class="term"><em class="parameter"><code>realm</code></em> :</span></p></td>
 455 <td>a realm to set</td>
 456 </tr>
 457 </tbody>
 458 </table></div>
 459 </div>
 460 <hr>
 461 <div class="refsect2">
 462 <a name="gsignond-session-data-set-renew-token"></a><h3>gsignond_session_data_set_renew_token ()</h3>
 463 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_renew_token
 464                                                         (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 465                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> renew_token</code></em>);</pre>
 466 <p>
 467 A setter for a renew token property associated with the authentication session.
 468 This property tells the plugin to discard any cached tokens and start
 469 the authentication process anew.
 470 </p>
 471 <div class="variablelist"><table border="0">
 472 <col align="left" valign="top">
 473 <tbody>
 474 <tr>
 475 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 476 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 477 </tr>
 478 <tr>
 479 <td><p><span class="term"><em class="parameter"><code>renew_token</code></em> :</span></p></td>
 480 <td>whether to renew the token set</td>
 481 </tr>
 482 </tbody>
 483 </table></div>
 484 </div>
 485 <hr>
 486 <div class="refsect2">
 487 <a name="gsignond-session-data-set-secret"></a><h3>gsignond_session_data_set_secret ()</h3>
 488 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_secret    (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 489                                                          <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> *secret</code></em>);</pre>
 490 <p>
 491 A setter for a secret (e.g. a password) associated with the authentication session.
 492 </p>
 493 <div class="variablelist"><table border="0">
 494 <col align="left" valign="top">
 495 <tbody>
 496 <tr>
 497 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 498 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 499 </tr>
 500 <tr>
 501 <td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td>
 502 <td>a secret to set</td>
 503 </tr>
 504 </tbody>
 505 </table></div>
 506 </div>
 507 <hr>
 508 <div class="refsect2">
 509 <a name="gsignond-session-data-set-ui-policy"></a><h3>gsignond_session_data_set_ui_policy ()</h3>
 510 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_ui_policy (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 511                                                          <em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy"><span class="type">GSignondUiPolicy</span></a> ui_policy</code></em>);</pre>
 512 <p>
 513 A getter for UI policy setting associated with the authentication session.
 514 The UI policy indicates how the authentication plugin should interact with the user.
 515 </p>
 516 <div class="variablelist"><table border="0">
 517 <col align="left" valign="top">
 518 <tbody>
 519 <tr>
 520 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 521 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 522 </tr>
 523 <tr>
 524 <td><p><span class="term"><em class="parameter"><code>ui_policy</code></em> :</span></p></td>
 525 <td>ui policy to set</td>
 526 </tr>
 527 </tbody>
 528 </table></div>
 529 </div>
 530 <hr>
 531 <div class="refsect2">
 532 <a name="gsignond-session-data-set-username"></a><h3>gsignond_session_data_set_username ()</h3>
 533 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_username  (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 534                                                          <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> *username</code></em>);</pre>
 535 <p>
 536 A setter for a username associated with the authentication session.
 537 </p>
 538 <div class="variablelist"><table border="0">
 539 <col align="left" valign="top">
 540 <tbody>
 541 <tr>
 542 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 543 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 544 </tr>
 545 <tr>
 546 <td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
 547 <td>username to set</td>
 548 </tr>
 549 </tbody>
 550 </table></div>
 551 </div>
 552 <hr>
 553 <div class="refsect2">
 554 <a name="gsignond-session-data-set-window-id"></a><h3>gsignond_session_data_set_window_id ()</h3>
 555 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_session_data_set_window_id (<em class="parameter"><code><a class="link" href="gsignond-GSignondSessionData.html#GSignondSessionData" title="GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
 556                                                          <em class="parameter"><code><span class="type">guint32</span> window_id</code></em>);</pre>
 557 <p>
 558 A setter for a window id setting associated with the authentication session.
 559 This can be used to embed the user interaction window produced by the authentication
 560 session into an application window.
 561 </p>
 562 <div class="variablelist"><table border="0">
 563 <col align="left" valign="top">
 564 <tbody>
 565 <tr>
 566 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 567 <td>a <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</td>
 568 </tr>
 569 <tr>
 570 <td><p><span class="term"><em class="parameter"><code>window_id</code></em> :</span></p></td>
 571 <td>window id to use</td>
 572 </tr>
 573 </tbody>
 574 </table></div>
 575 </div>
 576 </div>
 577 </div>
 578 <div class="footer">
 579 <hr>
 580           Generated by GTK-Doc V1.19.1</div>
 581 </body>
 582 </html>