/usr/share/gtk-doc/html/libedataserverui/libedataserverui-EClient-Utilities.html is in libedataserverui-3.0-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EClient Utilities</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="prev" href="libedataserverui-ECellRendererColor.html" title="ECellRendererColor">
<link rel="next" href="libedataserverui-EContactStore.html" title="EContactStore">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libedataserverui-ECellRendererColor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)</th>
<td><a accesskey="n" href="libedataserverui-EContactStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserverui-EClient-Utilities.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserverui-EClient-Utilities.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserverui-EClient-Utilities"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserverui-EClient-Utilities.top_of_page"></a>EClient Utilities</span></h2>
<p>EClient Utilities</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserverui-EClient-Utilities.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType">EClientSourceType</a>;
<span class="returnvalue">gboolean</span> (<a class="link" href="libedataserverui-EClient-Utilities.html#EClientUtilsAuthenticateHandler" title="EClientUtilsAuthenticateHandler ()">*EClientUtilsAuthenticateHandler</a>) (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>,
<em class="parameter"><code><span class="type">ECredentials</span> *credentials</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">EClient</span> * <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-new" title="e_client_utils_new ()">e_client_utils_new</a> (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">EClient</span> * <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-new-from-uri" title="e_client_utils_new_from_uri ()">e_client_utils_new_from_uri</a> (<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">EClient</span> * <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-new-system" title="e_client_utils_new_system ()">e_client_utils_new_system</a> (<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">EClient</span> * <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-new-default" title="e_client_utils_new_default ()">e_client_utils_new_default</a> (<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-set-default" title="e_client_utils_set_default ()">e_client_utils_set_default</a> (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-set-default-source" title="e_client_utils_set_default_source ()">e_client_utils_set_default_source</a> (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-get-sources" title="e_client_utils_get_sources ()">e_client_utils_get_sources</a> (<em class="parameter"><code><span class="type">ESourceList</span> **sources</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new" title="e_client_utils_open_new ()">e_client_utils_open_new</a> (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientUtilsAuthenticateHandler" title="EClientUtilsAuthenticateHandler ()"><span class="type">EClientUtilsAuthenticateHandler</span></a> auth_handler</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> auth_handler_user_data</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> async_cb</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> async_cb_user_data</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new-finish" title="e_client_utils_open_new_finish ()">e_client_utils_open_new_finish</a> (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">EClient</span> **client</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-authenticate-handler" title="e_client_utils_authenticate_handler ()">e_client_utils_authenticate_handler</a> (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>,
<em class="parameter"><code><span class="type">ECredentials</span> *credentials</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> gtk_window_parent</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-forget-password" title="e_client_utils_forget_password ()">e_client_utils_forget_password</a> (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-credentials-authenticate-helper" title="e_credentials_authenticate_helper ()">e_credentials_authenticate_helper</a> (<em class="parameter"><code><span class="type">ECredentials</span> *credentials</code></em>,
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *remember_password</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-EClient-Utilities.html#e-credentials-forget-password" title="e_credentials_forget_password ()">e_credentials_forget_password</a> (<em class="parameter"><code>const <span class="type">ECredentials</span> *credentials</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserverui-EClient-Utilities.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserverui-EClient-Utilities.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EClientSourceType"></a><h3>enum EClientSourceType</h3>
<pre class="programlisting">typedef enum {
E_CLIENT_SOURCE_TYPE_CONTACTS,
E_CLIENT_SOURCE_TYPE_EVENTS,
E_CLIENT_SOURCE_TYPE_MEMOS,
E_CLIENT_SOURCE_TYPE_TASKS,
E_CLIENT_SOURCE_TYPE_LAST
} EClientSourceType;
</pre>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="EClientUtilsAuthenticateHandler"></a><h3>EClientUtilsAuthenticateHandler ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*EClientUtilsAuthenticateHandler) (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>,
<em class="parameter"><code><span class="type">ECredentials</span> *credentials</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-new"></a><h3>e_client_utils_new ()</h3>
<pre class="programlisting"><span class="returnvalue">EClient</span> * e_client_utils_new (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_new()</code> and <code class="function">e_cal_client_utils_new()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-new-from-uri"></a><h3>e_client_utils_new_from_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">EClient</span> * e_client_utils_new_from_uri (<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_new_from_uri()</code> and <code class="function">e_cal_client_utils_new_from_uri()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-new-system"></a><h3>e_client_utils_new_system ()</h3>
<pre class="programlisting"><span class="returnvalue">EClient</span> * e_client_utils_new_system (<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_new_system()</code> and <code class="function">e_cal_client_utils_new_system()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-new-default"></a><h3>e_client_utils_new_default ()</h3>
<pre class="programlisting"><span class="returnvalue">EClient</span> * e_client_utils_new_default (<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_new_default()</code> and <code class="function">e_cal_client_utils_new_default()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-set-default"></a><h3>e_client_utils_set_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_client_utils_set_default (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_set_default()</code> and <code class="function">e_book_client_utils_set_default()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-set-default-source"></a><h3>e_client_utils_set_default_source ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_client_utils_set_default_source (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_set_default_source()</code> and <code class="function">e_cal_client_utils_set_default_source()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-get-sources"></a><h3>e_client_utils_get_sources ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_client_utils_get_sources (<em class="parameter"><code><span class="type">ESourceList</span> **sources</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Proxy function for <code class="function">e_book_client_utils_get_sources()</code> and <code class="function">e_cal_client_utils_get_sources()</code>.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-open-new"></a><h3>e_client_utils_open_new ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_client_utils_open_new (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> source_type</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EClient-Utilities.html#EClientUtilsAuthenticateHandler" title="EClientUtilsAuthenticateHandler ()"><span class="type">EClientUtilsAuthenticateHandler</span></a> auth_handler</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> auth_handler_user_data</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> async_cb</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> async_cb_user_data</code></em>);</pre>
<p>
Begins asynchronous opening of a new <span class="type">EClient</span> corresponding
to the <em class="parameter"><code>source</code></em> of type <em class="parameter"><code>source_type</code></em>. The resulting <span class="type">EClient</span>
is fully opened and authenticated client, ready to be used.
The opened client has also fetched capabilities.
This call is finished by <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new-finish" title="e_client_utils_open_new_finish ()"><code class="function">e_client_utils_open_new_finish()</code></a>
from the <em class="parameter"><code>async_cb</code></em>.
</p>
<p>
Note: the <em class="parameter"><code>auth_handler</code></em>, and its <em class="parameter"><code>auth_handler_user_data</code></em>,
should be valid through whole live of returned <span class="type">EClient</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>an <span class="type">ESource</span> to be opened</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source_type</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-EClient-Utilities.html#EClientSourceType" title="enum EClientSourceType"><span class="type">EClientSourceType</span></a> of the <em class="parameter"><code>source</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></p></td>
<td>if <code class="literal">TRUE</code>, fail if this client doesn't already exist, otherwise create it first</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>auth_handler</code></em> :</span></p></td>
<td>authentication handler, to be used; the <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-authenticate-handler" title="e_client_utils_authenticate_handler ()"><code class="function">e_client_utils_authenticate_handler()</code></a> is usually sufficient</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>auth_handler_user_data</code></em> :</span></p></td>
<td>user data for <em class="parameter"><code>auth_handler</code></em> function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>async_cb</code></em> :</span></p></td>
<td>callback to call when a result is ready</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>async_cb_user_data</code></em> :</span></p></td>
<td>user data for the <em class="parameter"><code>async_cb</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-open-new-finish"></a><h3>e_client_utils_open_new_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_client_utils_open_new_finish (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">EClient</span> **client</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes previous call of <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new" title="e_client_utils_open_new ()"><code class="function">e_client_utils_open_new()</code></a> and
sets <em class="parameter"><code>client</code></em> to a fully opened and authenticated <span class="type">EClient</span>.
This <em class="parameter"><code>client</code></em>, if not NULL, should be freed with <code class="function">g_object_unref()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>an <span class="type">ESource</span> on which the <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new" title="e_client_utils_open_new ()"><code class="function">e_client_utils_open_new()</code></a> was invoked</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>Return value for an <span class="type">EClient</span>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-authenticate-handler"></a><h3>e_client_utils_authenticate_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_client_utils_authenticate_handler (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>,
<em class="parameter"><code><span class="type">ECredentials</span> *credentials</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> gtk_window_parent</code></em>);</pre>
<p>
This function is suitable as a handler for EClient::authenticate signal.
It takes care of all the password prompt and such and returns TRUE if
credentials (password) were provided. Thus just connect it to that signal
and it'll take care of everything else.
</p>
<p>
gtk_window_parent is user_data passed into the callback. It can be a pointer
to GtkWindow, used as a parent for a pasword prompt dialog.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-client-utils-forget-password"></a><h3>e_client_utils_forget_password ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_client_utils_forget_password (<em class="parameter"><code><span class="type">EClient</span> *client</code></em>);</pre>
<p>
Forgets stored password for the given <em class="parameter"><code>client</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>An <span class="type">EClient</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-authenticate-helper"></a><h3>e_credentials_authenticate_helper ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_credentials_authenticate_helper (<em class="parameter"><code><span class="type">ECredentials</span> *credentials</code></em>,
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *remember_password</code></em>);</pre>
<p>
Asks for a password based on the provided credentials information.
Credentials should have set following keys:
E_CREDENTIALS_KEY_USERNAME
E_CREDENTIALS_KEY_PROMPT_KEY
E_CREDENTIALS_KEY_PROMPT_TEXT
all other keys are optional. If also E_CREDENTIALS_KEY_PASSWORD key is provided,
then it implies a reprompt.
</p>
<p>
When this returns TRUE, then the structure contains E_CREDENTIALS_KEY_PASSWORD set
as entered by a user.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-forget-password"></a><h3>e_credentials_forget_password ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_credentials_forget_password (<em class="parameter"><code>const <span class="type">ECredentials</span> *credentials</code></em>);</pre>
<p>
Forgets stored password for given <em class="parameter"><code>credentials</code></em>, which should contain
E_CREDENTIALS_KEY_PROMPT_KEY.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <span class="type">ECredentials</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|