~ubuntu-branches/ubuntu/saucy/evolution-data-server/saucy

« back to all changes in this revision

Viewing changes to docs/reference/libebackend/html/ESourceRegistryServer.html

  • Committer: Package Import Robot
  • Author(s): Chris Coulson
  • Date: 2012-10-08 12:58:16 UTC
  • mfrom: (181.1.7 quantal)
  • Revision ID: package-import@ubuntu.com-20121008125816-i3n76e8c0m64e7xp
Tags: 3.6.0-0ubuntu2
* Fix LP: #1038047 part 1 - Don't abort in e_source_registry_new* when a
  problem occurs connecting to the Dbus service
  - add debian/patches/dont-abort-in-e_source_registry_new.patch
  - update debian/patches/series
* Fix LP: #1038047 part 2 - libedataserver depends on
  evolution-data-server-common to ensure that the GSettings schemas are
  present
  - update debian/control

Show diffs side-by-side

added added

removed removed

Lines of Context:
50
50
struct              <a class="link" href="ESourceRegistryServer.html#ESourceRegistryServer-struct" title="struct ESourceRegistryServer">ESourceRegistryServer</a>;
51
51
<a class="link" href="EDBusServer.html" title="EDBusServer"><span class="returnvalue">EDBusServer</span></a> *       <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-new" title="e_source_registry_server_new ()">e_source_registry_server_new</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
52
52
<span class="returnvalue">void</span>                <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-add-source" title="e_source_registry_server_add_source ()">e_source_registry_server_add_source</a> (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
53
 
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);
 
53
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);
54
54
<span class="returnvalue">void</span>                <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-remove-source" title="e_source_registry_server_remove_source ()">e_source_registry_server_remove_source</a>
55
55
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);
57
 
<span class="returnvalue">void</span>                <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-queue-auth-session" title="e_source_registry_server_queue_auth_session ()">e_source_registry_server_queue_auth_session</a>
58
 
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
59
 
                                                         <em class="parameter"><code><a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>);
 
56
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);
60
57
<span class="returnvalue">gboolean</span>            <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-load-all" title="e_source_registry_server_load_all ()">e_source_registry_server_load_all</a>   (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
61
58
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
62
59
enum                <a class="link" href="ESourceRegistryServer.html#ESourcePermissionFlags" title="enum ESourcePermissionFlags">ESourcePermissionFlags</a>;
65
62
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
66
63
                                                         <em class="parameter"><code><a class="link" href="ESourceRegistryServer.html#ESourcePermissionFlags" title="enum ESourcePermissionFlags"><span class="type">ESourcePermissionFlags</span></a> flags</code></em>,
67
64
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
68
 
<span class="returnvalue">ESource</span> *           <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-load-file" title="e_source_registry_server_load_file ()">e_source_registry_server_load_file</a>  (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
65
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-load-file" title="e_source_registry_server_load_file ()">e_source_registry_server_load_file</a>  (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
69
66
                                                         <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
70
67
                                                         <em class="parameter"><code><a class="link" href="ESourceRegistryServer.html#ESourcePermissionFlags" title="enum ESourcePermissionFlags"><span class="type">ESourcePermissionFlags</span></a> flags</code></em>,
71
68
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
72
69
<span class="returnvalue">void</span>                <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-load-error" title="e_source_registry_server_load_error ()">e_source_registry_server_load_error</a> (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
73
70
                                                         <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
74
71
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
75
 
<span class="returnvalue">ESource</span> *           <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-ref-source" title="e_source_registry_server_ref_source ()">e_source_registry_server_ref_source</a> (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
72
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-ref-source" title="e_source_registry_server_ref_source ()">e_source_registry_server_ref_source</a> (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
76
73
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);
77
74
<span class="returnvalue">GList</span> *             <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-list-sources" title="e_source_registry_server_list_sources ()">e_source_registry_server_list_sources</a>
78
75
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
79
76
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *extension_name</code></em>);
 
77
<a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="returnvalue">ECollectionBackend</span></a> * <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-ref-backend" title="e_source_registry_server_ref_backend ()">e_source_registry_server_ref_backend</a>
 
78
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
79
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);
80
80
<a class="link" href="ECollectionBackendFactory.html" title="ECollectionBackendFactory"><span class="returnvalue">ECollectionBackendFactory</span></a> * <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-ref-backend-factory" title="e_source_registry_server_ref_backend_factory ()">e_source_registry_server_ref_backend_factory</a>
81
81
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
82
 
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);
 
82
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);
 
83
<span class="returnvalue">gboolean</span>            <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate-sync" title="e_source_registry_server_authenticate_sync ()">e_source_registry_server_authenticate_sync</a>
 
