Update to upstream 1.0.1
[profile/ivi/gsignond.git] / 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>gsignond API Reference Manual: GSignondSessionData</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
8 <link rel="up" href="ch04.html" title="GSignond API for writing GLib-based 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.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="#gsignond-GSignondSessionData.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19                   <a href="#gsignond-GSignondSessionData.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="ch04.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 class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsect1">
36 <a name="gsignond-GSignondSessionData.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">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-username" title="gsignond_session_data_get_username ()">gsignond_session_data_get_username</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">void</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-username" title="gsignond_session_data_set_username ()">gsignond_session_data_set_username</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <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> *
60 </td>
61 <td class="function_name">
62 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-secret" title="gsignond_session_data_get_secret ()">gsignond_session_data_get_secret</a> <span class="c_punctuation">()</span>
63 </td>
64 </tr>
65 <tr>
66 <td class="function_type">
67 <span class="returnvalue">void</span>
68 </td>
69 <td class="function_name">
70 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-secret" title="gsignond_session_data_set_secret ()">gsignond_session_data_set_secret</a> <span class="c_punctuation">()</span>
71 </td>
72 </tr>
73 <tr>
74 <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> *
75 </td>
76 <td class="function_name">
77 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-realm" title="gsignond_session_data_get_realm ()">gsignond_session_data_get_realm</a> <span class="c_punctuation">()</span>
78 </td>
79 </tr>
80 <tr>
81 <td class="function_type">
82 <span class="returnvalue">void</span>
83 </td>
84 <td class="function_name">
85 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-realm" title="gsignond_session_data_set_realm ()">gsignond_session_data_set_realm</a> <span class="c_punctuation">()</span>
86 </td>
87 </tr>
88 <tr>
89 <td class="function_type">
90 <a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
91 </td>
92 <td class="function_name">
93 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-allowed-realms" title="gsignond_session_data_get_allowed_realms ()">gsignond_session_data_get_allowed_realms</a> <span class="c_punctuation">()</span>
94 </td>
95 </tr>
96 <tr>
97 <td class="function_type">
98 <span class="returnvalue">void</span>
99 </td>
100 <td class="function_name">
101 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-allowed-realms" title="gsignond_session_data_set_allowed_realms ()">gsignond_session_data_set_allowed_realms</a> <span class="c_punctuation">()</span>
102 </td>
103 </tr>
104 <tr>
105 <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> *
106 </td>
107 <td class="function_name">
108 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-get-caption" title="gsignond_session_data_get_caption ()">gsignond_session_data_get_caption</a> <span class="c_punctuation">()</span>
109 </td>
110 </tr>
111 <tr>
112 <td class="function_type">
113 <span class="returnvalue">void</span>
114 </td>
115 <td class="function_name">
116 <a class="link" href="gsignond-GSignondSessionData.html#gsignond-session-data-set-caption" title="gsignond_session_data_set_caption ()">gsignond_session_data_set_caption</a> <span class="c_punctuation">()</span>
117 </td>
118 </tr>
119 <tr>
120 <td class="function_type">
121 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
122 </td>
123 <td class="function_name">
124 <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> <span class="c_punctuation">()</span>
125 </td>
126 </tr>
127 <tr>
128 <td class="function_type">
129 <span class="returnvalue">void</span>
130 </td>
131 <td class="function_name">
132 <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> <span class="c_punctuation">()</span>
133 </td>
134 </tr>
135 <tr>
136 <td class="function_type">
137 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
138 </td>
139 <td class="function_name">
140 <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> <span class="c_punctuation">()</span>
141 </td>
142 </tr>
143 <tr>
144 <td class="function_type">
145 <span class="returnvalue">void</span>
146 </td>
147 <td class="function_name">
148 <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> <span class="c_punctuation">()</span>
149 </td>
150 </tr>
151 <tr>
152 <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> *
153 </td>
154 <td class="function_name">
155 <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> <span class="c_punctuation">()</span>
156 </td>
157 </tr>
158 <tr>
159 <td class="function_type">
160 <span class="returnvalue">void</span>
161 </td>
162 <td class="function_name">
163 <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> <span class="c_punctuation">()</span>
164 </td>
165 </tr>
166 <tr>
167 <td class="function_type">
168 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
169 </td>
170 <td class="function_name">
171 <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> <span class="c_punctuation">()</span>
172 </td>
173 </tr>
174 <tr>
175 <td class="function_type">
176 <span class="returnvalue">void</span>
177 </td>
178 <td class="function_name">
179 <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> <span class="c_punctuation">()</span>
180 </td>
181 </tr>
182 <tr>
183 <td class="function_type">
184 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
185 </td>
186 <td class="function_name">
187 <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> <span class="c_punctuation">()</span>
188 </td>
189 </tr>
190 <tr>
191 <td class="function_type">
192 <span class="returnvalue">void</span>
193 </td>
194 <td class="function_name">
195 <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> <span class="c_punctuation">()</span>
196 </td>
197 </tr>
198 </tbody>
199 </table></div>
200 </div>
201 <div class="refsect1">
202 <a name="gsignond-GSignondSessionData.other"></a><h2>Types and Values</h2>
203 <div class="informaltable"><table width="100%" border="0">
204 <colgroup>
205 <col width="150px" class="name">
206 <col class="description">
207 </colgroup>
208 <tbody><tr>
209 <td class="datatype_keyword">enum</td>
210 <td class="function_name"><a class="link" href="gsignond-GSignondSessionData.html#GSignondUiPolicy" title="enum GSignondUiPolicy">GSignondUiPolicy</a></td>
211 </tr></tbody>
212 </table></div>
213 </div>
214 <div class="refsect1">
215 <a name="gsignond-GSignondSessionData.object-hierarchy"></a><h2>Object Hierarchy</h2>
216 <pre class="screen">
217 </pre>
218 </div>
219 <div class="refsect1">
220 <a name="gsignond-GSignondSessionData.includes"></a><h2>Includes</h2>
221 <pre class="synopsis">#include &lt;gsignond/gsignond-session-data.h&gt;
222 </pre>
223 </div>
224 <div class="refsect1">
225 <a name="gsignond-GSignondSessionData.description"></a><h2>Description</h2>
226 <p>This file provides commonly used parameters for authentication sessions.
227 For each of those a getter and setter is defined, on <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a>
228 container. The plugins may not use all of these parameters, and they commonly
229 require additional, custom parameters which are set using <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a>
230 setters with explicit key string.</p>
231 </div>
232 <div class="refsect1">
233 <a name="gsignond-GSignondSessionData.functions_details"></a><h2>Functions</h2>
234 <div class="refsect2">
235 <a name="gsignond-session-data-get-username"></a><h3>gsignond_session_data_get_username ()</h3>
236 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
237 gsignond_session_data_get_username (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
238 <p>A getter for a username associated with the authentication session.</p>
239 <div class="refsect3">
240 <a name="id-1.5.4.8.2.5"></a><h4>Parameters</h4>
241 <div class="informaltable"><table width="100%" border="0">
242 <colgroup>
243 <col width="150px" class="parameters_name">
244 <col class="parameters_description">
245 <col width="200px" class="parameters_annotations">
246 </colgroup>
247 <tbody><tr>
248 <td class="parameter_name"><p>data</p></td>
249 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
250 <td class="parameter_annotations"> </td>
251 </tr></tbody>
252 </table></div>
253 </div>
254 <div class="refsect3">
255 <a name="id-1.5.4.8.2.6"></a><h4>Returns</h4>
256 <p> (transfer none)</p>
257 <p></p>
258 </div>
259 </div>
260 <hr>
261 <div class="refsect2">
262 <a name="gsignond-session-data-set-username"></a><h3>gsignond_session_data_set_username ()</h3>
263 <pre class="programlisting"><span class="returnvalue">void</span>
264 gsignond_session_data_set_username (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
265                                     <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>
266 <p>A setter for a username associated with the authentication session.</p>
267 <div class="refsect3">
268 <a name="id-1.5.4.8.3.5"></a><h4>Parameters</h4>
269 <div class="informaltable"><table width="100%" border="0">
270 <colgroup>
271 <col width="150px" class="parameters_name">
272 <col class="parameters_description">
273 <col width="200px" class="parameters_annotations">
274 </colgroup>
275 <tbody>
276 <tr>
277 <td class="parameter_name"><p>data</p></td>
278 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
279 <td class="parameter_annotations"> </td>
280 </tr>
281 <tr>
282 <td class="parameter_name"><p>username</p></td>
283 <td class="parameter_description"><p>username to set</p></td>
284 <td class="parameter_annotations"> </td>
285 </tr>
286 </tbody>
287 </table></div>
288 </div>
289 </div>
290 <hr>
291 <div class="refsect2">
292 <a name="gsignond-session-data-get-secret"></a><h3>gsignond_session_data_get_secret ()</h3>
293 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
294 gsignond_session_data_get_secret (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
295 <p>A getter for a secret (e.g. a password) associated with the authentication session.</p>
296 <div class="refsect3">
297 <a name="id-1.5.4.8.4.5"></a><h4>Parameters</h4>
298 <div class="informaltable"><table width="100%" border="0">
299 <colgroup>
300 <col width="150px" class="parameters_name">
301 <col class="parameters_description">
302 <col width="200px" class="parameters_annotations">
303 </colgroup>
304 <tbody><tr>
305 <td class="parameter_name"><p>data</p></td>
306 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
307 <td class="parameter_annotations"> </td>
308 </tr></tbody>
309 </table></div>
310 </div>
311 <div class="refsect3">
312 <a name="id-1.5.4.8.4.6"></a><h4>Returns</h4>
313 <p> (transfer none)</p>
314 <p></p>
315 </div>
316 </div>
317 <hr>
318 <div class="refsect2">
319 <a name="gsignond-session-data-set-secret"></a><h3>gsignond_session_data_set_secret ()</h3>
320 <pre class="programlisting"><span class="returnvalue">void</span>
321 gsignond_session_data_set_secret (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
322                                   <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>
323 <p>A setter for a secret (e.g. a password) associated with the authentication session.</p>
324 <div class="refsect3">
325 <a name="id-1.5.4.8.5.5"></a><h4>Parameters</h4>
326 <div class="informaltable"><table width="100%" border="0">
327 <colgroup>
328 <col width="150px" class="parameters_name">
329 <col class="parameters_description">
330 <col width="200px" class="parameters_annotations">
331 </colgroup>
332 <tbody>
333 <tr>
334 <td class="parameter_name"><p>data</p></td>
335 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
336 <td class="parameter_annotations"> </td>
337 </tr>
338 <tr>
339 <td class="parameter_name"><p>secret</p></td>
340 <td class="parameter_description"><p>a secret to set</p></td>
341 <td class="parameter_annotations"> </td>
342 </tr>
343 </tbody>
344 </table></div>
345 </div>
346 </div>
347 <hr>
348 <div class="refsect2">
349 <a name="gsignond-session-data-get-realm"></a><h3>gsignond_session_data_get_realm ()</h3>
350 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
351 gsignond_session_data_get_realm (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
352 <p>A getter for a realm associated with the authentication session.</p>
353 <div class="refsect3">
354 <a name="id-1.5.4.8.6.5"></a><h4>Parameters</h4>
355 <div class="informaltable"><table width="100%" border="0">
356 <colgroup>
357 <col width="150px" class="parameters_name">
358 <col class="parameters_description">
359 <col width="200px" class="parameters_annotations">
360 </colgroup>
361 <tbody><tr>
362 <td class="parameter_name"><p>data</p></td>
363 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
364 <td class="parameter_annotations"> </td>
365 </tr></tbody>
366 </table></div>
367 </div>
368 <div class="refsect3">
369 <a name="id-1.5.4.8.6.6"></a><h4>Returns</h4>
370 <p> (transfer none)</p>
371 <p></p>
372 </div>
373 </div>
374 <hr>
375 <div class="refsect2">
376 <a name="gsignond-session-data-set-realm"></a><h3>gsignond_session_data_set_realm ()</h3>
377 <pre class="programlisting"><span class="returnvalue">void</span>
378 gsignond_session_data_set_realm (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
379                                  <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>
380 <p>A setter for a realm associated with the authentication session.</p>
381 <div class="refsect3">
382 <a name="id-1.5.4.8.7.5"></a><h4>Parameters</h4>
383 <div class="informaltable"><table width="100%" border="0">
384 <colgroup>
385 <col width="150px" class="parameters_name">
386 <col class="parameters_description">
387 <col width="200px" class="parameters_annotations">
388 </colgroup>
389 <tbody>
390 <tr>
391 <td class="parameter_name"><p>data</p></td>
392 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
393 <td class="parameter_annotations"> </td>
394 </tr>
395 <tr>
396 <td class="parameter_name"><p>realm</p></td>
397 <td class="parameter_description"><p>a realm to set</p></td>
398 <td class="parameter_annotations"> </td>
399 </tr>
400 </tbody>
401 </table></div>
402 </div>
403 </div>
404 <hr>
405 <div class="refsect2">
406 <a name="gsignond-session-data-get-allowed-realms"></a><h3>gsignond_session_data_get_allowed_realms ()</h3>
407 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
408 gsignond_session_data_get_allowed_realms
409                                (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
410 <p>A getter for a list of realms allowed for the identity use.</p>
411 <div class="refsect3">
412 <a name="id-1.5.4.8.8.5"></a><h4>Parameters</h4>
413 <div class="informaltable"><table width="100%" border="0">
414 <colgroup>
415 <col width="150px" class="parameters_name">
416 <col class="parameters_description">
417 <col width="200px" class="parameters_annotations">
418 </colgroup>
419 <tbody><tr>
420 <td class="parameter_name"><p>data</p></td>
421 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
422 <td class="parameter_annotations"> </td>
423 </tr></tbody>
424 </table></div>
425 </div>
426 <div class="refsect3">
427 <a name="id-1.5.4.8.8.6"></a><h4>Returns</h4>
428 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> of allowed realms. </p>
429 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
430 </div>
431 </div>
432 <hr>
433 <div class="refsect2">
434 <a name="gsignond-session-data-set-allowed-realms"></a><h3>gsignond_session_data_set_allowed_realms ()</h3>
435 <pre class="programlisting"><span class="returnvalue">void</span>
436 gsignond_session_data_set_allowed_realms
437                                (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
438                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> *realms</code></em>);</pre>
439 <p>A setter for a list of realms allowed for the identity use.</p>
440 <div class="refsect3">
441 <a name="id-1.5.4.8.9.5"></a><h4>Parameters</h4>
442 <div class="informaltable"><table width="100%" border="0">
443 <colgroup>
444 <col width="150px" class="parameters_name">
445 <col class="parameters_description">
446 <col width="200px" class="parameters_annotations">
447 </colgroup>
448 <tbody>
449 <tr>
450 <td class="parameter_name"><p>data</p></td>
451 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
452 <td class="parameter_annotations"> </td>
453 </tr>
454 <tr>
455 <td class="parameter_name"><p>realms</p></td>
456 <td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> if allowed realms</p></td>
457 <td class="parameter_annotations"> </td>
458 </tr>
459 </tbody>
460 </table></div>
461 </div>
462 </div>
463 <hr>
464 <div class="refsect2">
465 <a name="gsignond-session-data-get-caption"></a><h3>gsignond_session_data_get_caption ()</h3>
466 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
467 gsignond_session_data_get_caption (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
468 <p>A getter for a caption associated with the authentication session.
469 Caption tells the user which application/credentials/provider is requestion
470 authentication.</p>
471 <div class="refsect3">
472 <a name="id-1.5.4.8.10.5"></a><h4>Parameters</h4>
473 <div class="informaltable"><table width="100%" border="0">
474 <colgroup>
475 <col width="150px" class="parameters_name">
476 <col class="parameters_description">
477 <col width="200px" class="parameters_annotations">
478 </colgroup>
479 <tbody><tr>
480 <td class="parameter_name"><p>data</p></td>
481 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
482 <td class="parameter_annotations"> </td>
483 </tr></tbody>
484 </table></div>
485 </div>
486 <div class="refsect3">
487 <a name="id-1.5.4.8.10.6"></a><h4>Returns</h4>
488 <p> (transfer none)</p>
489 <p></p>
490 </div>
491 </div>
492 <hr>
493 <div class="refsect2">
494 <a name="gsignond-session-data-set-caption"></a><h3>gsignond_session_data_set_caption ()</h3>
495 <pre class="programlisting"><span class="returnvalue">void</span>
496 gsignond_session_data_set_caption (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
497                                    <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>
498 <p>A setter for a caption associated with the authentication session.
499 Caption tells the user which application/credentials/provider is requestion
500 authentication.</p>
501 <div class="refsect3">
502 <a name="id-1.5.4.8.11.5"></a><h4>Parameters</h4>
503 <div class="informaltable"><table width="100%" border="0">
504 <colgroup>
505 <col width="150px" class="parameters_name">
506 <col class="parameters_description">
507 <col width="200px" class="parameters_annotations">
508 </colgroup>
509 <tbody>
510 <tr>
511 <td class="parameter_name"><p>data</p></td>
512 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
513 <td class="parameter_annotations"> </td>
514 </tr>
515 <tr>
516 <td class="parameter_name"><p>caption</p></td>
517 <td class="parameter_description"><p>a caption to set</p></td>
518 <td class="parameter_annotations"> </td>
519 </tr>
520 </tbody>
521 </table></div>
522 </div>
523 </div>
524 <hr>
525 <div class="refsect2">
526 <a name="gsignond-session-data-get-renew-token"></a><h3>gsignond_session_data_get_renew_token ()</h3>
527 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
528 gsignond_session_data_get_renew_token (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
529                                        <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>
530 <p>A getter for a renew token property associated with the authentication session.
531 This property tells the plugin to discard any cached tokens and start 
532 the authentication process anew.</p>
533 <div class="refsect3">
534 <a name="id-1.5.4.8.12.5"></a><h4>Parameters</h4>
535 <div class="informaltable"><table width="100%" border="0">
536 <colgroup>
537 <col width="150px" class="parameters_name">
538 <col class="parameters_description">
539 <col width="200px" class="parameters_annotations">
540 </colgroup>
541 <tbody>
542 <tr>
543 <td class="parameter_name"><p>data</p></td>
544 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
545 <td class="parameter_annotations"> </td>
546 </tr>
547 <tr>
548 <td class="parameter_name"><p>renew_token</p></td>
549 <td class="parameter_description"><p>the value for the parameter is written here</p></td>
550 <td class="parameter_annotations"> </td>
551 </tr>
552 </tbody>
553 </table></div>
554 </div>
555 <div class="refsect3">
556 <a name="id-1.5.4.8.12.6"></a><h4>Returns</h4>
557 <p> whether the key-value pair exists in the <em class="parameter"><code>data</code></em>
558 dictionary or not.</p>
559 <p></p>
560 </div>
561 </div>
562 <hr>
563 <div class="refsect2">
564 <a name="gsignond-session-data-set-renew-token"></a><h3>gsignond_session_data_set_renew_token ()</h3>
565 <pre class="programlisting"><span class="returnvalue">void</span>
566 gsignond_session_data_set_renew_token (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
567                                        <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>
568 <p>A setter for a renew token property associated with the authentication session.
569 This property tells the plugin to discard any cached tokens and start 
570 the authentication process anew.</p>
571 <div class="refsect3">
572 <a name="id-1.5.4.8.13.5"></a><h4>Parameters</h4>
573 <div class="informaltable"><table width="100%" border="0">
574 <colgroup>
575 <col width="150px" class="parameters_name">
576 <col class="parameters_description">
577 <col width="200px" class="parameters_annotations">
578 </colgroup>
579 <tbody>
580 <tr>
581 <td class="parameter_name"><p>data</p></td>
582 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
583 <td class="parameter_annotations"> </td>
584 </tr>
585 <tr>
586 <td class="parameter_name"><p>renew_token</p></td>
587 <td class="parameter_description"><p>whether to renew the token set</p></td>
588 <td class="parameter_annotations"> </td>
589 </tr>
590 </tbody>
591 </table></div>
592 </div>
593 </div>
594 <hr>
595 <div class="refsect2">
596 <a name="gsignond-session-data-get-ui-policy"></a><h3>gsignond_session_data_get_ui_policy ()</h3>
597 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
598 gsignond_session_data_get_ui_policy (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
599                                      <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>
600 <p>A getter for UI policy setting associated with the authentication session.
601 The UI policy indicates how the authentication plugin should interact with the user.</p>
602 <div class="refsect3">
603 <a name="id-1.5.4.8.14.5"></a><h4>Parameters</h4>
604 <div class="informaltable"><table width="100%" border="0">
605 <colgroup>
606 <col width="150px" class="parameters_name">
607 <col class="parameters_description">
608 <col width="200px" class="parameters_annotations">
609 </colgroup>
610 <tbody>
611 <tr>
612 <td class="parameter_name"><p>data</p></td>
613 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
614 <td class="parameter_annotations"> </td>
615 </tr>
616 <tr>
617 <td class="parameter_name"><p>ui_policy</p></td>
618 <td class="parameter_description"><p>the value for the parameter is written here</p></td>
619 <td class="parameter_annotations"> </td>
620 </tr>
621 </tbody>
622 </table></div>
623 </div>
624 <div class="refsect3">
625 <a name="id-1.5.4.8.14.6"></a><h4>Returns</h4>
626 <p> whether the key-value pair exists in the <em class="parameter"><code>data</code></em>
627 dictionary or not.</p>
628 <p></p>
629 </div>
630 </div>
631 <hr>
632 <div class="refsect2">
633 <a name="gsignond-session-data-set-ui-policy"></a><h3>gsignond_session_data_set_ui_policy ()</h3>
634 <pre class="programlisting"><span class="returnvalue">void</span>
635 gsignond_session_data_set_ui_policy (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
636                                      <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>
637 <p>A getter for UI policy setting associated with the authentication session.
638 The UI policy indicates how the authentication plugin should interact with the user.</p>
639 <div class="refsect3">
640 <a name="id-1.5.4.8.15.5"></a><h4>Parameters</h4>
641 <div class="informaltable"><table width="100%" border="0">
642 <colgroup>
643 <col width="150px" class="parameters_name">
644 <col class="parameters_description">
645 <col width="200px" class="parameters_annotations">
646 </colgroup>
647 <tbody>
648 <tr>
649 <td class="parameter_name"><p>data</p></td>
650 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
651 <td class="parameter_annotations"> </td>
652 </tr>
653 <tr>
654 <td class="parameter_name"><p>ui_policy</p></td>
655 <td class="parameter_description"><p>ui policy to set</p></td>
656 <td class="parameter_annotations"> </td>
657 </tr>
658 </tbody>
659 </table></div>
660 </div>
661 </div>
662 <hr>
663 <div class="refsect2">
664 <a name="gsignond-session-data-get-network-proxy"></a><h3>gsignond_session_data_get_network_proxy ()</h3>
665 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
666 gsignond_session_data_get_network_proxy
667                                (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>);</pre>
668 <p>A getter for a network proxy setting associated with the authentication session.
669 If this property is not set, the default system proxy settings should be used.</p>
670 <div class="refsect3">
671 <a name="id-1.5.4.8.16.5"></a><h4>Parameters</h4>
672 <div class="informaltable"><table width="100%" border="0">
673 <colgroup>
674 <col width="150px" class="parameters_name">
675 <col class="parameters_description">
676 <col width="200px" class="parameters_annotations">
677 </colgroup>
678 <tbody><tr>
679 <td class="parameter_name"><p>data</p></td>
680 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
681 <td class="parameter_annotations"> </td>
682 </tr></tbody>
683 </table></div>
684 </div>
685 <div class="refsect3">
686 <a name="id-1.5.4.8.16.6"></a><h4>Returns</h4>
687 <p> (transfer none)</p>
688 <p></p>
689 </div>
690 </div>
691 <hr>
692 <div class="refsect2">
693 <a name="gsignond-session-data-set-network-proxy"></a><h3>gsignond_session_data_set_network_proxy ()</h3>
694 <pre class="programlisting"><span class="returnvalue">void</span>
695 gsignond_session_data_set_network_proxy
696                                (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
697                                 <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>
698 <p>A setter for a network proxy setting associated with the authentication session.
699 If this property is not set, the default system proxy settings should be used.</p>
700 <div class="refsect3">
701 <a name="id-1.5.4.8.17.5"></a><h4>Parameters</h4>
702 <div class="informaltable"><table width="100%" border="0">
703 <colgroup>
704 <col width="150px" class="parameters_name">
705 <col class="parameters_description">
706 <col width="200px" class="parameters_annotations">
707 </colgroup>
708 <tbody>
709 <tr>
710 <td class="parameter_name"><p>data</p></td>
711 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
712 <td class="parameter_annotations"> </td>
713 </tr>
714 <tr>
715 <td class="parameter_name"><p>network_proxy</p></td>
716 <td class="parameter_description"><p>network proxy to use</p></td>
717 <td class="parameter_annotations"> </td>
718 </tr>
719 </tbody>
720 </table></div>
721 </div>
722 </div>
723 <hr>
724 <div class="refsect2">
725 <a name="gsignond-session-data-get-network-timeout"></a><h3>gsignond_session_data_get_network_timeout ()</h3>
726 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
727 gsignond_session_data_get_network_timeout
728                                (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
729                                 <em class="parameter"><code><span class="type">guint32</span> *network_timeout</code></em>);</pre>
730 <p>A getter for a network timeout setting associated with the authentication session.
731 This can be used to change the default timeout in case of unresponsive servers.</p>
732 <div class="refsect3">
733 <a name="id-1.5.4.8.18.5"></a><h4>Parameters</h4>
734 <div class="informaltable"><table width="100%" border="0">
735 <colgroup>
736 <col width="150px" class="parameters_name">
737 <col class="parameters_description">
738 <col width="200px" class="parameters_annotations">
739 </colgroup>
740 <tbody>
741 <tr>
742 <td class="parameter_name"><p>data</p></td>
743 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
744 <td class="parameter_annotations"> </td>
745 </tr>
746 <tr>
747 <td class="parameter_name"><p>network_timeout</p></td>
748 <td class="parameter_description"><p>the value for the parameter is written here</p></td>
749 <td class="parameter_annotations"> </td>
750 </tr>
751 </tbody>
752 </table></div>
753 </div>
754 <div class="refsect3">
755 <a name="id-1.5.4.8.18.6"></a><h4>Returns</h4>
756 <p> whether the key-value pair exists in the <em class="parameter"><code>data</code></em>
757 dictionary or not.</p>
758 <p></p>
759 </div>
760 </div>
761 <hr>
762 <div class="refsect2">
763 <a name="gsignond-session-data-set-network-timeout"></a><h3>gsignond_session_data_set_network_timeout ()</h3>
764 <pre class="programlisting"><span class="returnvalue">void</span>
765 gsignond_session_data_set_network_timeout
766                                (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
767                                 <em class="parameter"><code><span class="type">guint32</span> network_timeout</code></em>);</pre>
768 <p>A setter for a network timeout setting associated with the authentication session.
769 This can be used to change the default timeout in case of unresponsive servers.</p>
770 <div class="refsect3">
771 <a name="id-1.5.4.8.19.5"></a><h4>Parameters</h4>
772 <div class="informaltable"><table width="100%" border="0">
773 <colgroup>
774 <col width="150px" class="parameters_name">
775 <col class="parameters_description">
776 <col width="200px" class="parameters_annotations">
777 </colgroup>
778 <tbody>
779 <tr>
780 <td class="parameter_name"><p>data</p></td>
781 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
782 <td class="parameter_annotations"> </td>
783 </tr>
784 <tr>
785 <td class="parameter_name"><p>network_timeout</p></td>
786 <td class="parameter_description"><p>network timeout to use</p></td>
787 <td class="parameter_annotations"> </td>
788 </tr>
789 </tbody>
790 </table></div>
791 </div>
792 </div>
793 <hr>
794 <div class="refsect2">
795 <a name="gsignond-session-data-get-window-id"></a><h3>gsignond_session_data_get_window_id ()</h3>
796 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
797 gsignond_session_data_get_window_id (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
798                                      <em class="parameter"><code><span class="type">guint32</span> *window_id</code></em>);</pre>
799 <p>A getter for a window id setting associated with the authentication session.
800 This can be used to embed the user interaction window produced by the authentication
801 session into an application window.</p>
802 <div class="refsect3">
803 <a name="id-1.5.4.8.20.5"></a><h4>Parameters</h4>
804 <div class="informaltable"><table width="100%" border="0">
805 <colgroup>
806 <col width="150px" class="parameters_name">
807 <col class="parameters_description">
808 <col width="200px" class="parameters_annotations">
809 </colgroup>
810 <tbody>
811 <tr>
812 <td class="parameter_name"><p>data</p></td>
813 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
814 <td class="parameter_annotations"> </td>
815 </tr>
816 <tr>
817 <td class="parameter_name"><p>window_id</p></td>
818 <td class="parameter_description"><p>the value for the parameter is written here</p></td>
819 <td class="parameter_annotations"> </td>
820 </tr>
821 </tbody>
822 </table></div>
823 </div>
824 <div class="refsect3">
825 <a name="id-1.5.4.8.20.6"></a><h4>Returns</h4>
826 <p> whether the key-value pair exists in the <em class="parameter"><code>data</code></em>
827 dictionary or not.</p>
828 <p></p>
829 </div>
830 </div>
831 <hr>
832 <div class="refsect2">
833 <a name="gsignond-session-data-set-window-id"></a><h3>gsignond_session_data_set_window_id ()</h3>
834 <pre class="programlisting"><span class="returnvalue">void</span>
835 gsignond_session_data_set_window_id (<em class="parameter"><code><a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondSessionData.html#GSignondSessionData"><span class="type">GSignondSessionData</span></a> *data</code></em>,
836                                      <em class="parameter"><code><span class="type">guint32</span> window_id</code></em>);</pre>
837 <p>A setter for a window id setting associated with the authentication session.
838 This can be used to embed the user interaction window produced by the authentication
839 session into an application window.</p>
840 <div class="refsect3">
841 <a name="id-1.5.4.8.21.5"></a><h4>Parameters</h4>
842 <div class="informaltable"><table width="100%" border="0">
843 <colgroup>
844 <col width="150px" class="parameters_name">
845 <col class="parameters_description">
846 <col width="200px" class="parameters_annotations">
847 </colgroup>
848 <tbody>
849 <tr>
850 <td class="parameter_name"><p>data</p></td>
851 <td class="parameter_description"><p>a <a href="http://gsignon-docs.accounts-sso.googlecode.com/git/gsignond/gsignond-GSignondDictionary.html#GSignondDictionary"><span class="type">GSignondDictionary</span></a> structure</p></td>
852 <td class="parameter_annotations"> </td>
853 </tr>
854 <tr>
855 <td class="parameter_name"><p>window_id</p></td>
856 <td class="parameter_description"><p>window id to use</p></td>
857 <td class="parameter_annotations"> </td>
858 </tr>
859 </tbody>
860 </table></div>
861 </div>
862 </div>
863 </div>
864 <div class="refsect1">
865 <a name="gsignond-GSignondSessionData.other_details"></a><h2>Types and Values</h2>
866 <div class="refsect2">
867 <a name="GSignondUiPolicy"></a><h3>enum GSignondUiPolicy</h3>
868 <p>Policy setting to define how plugins should handle interaction with the user.</p>
869 <div class="refsect3">
870 <a name="id-1.5.4.9.2.4"></a><h4>Members</h4>
871 <div class="informaltable"><table width="100%" border="0">
872 <colgroup>
873 <col width="300px" class="enum_members_name">
874 <col class="enum_members_description">
875 <col width="200px" class="enum_members_annotations">
876 </colgroup>
877 <tbody>
878 <tr>
879 <td class="enum_member_name"><p><a name="GSIGNOND-UI-POLICY-DEFAULT:CAPS"></a>GSIGNOND_UI_POLICY_DEFAULT</p></td>
880 <td class="enum_member_description">
881 <p>use a default user interaction scenario</p>
882 </td>
883 <td class="enum_member_annotations"> </td>
884 </tr>
885 <tr>
886 <td class="enum_member_name"><p><a name="GSIGNOND-UI-POLICY-REQUEST-PASSWORD:CAPS"></a>GSIGNOND_UI_POLICY_REQUEST_PASSWORD</p></td>
887 <td class="enum_member_description">
888 <p>force an authorization request from the user;
889 any cached access tokens should be discarded by the plugin.</p>
890 </td>
891 <td class="enum_member_annotations"> </td>
892 </tr>
893 <tr>
894 <td class="enum_member_name"><p><a name="GSIGNOND-UI-POLICY-NO-USER-INTERACTION:CAPS"></a>GSIGNOND_UI_POLICY_NO_USER_INTERACTION</p></td>
895 <td class="enum_member_description">
896 <p>force no interaction with the user</p>
897 </td>
898 <td class="enum_member_annotations"> </td>
899 </tr>
900 <tr>
901 <td class="enum_member_name"><p><a name="GSIGNOND-UI-POLICY-VALIDATION:CAPS"></a>GSIGNOND_UI_POLICY_VALIDATION</p></td>
902 <td class="enum_member_description">
903 <p>interaction with the user is only allowed
904 for validation captchas and similar security measures</p>
905 </td>
906 <td class="enum_member_annotations"> </td>
907 </tr>
908 </tbody>
909 </table></div>
910 </div>
911 </div>
912 </div>
913 </div>
914 <div class="footer">
915 <hr>
916           Generated by GTK-Doc V1.20</div>
917 </body>
918 </html>