libgsignon-glib first release 2.0.0
[profile/ivi/libgsignon-glib.git] / docs / reference / html / SignonIdentityInfo.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>SignonIdentityInfo</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="libgsignon-glib Reference Manual">
8 <link rel="up" href="credential-management.html" title="Credential management">
9 <link rel="prev" href="SignonIdentity.html" title="SignonIdentity">
10 <link rel="next" href="SignonSecurityContext.html" title="SignonSecurityContext">
11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="SignonIdentity.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="credential-management.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">libgsignon-glib Reference Manual</th>
21 <td><a accesskey="n" href="SignonSecurityContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#SignonIdentityInfo.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#SignonIdentityInfo.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#SignonIdentityInfo.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="SignonIdentityInfo"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="SignonIdentityInfo.top_of_page"></a>SignonIdentityInfo</span></h2>
36 <p>SignonIdentityInfo — Extra data for a <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a>.</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv">
41 <a name="SignonIdentityInfo.synopsis"></a><h2>Synopsis</h2>
42 <a name="SignonIdentityType"></a><pre class="synopsis">                    <a class="link" href="SignonIdentityInfo.html#SignonIdentityInfo-struct" title="SignonIdentityInfo">SignonIdentityInfo</a>;
43 enum                <a class="link" href="SignonIdentityInfo.html#SignonIdentityType-enum" title="enum SignonIdentityType">SignonIdentityType</a>;
44 <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="returnvalue">SignonIdentityInfo</span></a> * <a class="link" href="SignonIdentityInfo.html#signon-identity-info-copy" title="signon_identity_info_copy ()">signon_identity_info_copy</a>          (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *other</code></em>);
45 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-free" title="signon_identity_info_free ()">signon_identity_info_free</a>           (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
46 const <a class="link" href="SignonSecurityContext.html#SignonSecurityContextList" title="SignonSecurityContextList"><span class="returnvalue">SignonSecurityContextList</span></a> * <a class="link" href="SignonIdentityInfo.html#signon-identity-info-get-access-control-list" title="signon_identity_info_get_access_control_list ()">signon_identity_info_get_access_control_list</a>
47                                                         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</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="SignonIdentityInfo.html#signon-identity-info-get-caption" title="signon_identity_info_get_caption ()">signon_identity_info_get_caption</a>    (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-get-id" title="signon_identity_info_get_id ()">signon_identity_info_get_id</a>         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
50 <a class="link" href="SignonIdentityInfo.html#SignonIdentityType"><span class="returnvalue">SignonIdentityType</span></a>  <a class="link" href="SignonIdentityInfo.html#signon-identity-info-get-identity-type" title="signon_identity_info_get_identity_type ()">signon_identity_info_get_identity_type</a>
51                                                         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
52 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *  <a class="link" href="SignonIdentityInfo.html#signon-identity-info-get-methods" title="signon_identity_info_get_methods ()">signon_identity_info_get_methods</a>    (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
53 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * <a class="link" href="SignonIdentityInfo.html#signon-identity-info-get-realms" title="signon_identity_info_get_realms ()">signon_identity_info_get_realms</a>   (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</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="SignonIdentityInfo.html#signon-identity-info-get-storing-secret" title="signon_identity_info_get_storing_secret ()">signon_identity_info_get_storing_secret</a>
55                                                         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
56 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="SignonIdentityInfo.html#signon-identity-info-get-username" title="signon_identity_info_get_username ()">signon_identity_info_get_username</a>   (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);
57 <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="returnvalue">SignonIdentityInfo</span></a> * <a class="link" href="SignonIdentityInfo.html#signon-identity-info-new" title="signon_identity_info_new ()">signon_identity_info_new</a>           ();
58 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-remove-method" title="signon_identity_info_remove_method ()">signon_identity_info_remove_method</a>  (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</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> *method</code></em>);
60 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-access-control-list" title="signon_identity_info_set_access_control_list ()">signon_identity_info_set_access_control_list</a>
61                                                         (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
62                                                          <em class="parameter"><code>const <a class="link" href="SignonSecurityContext.html#SignonSecurityContextList" title="SignonSecurityContextList"><span class="type">SignonSecurityContextList</span></a> *access_control_list</code></em>);
63 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-caption" title="signon_identity_info_set_caption ()">signon_identity_info_set_caption</a>    (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
64                                                          <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>);
65 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-identity-type" title="signon_identity_info_set_identity_type ()">signon_identity_info_set_identity_type</a>
66                                                         (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
67                                                          <em class="parameter"><code><a class="link" href="SignonIdentityInfo.html#SignonIdentityType"><span class="type">SignonIdentityType</span></a> type</code></em>);
68 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-method" title="signon_identity_info_set_method ()">signon_identity_info_set_method</a>     (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
69                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
70                                                          <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> * const *mechanisms</code></em>);
71 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-realms" title="signon_identity_info_set_realms ()">signon_identity_info_set_realms</a>     (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
72                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *realms</code></em>);
73 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-secret" title="signon_identity_info_set_secret ()">signon_identity_info_set_secret</a>     (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
74                                                          <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>,
75                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> store_secret</code></em>);
76 <span class="returnvalue">void</span>                <a class="link" href="SignonIdentityInfo.html#signon-identity-info-set-username" title="signon_identity_info_set_username ()">signon_identity_info_set_username</a>   (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
77                                                          <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>);
78 </pre>
79 </div>
80 <div class="refsect1">
81 <a name="SignonIdentityInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
82 <pre class="synopsis">
83   GBoxed
84    +----SignonIdentityInfo
85 </pre>
86 <pre class="synopsis">
87   GFlags
88    +----SignonIdentityType
89 </pre>
90 </div>
91 <div class="refsect1">
92 <a name="SignonIdentityInfo.description"></a><h2>Description</h2>
93 <p>
94 Extra data retreived from a <a class="link" href="SignonIdentity.html" title="SignonIdentity"><span class="type">SignonIdentity</span></a>.
95 </p>
96 </div>
97 <div class="refsect1">
98 <a name="SignonIdentityInfo.details"></a><h2>Details</h2>
99 <div class="refsect2">
100 <a name="SignonIdentityInfo-struct"></a><h3>SignonIdentityInfo</h3>
101 <pre class="programlisting">typedef struct _SignonIdentityInfo SignonIdentityInfo;</pre>
102 <p>
103 Opaque struct. Use the accessor functions below.
104 </p>
105 </div>
106 <hr>
107 <div class="refsect2">
108 <a name="SignonIdentityType-enum"></a><h3>enum SignonIdentityType</h3>
109 <pre class="programlisting">typedef enum {
110     SIGNON_IDENTITY_TYPE_OTHER = 0,
111     SIGNON_IDENTITY_TYPE_APP = 1 &lt;&lt; 0,
112     SIGNON_IDENTITY_TYPE_WEB = 1 &lt;&lt; 1,
113     SIGNON_IDENTITY_TYPE_NETWORK = 1 &lt;&lt; 2
114 } SignonIdentityType;
115 </pre>
116 <p>
117 Types used in <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.
118 </p>
119 <div class="variablelist"><table border="0">
120 <col align="left" valign="top">
121 <tbody>
122 <tr>
123 <td><p><a name="SIGNON-IDENTITY-TYPE-OTHER:CAPS"></a><span class="term"><code class="literal">SIGNON_IDENTITY_TYPE_OTHER</code></span></p></td>
124 <td>an identity that is not an app, web or network
125 </td>
126 </tr>
127 <tr>
128 <td><p><a name="SIGNON-IDENTITY-TYPE-APP:CAPS"></a><span class="term"><code class="literal">SIGNON_IDENTITY_TYPE_APP</code></span></p></td>
129 <td>an application identity
130 </td>
131 </tr>
132 <tr>
133 <td><p><a name="SIGNON-IDENTITY-TYPE-WEB:CAPS"></a><span class="term"><code class="literal">SIGNON_IDENTITY_TYPE_WEB</code></span></p></td>
134 <td>a web identity
135 </td>
136 </tr>
137 <tr>
138 <td><p><a name="SIGNON-IDENTITY-TYPE-NETWORK:CAPS"></a><span class="term"><code class="literal">SIGNON_IDENTITY_TYPE_NETWORK</code></span></p></td>
139 <td>a network server identity
140 </td>
141 </tr>
142 </tbody>
143 </table></div>
144 </div>
145 <hr>
146 <div class="refsect2">
147 <a name="signon-identity-info-copy"></a><h3>signon_identity_info_copy ()</h3>
148 <pre class="programlisting"><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="returnvalue">SignonIdentityInfo</span></a> * signon_identity_info_copy          (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *other</code></em>);</pre>
149 <p>
150 Get a newly-allocated copy of <em class="parameter"><code>info</code></em>.
151 </p>
152 <div class="variablelist"><table border="0">
153 <col align="left" valign="top">
154 <tbody>
155 <tr>
156 <td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
157 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
158 </tr>
159 <tr>
160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161 <td>a copy of the given <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</td>
162 </tr>
163 </tbody>
164 </table></div>
165 </div>
166 <hr>
167 <div class="refsect2">
168 <a name="signon-identity-info-free"></a><h3>signon_identity_info_free ()</h3>
169 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_free           (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
170 <p>
171 Destroys the given <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> item.
172 </p>
173 <div class="variablelist"><table border="0">
174 <col align="left" valign="top">
175 <tbody><tr>
176 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
177 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
178 </tr></tbody>
179 </table></div>
180 </div>
181 <hr>
182 <div class="refsect2">
183 <a name="signon-identity-info-get-access-control-list"></a><h3>signon_identity_info_get_access_control_list ()</h3>
184 <pre class="programlisting">const <a class="link" href="SignonSecurityContext.html#SignonSecurityContextList" title="SignonSecurityContextList"><span class="returnvalue">SignonSecurityContextList</span></a> * signon_identity_info_get_access_control_list
185                                                         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
186 <p>
187 Get an array of ACL statements of the identity.
188 </p>
189 <div class="variablelist"><table border="0">
190 <col align="left" valign="top">
191 <tbody>
192 <tr>
193 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
194 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
195 </tr>
196 <tr>
197 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
198 <td>a list of ACL security contexts. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
199 </td>
200 </tr>
201 </tbody>
202 </table></div>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="signon-identity-info-get-caption"></a><h3>signon_identity_info_get_caption ()</h3>
207 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       signon_identity_info_get_caption    (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
208 <p>
209 Get the display name of <em class="parameter"><code>info</code></em>.
210 </p>
211 <div class="variablelist"><table border="0">
212 <col align="left" valign="top">
213 <tbody>
214 <tr>
215 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
216 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
217 </tr>
218 <tr>
219 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
220 <td>the display name for the identity.</td>
221 </tr>
222 </tbody>
223 </table></div>
224 </div>
225 <hr>
226 <div class="refsect2">
227 <a name="signon-identity-info-get-id"></a><h3>signon_identity_info_get_id ()</h3>
228 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                signon_identity_info_get_id         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
229 <p>
230 Get the numeric ID of <em class="parameter"><code>info</code></em>.
231 </p>
232 <div class="variablelist"><table border="0">
233 <col align="left" valign="top">
234 <tbody>
235 <tr>
236 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
237 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
238 </tr>
239 <tr>
240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
241 <td>the numeric ID of the identity.</td>
242 </tr>
243 </tbody>
244 </table></div>
245 </div>
246 <hr>
247 <div class="refsect2">
248 <a name="signon-identity-info-get-identity-type"></a><h3>signon_identity_info_get_identity_type ()</h3>
249 <pre class="programlisting"><a class="link" href="SignonIdentityInfo.html#SignonIdentityType"><span class="returnvalue">SignonIdentityType</span></a>  signon_identity_info_get_identity_type
250                                                         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
251 <p>
252 Get the type of the identity.
253 </p>
254 <div class="variablelist"><table border="0">
255 <col align="left" valign="top">
256 <tbody>
257 <tr>
258 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
259 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
260 </tr>
261 <tr>
262 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
263 <td>the type of the identity.</td>
264 </tr>
265 </tbody>
266 </table></div>
267 </div>
268 <hr>
269 <div class="refsect2">
270 <a name="signon-identity-info-get-methods"></a><h3>signon_identity_info_get_methods ()</h3>
271 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *  signon_identity_info_get_methods    (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
272 <p>
273 Get a hash table of the methods and mechanisms of <em class="parameter"><code>info</code></em>.
274 </p>
275 <div class="variablelist"><table border="0">
276 <col align="left" valign="top">
277 <tbody>
278 <tr>
279 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
280 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
281 </tr>
282 <tr>
283 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284 <td>the table of allowed
285 methods and mechanisms. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GStrv]</span>
286 </td>
287 </tr>
288 </tbody>
289 </table></div>
290 </div>
291 <hr>
292 <div class="refsect2">
293 <a name="signon-identity-info-get-realms"></a><h3>signon_identity_info_get_realms ()</h3>
294 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * signon_identity_info_get_realms   (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
295 <p>
296 Get an array of the realms of <em class="parameter"><code>info</code></em>.
297 </p>
298 <div class="variablelist"><table border="0">
299 <col align="left" valign="top">
300 <tbody>
301 <tr>
302 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
303 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
304 </tr>
305 <tr>
306 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
307 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of realms. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
308 </td>
309 </tr>
310 </tbody>
311 </table></div>
312 </div>
313 <hr>
314 <div class="refsect2">
315 <a name="signon-identity-info-get-storing-secret"></a><h3>signon_identity_info_get_storing_secret ()</h3>
316 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            signon_identity_info_get_storing_secret
317                                                         (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
318 <p>
319 Get whether the secret of <em class="parameter"><code>info</code></em> should be stored.
320 </p>
321 <div class="variablelist"><table border="0">
322 <col align="left" valign="top">
323 <tbody>
324 <tr>
325 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
326 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
327 </tr>
328 <tr>
329 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
330 <td>
331 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if Signon must store the secret, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
332 </tr>
333 </tbody>
334 </table></div>
335 </div>
336 <hr>
337 <div class="refsect2">
338 <a name="signon-identity-info-get-username"></a><h3>signon_identity_info_get_username ()</h3>
339 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       signon_identity_info_get_username   (<em class="parameter"><code>const <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>);</pre>
340 <p>
341 Get the username of <em class="parameter"><code>info</code></em>.
342 </p>
343 <div class="variablelist"><table border="0">
344 <col align="left" valign="top">
345 <tbody>
346 <tr>
347 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
348 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
349 </tr>
350 <tr>
351 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
352 <td>the username, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
353 </tr>
354 </tbody>
355 </table></div>
356 </div>
357 <hr>
358 <div class="refsect2">
359 <a name="signon-identity-info-new"></a><h3>signon_identity_info_new ()</h3>
360 <pre class="programlisting"><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="returnvalue">SignonIdentityInfo</span></a> * signon_identity_info_new           ();</pre>
361 <p>
362 Creates a new <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> item.
363 </p>
364 <div class="variablelist"><table border="0">
365 <col align="left" valign="top">
366 <tbody><tr>
367 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
368 <td>a new <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> item.</td>
369 </tr></tbody>
370 </table></div>
371 </div>
372 <hr>
373 <div class="refsect2">
374 <a name="signon-identity-info-remove-method"></a><h3>signon_identity_info_remove_method ()</h3>
375 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_remove_method  (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
376                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
377 <p>
378 Remove <em class="parameter"><code>method</code></em> from the list of allowed authentication methods. If all
379 methods are removed, then all methods are allowed.
380 </p>
381 <div class="variablelist"><table border="0">
382 <col align="left" valign="top">
383 <tbody>
384 <tr>
385 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
386 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
387 </tr>
388 <tr>
389 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
390 <td>an authentication method.</td>
391 </tr>
392 </tbody>
393 </table></div>
394 </div>
395 <hr>
396 <div class="refsect2">
397 <a name="signon-identity-info-set-access-control-list"></a><h3>signon_identity_info_set_access_control_list ()</h3>
398 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_access_control_list
399                                                         (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
400                                                          <em class="parameter"><code>const <a class="link" href="SignonSecurityContext.html#SignonSecurityContextList" title="SignonSecurityContextList"><span class="type">SignonSecurityContextList</span></a> *access_control_list</code></em>);</pre>
401 <p>
402 Specifies the ACL for this identity. The actual meaning of the ACL depends
403 on the security framework used by signond. Ownership of the list is trans
404 </p>
405 <div class="variablelist"><table border="0">
406 <col align="left" valign="top">
407 <tbody>
408 <tr>
409 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
410 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
411 </tr>
412 <tr>
413 <td><p><span class="term"><em class="parameter"><code>access_control_list</code></em> :</span></p></td>
414 <td>(transfer none) a list of ACL security contexts.</td>
415 </tr>
416 </tbody>
417 </table></div>
418 </div>
419 <hr>
420 <div class="refsect2">
421 <a name="signon-identity-info-set-caption"></a><h3>signon_identity_info_set_caption ()</h3>
422 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_caption    (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
423                                                          <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>
424 <p>
425 Sets the caption (display name) for the identity.
426 </p>
427 <div class="variablelist"><table border="0">
428 <col align="left" valign="top">
429 <tbody>
430 <tr>
431 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
432 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
433 </tr>
434 <tr>
435 <td><p><span class="term"><em class="parameter"><code>caption</code></em> :</span></p></td>
436 <td>the caption.</td>
437 </tr>
438 </tbody>
439 </table></div>
440 </div>
441 <hr>
442 <div class="refsect2">
443 <a name="signon-identity-info-set-identity-type"></a><h3>signon_identity_info_set_identity_type ()</h3>
444 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_identity_type
445                                                         (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
446                                                          <em class="parameter"><code><a class="link" href="SignonIdentityInfo.html#SignonIdentityType"><span class="type">SignonIdentityType</span></a> type</code></em>);</pre>
447 <p>
448 Specifies the type of this identity.
449 </p>
450 <div class="variablelist"><table border="0">
451 <col align="left" valign="top">
452 <tbody>
453 <tr>
454 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
455 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
456 </tr>
457 <tr>
458 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
459 <td>the type of the identity.</td>
460 </tr>
461 </tbody>
462 </table></div>
463 </div>
464 <hr>
465 <div class="refsect2">
466 <a name="signon-identity-info-set-method"></a><h3>signon_identity_info_set_method ()</h3>
467 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_method     (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
468                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
469                                                          <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> * const *mechanisms</code></em>);</pre>
470 <p>
471 Adds a method to the list of allowed methods.
472 Mechanisms are method-specific functions.
473 </p>
474 <div class="variablelist"><table border="0">
475 <col align="left" valign="top">
476 <tbody>
477 <tr>
478 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
479 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
480 </tr>
481 <tr>
482 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
483 <td>an authentication method.</td>
484 </tr>
485 <tr>
486 <td><p><span class="term"><em class="parameter"><code>mechanisms</code></em> :</span></p></td>
487 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-termianted list of mechanisms.</td>
488 </tr>
489 </tbody>
490 </table></div>
491 </div>
492 <hr>
493 <div class="refsect2">
494 <a name="signon-identity-info-set-realms"></a><h3>signon_identity_info_set_realms ()</h3>
495 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_realms     (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
496                                                          <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> * const *realms</code></em>);</pre>
497 <p>
498 Specify what realms this identity can be used in.
499 </p>
500 <div class="variablelist"><table border="0">
501 <col align="left" valign="top">
502 <tbody>
503 <tr>
504 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
505 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
506 </tr>
507 <tr>
508 <td><p><span class="term"><em class="parameter"><code>realms</code></em> :</span></p></td>
509 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of realms.</td>
510 </tr>
511 </tbody>
512 </table></div>
513 </div>
514 <hr>
515 <div class="refsect2">
516 <a name="signon-identity-info-set-secret"></a><h3>signon_identity_info_set_secret ()</h3>
517 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_secret     (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
518                                                          <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>,
519                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> store_secret</code></em>);</pre>
520 <p>
521 Sets the secret (password) for the identity, and whether the signon daemon
522 should remember it.
523 </p>
524 <div class="variablelist"><table border="0">
525 <col align="left" valign="top">
526 <tbody>
527 <tr>
528 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
529 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
530 </tr>
531 <tr>
532 <td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td>
533 <td>the secret.</td>
534 </tr>
535 <tr>
536 <td><p><span class="term"><em class="parameter"><code>store_secret</code></em> :</span></p></td>
537 <td>whether signond should store the secret in its DB.</td>
538 </tr>
539 </tbody>
540 </table></div>
541 </div>
542 <hr>
543 <div class="refsect2">
544 <a name="signon-identity-info-set-username"></a><h3>signon_identity_info_set_username ()</h3>
545 <pre class="programlisting"><span class="returnvalue">void</span>                signon_identity_info_set_username   (<em class="parameter"><code><a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a> *info</code></em>,
546                                                          <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>
547 <p>
548 Sets the username for the identity.
549 </p>
550 <div class="variablelist"><table border="0">
551 <col align="left" valign="top">
552 <tbody>
553 <tr>
554 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
555 <td>the <a class="link" href="SignonIdentityInfo.html" title="SignonIdentityInfo"><span class="type">SignonIdentityInfo</span></a>.</td>
556 </tr>
557 <tr>
558 <td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
559 <td>the username.</td>
560 </tr>
561 </tbody>
562 </table></div>
563 </div>
564 </div>
565 </div>
566 <div class="footer">
567 <hr>
568           Generated by GTK-Doc V1.18</div>
569 </body>
570 </html>