84
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
85
                                                         <em class="parameter"><code><a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>,
 
86
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
87
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
88
<span class="returnvalue">void</span>                <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()">e_source_registry_server_authenticate</a>
 
89
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
90
                                                         <em class="parameter"><code><a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>,
 
91
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
92
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
93
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
94
<span class="returnvalue">gboolean</span>            <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate-finish" title="e_source_registry_server_authenticate_finish ()">e_source_registry_server_authenticate_finish</a>
 
95
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
96
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
97
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
83
98
</pre>
84
99
</div>
85
100
<div class="refsect1">
163
178
<div class="refsect2">
164
179
<a name="e-source-registry-server-add-source"></a><h3>e_source_registry_server_add_source ()</h3>
165
180
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_registry_server_add_source (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
166
 
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);</pre>
 
181
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);</pre>
167
182
<p>
168
183
Adds <em class="parameter"><code>source</code></em> to <em class="parameter"><code>server</code></em>.
169
184
</p>
177
192
</tr>
178
193
<tr>
179
194
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
180
 
<td>an <span class="type">ESource</span>
 
195
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>
181
196
</td>
182
197
</tr>
183
198
</tbody>
189
204
<a name="e-source-registry-server-remove-source"></a><h3>e_source_registry_server_remove_source ()</h3>
190
205
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_registry_server_remove_source
191
206
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
192
 
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);</pre>
 
207
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);</pre>
193
208
<p>
194
209
Removes <em class="parameter"><code>source</code></em> and all of its descendants from <em class="parameter"><code>server</code></em>.
195
210
</p>
203
218
</tr>
204
219
<tr>
205
220
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
206
 
<td>an <span class="type">ESource</span>
207
 
</td>
208
 
</tr>
209
 
</tbody>
210
 
</table></div>
211
 
<p class="since">Since 3.6</p>
212
 
</div>
213
 
<hr>
214
 
<div class="refsect2">
215
 
<a name="e-source-registry-server-queue-auth-session"></a><h3>e_source_registry_server_queue_auth_session ()</h3>
216
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_registry_server_queue_auth_session
217
 
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
218
 
                                                         <em class="parameter"><code><a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>);</pre>
219
 
<p>
220
 
Queues an authentication session.  When its turn comes, and if necessary,
221
 
the user will be prompted for a secret.  Sessions are queued this way to
222
 
prevent user prompts from piling up on the screen.
223
 
</p>
224
 
<div class="variablelist"><table border="0">
225
 
<col align="left" valign="top">
226
 
<tbody>
227
 
<tr>
228
 
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
229
 
<td>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>
230
 
</td>
231
 
</tr>
232
 
<tr>
233
 
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
234
 
<td>an <span class="type">EDBusSourceAuthenticator</span>
 
221
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>
235
222
</td>
236
223
</tr>
237
224
</tbody>
362
349
<hr>
363
350
<div class="refsect2">
364
351
<a name="e-source-registry-server-load-file"></a><h3>e_source_registry_server_load_file ()</h3>
365
 
