1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gsignond API Reference Manual: GSignondCredentials</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="ch06.html" title="GSignond API for writing platform adaptation extensions">
9 <link rel="prev" href="GSignondSecretStorage.html" title="GSignondSecretStorage">
10 <link rel="next" href="ch07.html" title="Miscellaneous">
11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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="#GSignondCredentials.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19 <a href="#GSignondCredentials.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="GSignondSecretStorage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="ch07.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 <div class="refentry">
27 <a name="GSignondCredentials"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
30 <h2><span class="refentrytitle"><a name="GSignondCredentials.top_of_page"></a>GSignondCredentials</span></h2>
31 <p>GSignondCredentials — credentials (username, password) associated with an identity</p>
33 <td class="gallery_image" valign="top" align="right"></td>
35 <div class="refsect1">
36 <a name="GSignondCredentials.functions"></a><h2>Functions</h2>
37 <div class="informaltable"><table width="100%" border="0">
39 <col width="150px" class="functions_return">
40 <col class="functions_name">
44 <td class="function_type">
45 <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> *
47 <td class="function_name">
48 <a class="link" href="GSignondCredentials.html#gsignond-credentials-new" title="gsignond_credentials_new ()">gsignond_credentials_new</a> <span class="c_punctuation">()</span>
52 <td class="function_type">
53 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
55 <td class="function_name">
56 <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-data" title="gsignond_credentials_set_data ()">gsignond_credentials_set_data</a> <span class="c_punctuation">()</span>
60 <td class="function_type">
61 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
63 <td class="function_name">
64 <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-id" title="gsignond_credentials_set_id ()">gsignond_credentials_set_id</a> <span class="c_punctuation">()</span>
68 <td class="function_type">
69 <span class="returnvalue">guint32</span>
71 <td class="function_name">
72 <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-id" title="gsignond_credentials_get_id ()">gsignond_credentials_get_id</a> <span class="c_punctuation">()</span>
76 <td class="function_type">
77 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
79 <td class="function_name">
80 <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-username" title="gsignond_credentials_set_username ()">gsignond_credentials_set_username</a> <span class="c_punctuation">()</span>
84 <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> *
86 <td class="function_name">
87 <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-username" title="gsignond_credentials_get_username ()">gsignond_credentials_get_username</a> <span class="c_punctuation">()</span>
91 <td class="function_type">
92 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
94 <td class="function_name">
95 <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-password" title="gsignond_credentials_set_password ()">gsignond_credentials_set_password</a> <span class="c_punctuation">()</span>
99 <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> *
101 <td class="function_name">
102 <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-password" title="gsignond_credentials_get_password ()">gsignond_credentials_get_password</a> <span class="c_punctuation">()</span>
106 <td class="function_type">
107 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
109 <td class="function_name">
110 <a class="link" href="GSignondCredentials.html#gsignond-credentials-equal" title="gsignond_credentials_equal ()">gsignond_credentials_equal</a> <span class="c_punctuation">()</span>
116 <div class="refsect1">
117 <a name="GSignondCredentials.object-hierarchy"></a><h2>Object Hierarchy</h2>
118 <pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
119 <span class="lineart">╰──</span> GSignondCredentials
122 <div class="refsect1">
123 <a name="GSignondCredentials.includes"></a><h2>Includes</h2>
124 <pre class="synopsis">#include <gsignond/gsignond-credentials.h>
127 <div class="refsect1">
128 <a name="GSignondCredentials.description"></a><h2>Description</h2>
129 <p><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> hold a username, password, and identity id, associated
130 with an identity. This information in stored in secret storage using
131 <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a>.</p>
133 <div class="refsect1">
134 <a name="GSignondCredentials.functions_details"></a><h2>Functions</h2>
135 <div class="refsect2">
136 <a name="gsignond-credentials-new"></a><h3>gsignond_credentials_new ()</h3>
137 <pre class="programlisting"><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> *
138 gsignond_credentials_new ();</pre>
139 <p>Creates a new empty <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object</p>
140 <div class="refsect3">
141 <a name="id-1.7.7.7.2.5"></a><h4>Returns</h4>
142 <p> the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object. </p>
143 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
147 <div class="refsect2">
148 <a name="gsignond-credentials-set-data"></a><h3>gsignond_credentials_set_data ()</h3>
149 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
150 gsignond_credentials_set_data (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>,
151 <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>,
152 <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>,
153 <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> *password</code></em>);</pre>
154 <p>Sets the data of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a>.</p>
155 <div class="refsect3">
156 <a name="id-1.7.7.7.3.5"></a><h4>Parameters</h4>
157 <div class="informaltable"><table width="100%" border="0">
159 <col width="150px" class="parameters_name">
160 <col class="parameters_description">
161 <col width="200px" class="parameters_annotations">
165 <td class="parameter_name"><p>self</p></td>
166 <td class="parameter_description"><p>the object whose data is to be set.</p></td>
167 <td class="parameter_annotations"> </td>
170 <td class="parameter_name"><p>id</p></td>
171 <td class="parameter_description"><p>the identity id associated with the credentials.</p></td>
172 <td class="parameter_annotations"> </td>
175 <td class="parameter_name"><p>username</p></td>
176 <td class="parameter_description"><p> the username. </p></td>
177 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
180 <td class="parameter_name"><p>password</p></td>
181 <td class="parameter_description"><p>the password. </p></td>
182 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
187 <div class="refsect3">
188 <a name="id-1.7.7.7.3.6"></a><h4>Returns</h4>
189 <p> TRUE if successful, FALSE otherwise.</p>
194 <div class="refsect2">
195 <a name="gsignond-credentials-set-id"></a><h3>gsignond_credentials_set_id ()</h3>
196 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
197 gsignond_credentials_set_id (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>,
198 <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre>
199 <p>Sets the identity id of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object</p>
200 <div class="refsect3">
201 <a name="id-1.7.7.7.4.5"></a><h4>Parameters</h4>
202 <div class="informaltable"><table width="100%" border="0">
204 <col width="150px" class="parameters_name">
205 <col class="parameters_description">
206 <col width="200px" class="parameters_annotations">
210 <td class="parameter_name"><p>self</p></td>
211 <td class="parameter_description"><p>the object whose id is to be set.</p></td>
212 <td class="parameter_annotations"> </td>
215 <td class="parameter_name"><p>id</p></td>
216 <td class="parameter_description"><p>the id.</p></td>
217 <td class="parameter_annotations"> </td>
222 <div class="refsect3">
223 <a name="id-1.7.7.7.4.6"></a><h4>Returns</h4>
224 <p> TRUE if successful, FALSE otherwise.</p>
229 <div class="refsect2">
230 <a name="gsignond-credentials-get-id"></a><h3>gsignond_credentials_get_id ()</h3>
231 <pre class="programlisting"><span class="returnvalue">guint32</span>
232 gsignond_credentials_get_id (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);</pre>
233 <p>Gets the identity id</p>
234 <div class="refsect3">
235 <a name="id-1.7.7.7.5.5"></a><h4>Parameters</h4>
236 <div class="informaltable"><table width="100%" border="0">
238 <col width="150px" class="parameters_name">
239 <col class="parameters_description">
240 <col width="200px" class="parameters_annotations">
243 <td class="parameter_name"><p>self</p></td>
244 <td class="parameter_description"><p>the object whose id is to be set.</p></td>
245 <td class="parameter_annotations"> </td>
249 <div class="refsect3">
250 <a name="id-1.7.7.7.5.6"></a><h4>Returns</h4>
256 <div class="refsect2">
257 <a name="gsignond-credentials-set-username"></a><h3>gsignond_credentials_set_username ()</h3>
258 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
259 gsignond_credentials_set_username (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>,
260 <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>
261 <p>Sets the username of the GSignondCredentials object</p>
262 <div class="refsect3">
263 <a name="id-1.7.7.7.6.5"></a><h4>Parameters</h4>
264 <div class="informaltable"><table width="100%" border="0">
266 <col width="150px" class="parameters_name">
267 <col class="parameters_description">
268 <col width="200px" class="parameters_annotations">
272 <td class="parameter_name"><p>self</p></td>
273 <td class="parameter_description"><p>the object whose username is to be set.</p></td>
274 <td class="parameter_annotations"> </td>
277 <td class="parameter_name"><p>username</p></td>
278 <td class="parameter_description"><p> the username. </p></td>
279 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
284 <div class="refsect3">
285 <a name="id-1.7.7.7.6.6"></a><h4>Returns</h4>
286 <p> TRUE if successful, FALSE otherwise.</p>
291 <div class="refsect2">
292 <a name="gsignond-credentials-get-username"></a><h3>gsignond_credentials_get_username ()</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_credentials_get_username (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);</pre>
295 <p>Gets the username of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object</p>
296 <div class="refsect3">
297 <a name="id-1.7.7.7.7.5"></a><h4>Parameters</h4>
298 <div class="informaltable"><table width="100%" border="0">
300 <col width="150px" class="parameters_name">
301 <col class="parameters_description">
302 <col width="200px" class="parameters_annotations">
305 <td class="parameter_name"><p>self</p></td>
306 <td class="parameter_description"><p>the object whose username is to be set.</p></td>
307 <td class="parameter_annotations"> </td>
311 <div class="refsect3">
312 <a name="id-1.7.7.7.7.6"></a><h4>Returns</h4>
313 <p> the username if the object is valid, NULL otherwise. </p>
314 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
318 <div class="refsect2">
319 <a name="gsignond-credentials-set-password"></a><h3>gsignond_credentials_set_password ()</h3>
320 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
321 gsignond_credentials_set_password (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</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> *password</code></em>);</pre>
323 <p>Sets the password of the GSignondCredentials object</p>
324 <div class="refsect3">
325 <a name="id-1.7.7.7.8.5"></a><h4>Parameters</h4>
326 <div class="informaltable"><table width="100%" border="0">
328 <col width="150px" class="parameters_name">
329 <col class="parameters_description">
330 <col width="200px" class="parameters_annotations">
334 <td class="parameter_name"><p>self</p></td>
335 <td class="parameter_description"><p>the object whose password is to be set.</p></td>
336 <td class="parameter_annotations"> </td>
339 <td class="parameter_name"><p>password</p></td>
340 <td class="parameter_description"><p> the password. </p></td>
341 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
346 <div class="refsect3">
347 <a name="id-1.7.7.7.8.6"></a><h4>Returns</h4>
348 <p> TRUE if successful, FALSE otherwise.</p>
353 <div class="refsect2">
354 <a name="gsignond-credentials-get-password"></a><h3>gsignond_credentials_get_password ()</h3>
355 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
356 gsignond_credentials_get_password (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);</pre>
357 <p>Gets the password from the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object</p>
358 <div class="refsect3">
359 <a name="id-1.7.7.7.9.5"></a><h4>Parameters</h4>
360 <div class="informaltable"><table width="100%" border="0">
362 <col width="150px" class="parameters_name">
363 <col class="parameters_description">
364 <col width="200px" class="parameters_annotations">
367 <td class="parameter_name"><p>self</p></td>
368 <td class="parameter_description"><p>the object whose password is to be set.</p></td>
369 <td class="parameter_annotations"> </td>
373 <div class="refsect3">
374 <a name="id-1.7.7.7.9.6"></a><h4>Returns</h4>
375 <p> the password if the object is valid, NULL otherwise. </p>
376 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
380 <div class="refsect2">
381 <a name="gsignond-credentials-equal"></a><h3>gsignond_credentials_equal ()</h3>
382 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
383 gsignond_credentials_equal (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *one</code></em>,
384 <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *two</code></em>);</pre>
385 <p>Compares elements of two GSignondCredentials object for equality.</p>
386 <div class="refsect3">
387 <a name="id-1.7.7.7.10.5"></a><h4>Parameters</h4>
388 <div class="informaltable"><table width="100%" border="0">
390 <col width="150px" class="parameters_name">
391 <col class="parameters_description">
392 <col width="200px" class="parameters_annotations">
396 <td class="parameter_name"><p>one</p></td>
397 <td class="parameter_description"><p>the first credential to be compared.</p></td>
398 <td class="parameter_annotations"> </td>
401 <td class="parameter_name"><p>two</p></td>
402 <td class="parameter_description"><p>the second credential to be compared.</p></td>
403 <td class="parameter_annotations"> </td>
408 <div class="refsect3">
409 <a name="id-1.7.7.7.10.6"></a><h4>Returns</h4>
410 <p> TRUE if id, username and password are same for both credential
411 objects, FALSE otherwise.</p>
416 <div class="refsect1">
417 <a name="GSignondCredentials.other_details"></a><h2>Types and Values</h2>
422 Generated by GTK-Doc V1.20</div>