docs/html/GSignondCredentials.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>GSignondCredentials</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="ch05.html" title="GSignond API for writing platform adaptation extensions">
   9 <link rel="prev" href="GSignondSecretStorage.html" title="GSignondSecretStorage">
  10 <link rel="next" href="ch06.html" title="Miscellaneous">
  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="#GSignondCredentials.description" class="shortcut">Description</a>
  20                    |
  21                   <a href="#GSignondCredentials.object-hierarchy" class="shortcut">Object Hierarchy</a>
  22 </td>
  23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  24 <td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  25 <td><a accesskey="p" href="GSignondSecretStorage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  26 <td><a accesskey="n" href="ch06.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  27 </tr></table>
  28 <div class="refentry">
  29 <a name="GSignondCredentials"></a><div class="titlepage"></div>
  30 <div class="refnamediv"><table width="100%"><tr>
  31 <td valign="top">
  32 <h2><span class="refentrytitle"><a name="GSignondCredentials.top_of_page"></a>GSignondCredentials</span></h2>
  33 <p>GSignondCredentials — credentials (username, password) associated with an identity</p>
  34 </td>
  35 <td valign="top" align="right"></td>
  36 </tr></table></div>
  37 <div class="refsynopsisdiv">
  38 <a name="GSignondCredentials.synopsis"></a><h2>Synopsis</h2>
  39 <pre class="synopsis">
  40 #include &lt;gsignond/gsignond-credentials.h&gt;
  41
  42                     <a class="link" href="GSignondCredentials.html#GSignondCredentials-struct" title="GSignondCredentials">GSignondCredentials</a>;
  43                     <a class="link" href="GSignondCredentials.html#GSignondCredentialsClass" title="GSignondCredentialsClass">GSignondCredentialsClass</a>;
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSignondCredentials.html#gsignond-credentials-equal" title="gsignond_credentials_equal ()">gsignond_credentials_equal</a>          (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *one</code></em>,
  45                                                          <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *two</code></em>);
  46 <span class="returnvalue">guint32</span>             <a class="link" href="GSignondCredentials.html#gsignond-credentials-get-id" title="gsignond_credentials_get_id ()">gsignond_credentials_get_id</a>         (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);
  47 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="GSignondCredentials.html#gsignond-credentials-get-password" title="gsignond_credentials_get_password ()">gsignond_credentials_get_password</a>   (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</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="GSignondCredentials.html#gsignond-credentials-get-username" title="gsignond_credentials_get_username ()">gsignond_credentials_get_username</a>   (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>);
  49 <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> * <a class="link" href="GSignondCredentials.html#gsignond-credentials-new" title="gsignond_credentials_new ()">gsignond_credentials_new</a>          ();
  50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-data" title="gsignond_credentials_set_data ()">gsignond_credentials_set_data</a>       (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>,
  51                                                          <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>,
  52                                                          <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>,
  53                                                          <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>);
  54 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-id" title="gsignond_credentials_set_id ()">gsignond_credentials_set_id</a>         (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>,
  55                                                          <em class="parameter"><code>const <span class="type">guint32</span> id</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="GSignondCredentials.html#gsignond-credentials-set-password" title="gsignond_credentials_set_password ()">gsignond_credentials_set_password</a>   (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</code></em>,
  57                                                          <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>);
  58 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSignondCredentials.html#gsignond-credentials-set-username" title="gsignond_credentials_set_username ()">gsignond_credentials_set_username</a>   (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *self</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> *username</code></em>);
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GSignondCredentials.object-hierarchy"></a><h2>Object Hierarchy</h2>
  64 <pre class="synopsis">
  65   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  66    +----GSignondCredentials
  67 </pre>
  68 </div>
  69 <div class="refsect1">
  70 <a name="GSignondCredentials.description"></a><h2>Description</h2>
  71 <p>
  72 <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> hold a username, password, and identity id, associated
  73 with an identity. This information in stored in secret storage using
  74 <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a>.
  75 </p>
  76 </div>
  77 <div class="refsect1">
  78 <a name="GSignondCredentials.details"></a><h2>Details</h2>
  79 <div class="refsect2">
  80 <a name="GSignondCredentials-struct"></a><h3>GSignondCredentials</h3>
  81 <pre class="programlisting">typedef struct _GSignondCredentials GSignondCredentials;</pre>
  82 <p>
  83 Opaque <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> data structure.
  84 </p>
  85 </div>
  86 <hr>
  87 <div class="refsect2">
  88 <a name="GSignondCredentialsClass"></a><h3>GSignondCredentialsClass</h3>
  89 <pre class="programlisting">typedef struct {
  90 } GSignondCredentialsClass;
  91 </pre>
  92 <p>
  93 Opaque <a class="link" href="GSignondCredentials.html#GSignondCredentialsClass" title="GSignondCredentialsClass"><span class="type">GSignondCredentialsClass</span></a> data structure.
  94 </p>
  95 </div>
  96 <hr>
  97 <div class="refsect2">
  98 <a name="gsignond-credentials-equal"></a><h3>gsignond_credentials_equal ()</h3>
  99 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_credentials_equal          (<em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *one</code></em>,
 100                                                          <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *two</code></em>);</pre>
 101 <p>
 102 Compares elements of two GSignondCredentials object for equality.
 103 </p>
 104 <div class="variablelist"><table border="0">
 105 <col align="left" valign="top">
 106 <tbody>
 107 <tr>
 108 <td><p><span class="term"><em class="parameter"><code>one</code></em> :</span></p></td>
 109 <td>the first credential to be compared.</td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term"><em class="parameter"><code>two</code></em> :</span></p></td>
 113 <td>the second credential to be compared.</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 117 <td>TRUE if id, username and password are same for both credential
 118 objects, FALSE otherwise.</td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="gsignond-credentials-get-id"></a><h3>gsignond_credentials_get_id ()</h3>
 126 <pre class="programlisting"><span class="returnvalue">guint32</span>             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>
 127 <p>
 128 Gets the identity id
 129 </p>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 135 <td>the object whose id is to be set.</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 139 <td>the id</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="gsignond-credentials-get-password"></a><h3>gsignond_credentials_get_password ()</h3>
 147 <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_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>
 148 <p>
 149 Gets the password from the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object
 150 </p>
 151 <div class="variablelist"><table border="0">
 152 <col align="left" valign="top">
 153 <tbody>
 154 <tr>
 155 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 156 <td>the object whose password is to be set.</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 160 <td>the password if the object is valid, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 161 </td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="gsignond-credentials-get-username"></a><h3>gsignond_credentials_get_username ()</h3>
 169 <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_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>
 170 <p>
 171 Gets the username of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object
 172 </p>
 173 <div class="variablelist"><table border="0">
 174 <col align="left" valign="top">
 175 <tbody>
 176 <tr>
 177 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 178 <td>the object whose username is to be set.</td>
 179 </tr>
 180 <tr>
 181 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 182 <td>the username if the object is valid, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 183 </td>
 184 </tr>
 185 </tbody>
 186 </table></div>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="gsignond-credentials-new"></a><h3>gsignond_credentials_new ()</h3>
 191 <pre class="programlisting"><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> * gsignond_credentials_new          ();</pre>
 192 <p>
 193 Creates a new empty <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object
 194 </p>
 195 <div class="variablelist"><table border="0">
 196 <col align="left" valign="top">
 197 <tbody><tr>
 198 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 199 <td>the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 200 </td>
 201 </tr></tbody>
 202 </table></div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="gsignond-credentials-set-data"></a><h3>gsignond_credentials_set_data ()</h3>
 207 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 208                                                          <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>,
 209                                                          <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>,
 210                                                          <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>
 211 <p>
 212 Sets the data of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a>.
 213 </p>
 214 <div class="variablelist"><table border="0">
 215 <col align="left" valign="top">
 216 <tbody>
 217 <tr>
 218 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 219 <td>the object whose data is to be set.</td>
 220 </tr>
 221 <tr>
 222 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 223 <td>the identity id associated with the credentials.</td>
 224 </tr>
 225 <tr>
 226 <td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
 227 <td>the username. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 228 </td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 232 <td>the password. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 233 </td>
 234 </tr>
 235 <tr>
 236 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 237 <td>TRUE if successful, FALSE otherwise.</td>
 238 </tr>
 239 </tbody>
 240 </table></div>
 241 </div>
 242 <hr>
 243 <div class="refsect2">
 244 <a name="gsignond-credentials-set-id"></a><h3>gsignond_credentials_set_id ()</h3>
 245 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 246                                                          <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre>
 247 <p>
 248 Sets the identity id of the <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> object
 249 </p>
 250 <div class="variablelist"><table border="0">
 251 <col align="left" valign="top">
 252 <tbody>
 253 <tr>
 254 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 255 <td>the object whose id is to be set.</td>
 256 </tr>
 257 <tr>
 258 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 259 <td>the id.</td>
 260 </tr>
 261 <tr>
 262 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 263 <td>TRUE if successful, FALSE otherwise.</td>
 264 </tr>
 265 </tbody>
 266 </table></div>
 267 </div>
 268 <hr>
 269 <div class="refsect2">
 270 <a name="gsignond-credentials-set-password"></a><h3>gsignond_credentials_set_password ()</h3>
 271 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 272                                                          <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>
 273 <p>
 274 Sets the password of the GSignondCredentials object
 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>self</code></em> :</span></p></td>
 281 <td>the object whose password is to be set.</td>
 282 </tr>
 283 <tr>
 284 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 285 <td>the password. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 286 </td>
 287 </tr>
 288 <tr>
 289 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 290 <td>TRUE if successful, FALSE otherwise.</td>
 291 </tr>
 292 </tbody>
 293 </table></div>
 294 </div>
 295 <hr>
 296 <div class="refsect2">
 297 <a name="gsignond-credentials-set-username"></a><h3>gsignond_credentials_set_username ()</h3>
 298 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 299                                                          <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>
 300 <p>
 301 Sets the username of the GSignondCredentials object
 302 </p>
 303 <div class="variablelist"><table border="0">
 304 <col align="left" valign="top">
 305 <tbody>
 306 <tr>
 307 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 308 <td>the object whose username is to be set.</td>
 309 </tr>
 310 <tr>
 311 <td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
 312 <td>the username. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 313 </td>
 314 </tr>
 315 <tr>
 316 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 317 <td>TRUE if successful, FALSE otherwise.</td>
 318 </tr>
 319 </tbody>
 320 </table></div>
 321 </div>
 322 </div>
 323 </div>
 324 <div class="footer">
 325 <hr>
 326           Generated by GTK-Doc V1.19.1</div>
 327 </body>
 328 </html>