<pre class="programlisting"><span class="returnvalue">ESource</span> *           e_source_registry_server_load_file  (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
352
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           e_source_registry_server_load_file  (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
366
353
                                                         <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
367
354
                                                         <em class="parameter"><code><a class="link" href="ESourceRegistryServer.html#ESourcePermissionFlags" title="enum ESourcePermissionFlags"><span class="type">ESourcePermissionFlags</span></a> flags</code></em>,
368
355
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
369
356
<p>
370
 
Creates an <span class="type">ESource</span> for a native key file and adds it to <em class="parameter"><code>server</code></em>.
 
357
Creates an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> for a native key file and adds it to <em class="parameter"><code>server</code></em>.
371
358
If an error occurs, the function returns <code class="literal">NULL</code> and sets <em class="parameter"><code>error</code></em>.
372
359
</p>
373
360
<p>
374
 
The returned <span class="type">ESource</span> is referenced for thread-safety.  Unreference
375
 
the <span class="type">ESource</span> with <code class="function">g_object_unref()</code> when finished with it.
 
361
The returned <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> is referenced for thread-safety.  Unreference
 
362
the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> with <code class="function">g_object_unref()</code> when finished with it.
376
363
</p>
377
364
<div class="variablelist"><table border="0">
378
365
<col align="left" valign="top">
397
384
</tr>
398
385
<tr>
399
386
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
400
 
<td>the newly-added <span class="type">ESource</span>, or <code class="literal">NULL</code> on error</td>
 
387
<td>the newly-added <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>, or <code class="literal">NULL</code> on error</td>
401
388
</tr>
402
389
</tbody>
403
390
</table></div>
435
422
<hr>
436
423
<div class="refsect2">
437
424
<a name="e-source-registry-server-ref-source"></a><h3>e_source_registry_server_ref_source ()</h3>
438
 
<pre class="programlisting"><span class="returnvalue">ESource</span> *           e_source_registry_server_ref_source (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
425
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           e_source_registry_server_ref_source (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
439
426
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);</pre>
440
427
<p>
441
 
Looks up an <span class="type">ESource</span> in <em class="parameter"><code>server</code></em> by its unique identifier string.
 
428
Looks up an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> in <em class="parameter"><code>server</code></em> by its unique identifier string.
442
429
</p>
443
430
<p>
444
 
The returned <span class="type">ESource</span> is referenced for thread-safety and must be
 
431
The returned <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> is referenced for thread-safety and must be
445
432
unreferenced with <code class="function">g_object_unref()</code> when finished with it.
446
433
</p>
447
434
<div class="variablelist"><table border="0">
458
445
</tr>
459
446
<tr>
460
447
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
461
 
<td>an <span class="type">ESource</span>, or <code class="literal">NULL</code> if no match was found</td>
 
448
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>, or <code class="literal">NULL</code> if no match was found</td>
462
449
</tr>
463
450
</tbody>
464
451
</table></div>
521
508
</div>
522
509
<hr>
523
510
<div class="refsect2">
 
511
<a name="e-source-registry-server-ref-backend"></a><h3>e_source_registry_server_ref_backend ()</h3>
 
512
<pre class="programlisting"><a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="returnvalue">ECollectionBackend</span></a> * e_source_registry_server_ref_backend
 
513
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
514
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
515
<p>
 
516
Returns the <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> associated with <em class="parameter"><code>source</code></em>, or <code class="literal">NULL</code> if
 
517
there is no <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> associated with <em class="parameter"><code>source</code></em>.
 
518
</p>
 
519
<p>
 
520
An <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> is associated with an <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> if the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> has
 
521
an <span class="type">ESourceCollection</span> extension, or if it is a hierarchical descendant of
 
522
another <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> which has an <span class="type">ESourceCollection</span> extension.
 
523
</p>
 
524
<p>
 
525
The returned <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> is referenced for thread-safety.
 
526
Unreference the <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> with <code class="function">g_object_unref()</code> when finished
 
527
with it.
 
528
</p>
 
529
<div class="variablelist"><table border="0">
 
530
<col align="left" valign="top">
 
531
<tbody>
 
532
<tr>
 
533
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
 
534
<td>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>
 
535
</td>
 
536
</tr>
 
537
<tr>
 
538
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
539
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>
 
540
</td>
 
541
</tr>
 
542
<tr>
 
543
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
544
<td>the <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> for <em class="parameter"><code>source</code></em>, or <code class="literal">NULL</code>
 
545
</td>
 
546
</tr>
 
547
</tbody>
 
548
</table></div>
 
549
<p class="since">Since 3.6</p>
 
550
</div>
 
551
<hr>
 
552
<div class="refsect2">
524
553
<a name="e-source-registry-server-ref-backend-factory"></a><h3>e_source_registry_server_ref_backend_factory ()</h3>
525
554
<pre class="programlisting"><a class="link" href="ECollectionBackendFactory.html" title="ECollectionBackendFactory"><span class="returnvalue">ECollectionBackendFactory</span></a> * e_source_registry_server_ref_backend_factory
526
555
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
527
 
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);</pre>
 
556
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);</pre>
528
557
<p>
529
558
Returns the <a class="link" href="ECollectionBackendFactory.html" title="ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a> for <em class="parameter"><code>source</code></em>, if available.
530
559
If <em class="parameter"><code>source</code></em> does not have an <span class="type">ESourceCollection</span> extension, or if the
547
576
</tr>
548
577
<tr>
549
578
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
550
 
<td>an <span class="type">ESource</span>
 
579
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>
551
580
</td>
552
581
</tr>
553
582
<tr>
559
588
</table></div>
560
589
<p class="since">Since 3.6</p>
561
590
</div>
 
591
<hr>
 
592
<div class="refsect2">
 
593
<a name="e-source-registry-server-authenticate-sync"></a><h3>e_source_registry_server_authenticate_sync ()</h3>
 
594
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_registry_server_authenticate_sync
 
595
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
596
                                                         <em class="parameter"><code><a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>,
 
597
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
598
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
599
<p>
 
600
Queues the <em class="parameter"><code>session</code></em> behind any ongoing or pending authentication
 
601
sessions for the same data source, and eventually executes <em class="parameter"><code>session</code></em>
 
602
(see <a class="link" href="EAuthenticationSession.html#e-authentication-session-execute-sync" title="e_authentication_session_execute_sync ()"><code class="function">e_authentication_session_execute_sync()</code></a> for more details).
 
603
</p>
 
604
<p>
 
605
This function blocks until <em class="parameter"><code>session</code></em> is finished executing.  For a
 
606
non-blocking variation see <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()"><code class="function">e_source_registry_server_authenticate()</code></a>.
 
607
</p>
 
608
<p>
 
609
If an error occurs, the function sets <em class="parameter"><code>error</code></em> and returns <code class="literal">FALSE</code>.
 
610
</p>
 
611
<div class="variablelist"><table border="0">
 
612
<col align="left" valign="top">
 
613
<tbody>
 
614
<tr>
 
615
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
 
616
<td>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>
 
617
</td>
 
618
</tr>
 
619
<tr>
 
620
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
 
621
<td>an <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a>
 
622
</td>
 
623
</tr>
 
624
<tr>
 
625
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
626
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
 
627
</td>
 
628
</tr>
 
629
<tr>
 
630
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
631
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
632
</td>
 
633
</tr>
 
634
<tr>
 
635
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
636
<td>
 
637
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
 
638
</tr>
 
639
</tbody>
 
640
</table></div>
 
641
<p class="since">Since 3.6</p>
 
642
</div>
 
643
<hr>
 
644
<div class="refsect2">
 
645
<a name="e-source-registry-server-authenticate"></a><h3>e_source_registry_server_authenticate ()</h3>
 
646
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_registry_server_authenticate
 
647
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
648
                                                         <em class="parameter"><code><a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>,
 
649
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
650
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
651
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
652
<p>
 
653
Queues the <em class="parameter"><code>session</code></em> behind any ongoing or pending authentication
 
654
sessions for the same data source, and eventually executes <em class="parameter"><code>session</code></em>
 
655
(see <a class="link" href="EAuthenticationSession.html#e-authentication-session-execute-sync" title="e_authentication_session_execute_sync ()"><code class="function">e_authentication_session_execute_sync()</code></a> for more details).
 
656
</p>
 
657
<p>
 
658
This function returns immediately after enqueuing <em class="parameter"><code>session</code></em>.  When
 
659
<em class="parameter"><code>session</code></em> is finished executing, <em class="parameter"><code>callback</code></em> will be called.  You can
 
660
then call <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate-finish" title="e_source_registry_server_authenticate_finish ()"><code class="function">e_source_registry_server_authenticate_finish()</code></a> to get the
 
661
result of the operation.
 
662
</p>
 
663
<div class="variablelist"><table border="0">
 
664
<col align="left" valign="top">
 
665
<tbody>
 
666
<tr>
 
667
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
 
668
<td>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>
 
669
</td>
 
670
</tr>
 
671
<tr>
 
672
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
 
673
<td>an <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a>
 
674
</td>
 
675
</tr>
 
676
<tr>
 
677
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
678
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
 
679
</td>
 
680
</tr>
 
681
<tr>
 
682
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
683
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
 
684
</tr>
 
685
<tr>
 
686
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
687
<td>data to pass to the callback function</td>
 
688
</tr>
 
689
</tbody>
 
690
</table></div>
 
691
<p class="since">Since 3.6</p>
 
692
</div>
 
693
<hr>
 
694
<div class="refsect2">
 
695
<a name="e-source-registry-server-authenticate-finish"></a><h3>e_source_registry_server_authenticate_finish ()</h3>
 
696
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_registry_server_authenticate_finish
 
697
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
698
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
699
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
700
<p>
 
701
Finishes the operation started with <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()"><code class="function">e_source_registry_server_authenticate()</code></a>.
 
702
If an error occurred, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
703
</p>
 
704
<div class="variablelist"><table border="0">
 
705
<col align="left" valign="top">
 
706
<tbody>
 
707
<tr>
 
708
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
 
709
<td>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>
 
710
</td>
 
711
</tr>
 
712
<tr>
 
713
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
714
<td>a <span class="type">GAsyncResult</span>
 
715
</td>
 
716
</tr>
 
717
<tr>
 
718
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
719
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
720
</td>
 
721
</tr>
 
722
<tr>
 
723
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
724
<td>
 
725
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
 
726
</tr>
 
727
</tbody>
 
728
</table></div>
 
729
<p class="since">Since 3.6</p>
 
730
</div>
562
731
</div>
563
732
<div class="refsect1">
564
733
<a name="ESourceRegistryServer.signal-details"></a><h2>Signal Details</h2>