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

« back to all changes in this revision

Viewing changes to docs/reference/eds/html/eds-ESourceRegistryServer.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2015-07-20 13:34:59 UTC
  • mfrom: (1.1.126) (1.2.48 sid)
  • Revision ID: package-import@ubuntu.com-20150720133459-g6y46hnu5ewtoz08
Tags: 3.16.4-0ubuntu2
debian/patches/0001-Bug-752373-Monthly-events-do-not-recur-correctly.patch:
Cherry-pick patch from upstream to fix events not recurring correctly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>Evolution-Data-Server Reference Manual: ESourceRegistryServer</title>
 
5
<title>ESourceRegistryServer: Evolution-Data-Server Reference Manual</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
8
8
<link rel="up" href="ch07.html" title="Registry Service Classes">
9
9
<link rel="prev" href="eds-EServerSideSource.html" title="EServerSideSource">
10
10
<link rel="next" href="ch08.html" title="Addressbook Backend Classes">
11
 
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.23 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
137
137
</tr>
138
138
<tr>
139
139
<td class="function_type">
140
 
<a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="returnvalue">EAuthenticationSession</span></a> *
141
 
</td>
142
 
<td class="function_name">
143
 
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-new-auth-session" title="e_source_registry_server_new_auth_session ()">e_source_registry_server_new_auth_session</a> <span class="c_punctuation">()</span>
144
 
</td>
145
 
</tr>
146
 
<tr>
147
 
<td class="function_type">
148
 
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
149
 
</td>
150
 
<td class="function_name">
151
 
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-authenticate-sync" title="e_source_registry_server_authenticate_sync ()">e_source_registry_server_authenticate_sync</a> <span class="c_punctuation">()</span>
152
 
</td>
153
 
</tr>
154
 
<tr>
155
 
<td class="function_type">
156
 
<span class="returnvalue">void</span>
157
 
</td>
158
 
<td class="function_name">
159
 
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()">e_source_registry_server_authenticate</a> <span class="c_punctuation">()</span>
160
 
</td>
161
 
</tr>
162
 
<tr>
163
 
<td class="function_type">
164
 
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
165
 
</td>
166
 
<td class="function_name">
167
 
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-authenticate-finish" title="e_source_registry_server_authenticate_finish ()">e_source_registry_server_authenticate_finish</a> <span class="c_punctuation">()</span>
168
 
</td>
169
 
</tr>
170
 
<tr>
171
 
<td class="function_type">
172
140
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
173
141
</td>
174
142
<td class="function_name">
215
183
<p>The <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> is the heart of the registry D-Bus service.
216
184
Acting as a global singleton store for all <a class="link" href="eds-EServerSideSource.html#EServerSideSource" title="struct EServerSideSource"><span class="type">EServerSideSource</span></a> instances,
217
185
its responsibilities include loading data source content from key files,
218
 
exporting data sources to clients over D-Bus, handling authentication
219
 
and content change requests from clients, and saving content changes
220
 
back to key files.</p>
 
186
exporting data sources to clients over D-Bus, handling content change
 
187
requests from clients, and saving content changes back to key files.</p>
221
188
<p>It also hosts any number of built-in or 3rd party data source collection
222
189
backends, which coordinate with <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> to automatically
223
190
advertise available data sources on a remote server.</p>
232
199
<div class="refsect3">
233
200
<a name="id-1.4.3.8.7.2.5"></a><h4>Returns</h4>
234
201
<p> a new instance of <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p>
235
 
<p></p>
236
202
</div>
237
 
<p class="since">Since 3.6</p>
 
203
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
238
204
</div>
239
205
<hr>
240
206
<div class="refsect2">
267
233
</tbody>
268
234
</table></div>
269
235
</div>
270
 
<p class="since">Since 3.6</p>
 
236
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
271
237
</div>
272
238
<hr>
273
239
<div class="refsect2">
301
267
</tbody>
302
268
</table></div>
303
269
</div>
304
 
<p class="since">Since 3.6</p>
 
270
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
305
271
</div>
306
272
<hr>
307
273
<div class="refsect2">
362
328
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>path</code></em>
363
329
was successfully opened, but this
364
330
does not imply the key files were successfully loaded</p>
365
 
<p></p>
366
331
</div>
367
 
<p class="since">Since 3.6</p>
 
332
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
368
333
</div>
369
334
<hr>
370
335
<div class="refsect2">
372
337
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
373
338
e_source_registry_server_load_resource
374
339
                               (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
375
 
                                <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/gio-GResource.html#GResource"><span class="type">GResource</span></a> *resource</code></em>,
 
340
                                <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GResource.html"><span class="type">GResource</span></a> *resource</code></em>,
376
341
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
377
342
                                <em class="parameter"><code><span class="type">ESourcePermissionFlags</span> flags</code></em>,
378
343
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
401
366
</tr>
402
367
<tr>
403
368
<td class="parameter_name"><p>resource</p></td>
404
 
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/gio-GResource.html#GResource"><span class="type">GResource</span></a> containing data source key files</p></td>
 
369
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GResource.html"><span class="type">GResource</span></a> containing data source key files</p></td>
405
370
<td class="parameter_annotations"> </td>
406
371
</tr>
407
372
<tr>
429
394
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>path</code></em>
430
395
was successfully located, but this does not
431
396
imply the key files were successfully loaded</p>
432
 
<p></p>
433
397
</div>
434
 
<p class="since">Since 3.8</p>
 
398
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
435
399
</div>
436
400
<hr>
437
401
<div class="refsect2">
482
446
<div class="refsect3">
483
447
<a name="id-1.4.3.8.7.7.7"></a><h4>Returns</h4>
484
448
<p> the newly-added <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error</p>
485
 
<p></p>
486
449
</div>
487
 
<p class="since">Since 3.6</p>
 
450
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
488
451
</div>
489
452
<hr>
490
453
<div class="refsect2">
521
484
</tbody>
522
485
</table></div>
523
486
</div>
524
 
<p class="since">Since 3.6</p>
 
487
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
525
488
</div>
526
489
<hr>
527
490
<div class="refsect2">
558
521
<div class="refsect3">
559
522
<a name="id-1.4.3.8.7.9.7"></a><h4>Returns</h4>
560
523
<p> an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found</p>
561
 
<p></p>
562
524
</div>
563
 
<p class="since">Since 3.6</p>
 
525
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
564
526
</div>
565
527
<hr>
566
528
<div class="refsect2">
613
575
<div class="refsect3">
614
576
<a name="id-1.4.3.8.7.10.10"></a><h4>Returns</h4>
615
577
<p> a sorted list of sources</p>
616
 
<p></p>
617
578
</div>
618
 
<p class="since">Since 3.6</p>
 
579
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
619
580
</div>
620
581
<hr>
621
582
<div class="refsect2">
674
635
<div class="refsect3">
675
636
<a name="id-1.4.3.8.7.11.10"></a><h4>Returns</h4>
676
637
<p> an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found</p>
677
 
<p></p>
678
638
</div>
679
 
<p class="since">Since 3.8</p>
 
639
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
680
640
</div>
681
641
<hr>
682
642
<div class="refsect2">
720
680
<a name="id-1.4.3.8.7.12.8"></a><h4>Returns</h4>
721
681
<p> the <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> for <em class="parameter"><code>source</code></em>
722
682
, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
723
 
<p></p>
724
683
</div>
725
 
<p class="since">Since 3.6</p>
 
684
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
726
685
</div>
727
686
<hr>
728
687
<div class="refsect2">
767
726
<a name="id-1.4.3.8.7.13.7"></a><h4>Returns</h4>
768
727
<p> the <a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a> for <em class="parameter"><code>source</code></em>
769
728
, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
770
 
<p></p>
771
 
</div>
772
 
<p class="since">Since 3.6</p>
773
 
</div>
774
 
<hr>
775
 
<div class="refsect2">
776
 
<a name="e-source-registry-server-new-auth-session"></a><h3>e_source_registry_server_new_auth_session ()</h3>
777
 
<pre class="programlisting"><a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="returnvalue">EAuthenticationSession</span></a> *
778
 
e_source_registry_server_new_auth_session
779
 
                               (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
780
 
                                <em class="parameter"><code><span class="type">ESourceAuthenticator</span> *authenticator</code></em>,
781
 
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_uid</code></em>);</pre>
782
 
<p>Convenience function instantiates an appropriate authentication
783
 
session type for <em class="parameter"><code>source_uid</code></em>
784
 
.</p>
785
 
<p>If <em class="parameter"><code>server</code></em>
786
 
 has an <a class="link" href="eds-EServerSideSource.html#EServerSideSource" title="struct EServerSideSource"><span class="type">EServerSideSource</span></a> instance for <em class="parameter"><code>source_uid</code></em>
787
 
, then
788
 
its <span class="type">“auth-session-type”</span> is used to instantiate a new
789
 
authentication session.  Otherwise a plain <a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> is
790
 
instantiated.</p>
791
 
<p>Unreference the returned <a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> with <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
792
 
when finished with it.</p>
793
 
<div class="refsect3">
794
 
<a name="id-1.4.3.8.7.14.7"></a><h4>Parameters</h4>
795
 
<div class="informaltable"><table width="100%" border="0">
796
 
<colgroup>
797
 
<col width="150px" class="parameters_name">
798
 
<col class="parameters_description">
799
 
<col width="200px" class="parameters_annotations">
800
 
</colgroup>
801
 
<tbody>
802
 
<tr>
803
 
<td class="parameter_name"><p>server</p></td>
804
 
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
805
 
<td class="parameter_annotations"> </td>
806
 
</tr>
807
 
<tr>
808
 
<td class="parameter_name"><p>authenticator</p></td>
809
 
<td class="parameter_description"><p>an <span class="type">ESourceAuthenticator</span></p></td>
810
 
<td class="parameter_annotations"> </td>
811
 
</tr>
812
 
<tr>
813
 
<td class="parameter_name"><p>source_uid</p></td>
814
 
<td class="parameter_description"><p>a data source identifier</p></td>
815
 
<td class="parameter_annotations"> </td>
816
 
</tr>
817
 
</tbody>
818
 
</table></div>
819
 
</div>
820
 
<div class="refsect3">
821
 
<a name="id-1.4.3.8.7.14.8"></a><h4>Returns</h4>
822
 
<p> a new <a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> for <em class="parameter"><code>source_uid</code></em>
823
 
</p>
824
 
<p></p>
825
 
</div>
826
 
<p class="since">Since 3.8</p>
827
 
</div>
828
 
<hr>
829
 
<div class="refsect2">
830
 
<a name="e-source-registry-server-authenticate-sync"></a><h3>e_source_registry_server_authenticate_sync ()</h3>
831
 
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
832
 
e_source_registry_server_authenticate_sync
833
 
                               (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
834
 
                                <em class="parameter"><code><a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>,
835
 
                                <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
836
 
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
837
 
<p>Queues the <em class="parameter"><code>session</code></em>
838
 
 behind any ongoing or pending authentication
839
 
sessions for the same data source, and eventually executes <em class="parameter"><code>session</code></em>
840
 
 
841
 
(see <a class="link" href="eds-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).</p>
842
 
<p>This function blocks until <em class="parameter"><code>session</code></em>
843
 
 is finished executing.  For a
844
 
non-blocking variation see <a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()"><code class="function">e_source_registry_server_authenticate()</code></a>.</p>
845
 
<p>If an error occurs, the function sets <em class="parameter"><code>error</code></em>
846
 
 and returns <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
847
 
<div class="refsect3">
848
 
<a name="id-1.4.3.8.7.15.7"></a><h4>Parameters</h4>
849
 
<div class="informaltable"><table width="100%" border="0">
850
 
<colgroup>
851
 
<col width="150px" class="parameters_name">
852
 
<col class="parameters_description">
853
 
<col width="200px" class="parameters_annotations">
854
 
</colgroup>
855
 
<tbody>
856
 
<tr>
857
 
<td class="parameter_name"><p>server</p></td>
858
 
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
859
 
<td class="parameter_annotations"> </td>
860
 
</tr>
861
 
<tr>
862
 
<td class="parameter_name"><p>session</p></td>
863
 
<td class="parameter_description"><p>an <a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a></p></td>
864
 
<td class="parameter_annotations"> </td>
865
 
</tr>
866
 
<tr>
867
 
<td class="parameter_name"><p>cancellable</p></td>
868
 
<td class="parameter_description"><p>optional <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
869
 
<td class="parameter_annotations"> </td>
870
 
</tr>
871
 
<tr>
872
 
<td class="parameter_name"><p>error</p></td>
873
 
<td class="parameter_description"><p>return location for a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
874
 
<td class="parameter_annotations"> </td>
875
 
</tr>
876
 
</tbody>
877
 
</table></div>
878
 
</div>
879
 
<div class="refsect3">
880
 
<a name="id-1.4.3.8.7.15.8"></a><h4>Returns</h4>
881
 
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
882
 
<p></p>
883
 
</div>
884
 
<p class="since">Since 3.6</p>
885
 
</div>
886
 
<hr>
887
 
<div class="refsect2">
888
 
<a name="e-source-registry-server-authenticate"></a><h3>e_source_registry_server_authenticate ()</h3>
889
 
<pre class="programlisting"><span class="returnvalue">void</span>
890
 
e_source_registry_server_authenticate (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
891
 
                                       <em class="parameter"><code><a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> *session</code></em>,
892
 
                                       <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
893
 
                                       <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
894
 
                                       <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
895
 
<p>Queues the <em class="parameter"><code>session</code></em>
896
 
 behind any ongoing or pending authentication
897
 
sessions for the same data source, and eventually executes <em class="parameter"><code>session</code></em>
898
 
 
899
 
(see <a class="link" href="eds-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).</p>
900
 
<p>This function returns immediately after enqueuing <em class="parameter"><code>session</code></em>
901
 
.  When
902
 
<em class="parameter"><code>session</code></em>
903
 
 is finished executing, <em class="parameter"><code>callback</code></em>
904
 
 will be called.  You can
905
 
then call <a class="link" href="eds-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
906
 
result of the operation.</p>
907
 
<div class="refsect3">
908
 
<a name="id-1.4.3.8.7.16.6"></a><h4>Parameters</h4>
909
 
<div class="informaltable"><table width="100%" border="0">
910
 
<colgroup>
911
 
<col width="150px" class="parameters_name">
912
 
<col class="parameters_description">
913
 
<col width="200px" class="parameters_annotations">
914
 
</colgroup>
915
 
<tbody>
916
 
<tr>
917
 
<td class="parameter_name"><p>server</p></td>
918
 
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
919
 
<td class="parameter_annotations"> </td>
920
 
</tr>
921
 
<tr>
922
 
<td class="parameter_name"><p>session</p></td>
923
 
<td class="parameter_description"><p>an <a class="link" href="eds-EAuthenticationSession.html#EAuthenticationSession" title="struct EAuthenticationSession"><span class="type">EAuthenticationSession</span></a></p></td>
924
 
<td class="parameter_annotations"> </td>
925
 
</tr>
926
 
<tr>
927
 
<td class="parameter_name"><p>cancellable</p></td>
928
 
<td class="parameter_description"><p>optional <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
929
 
<td class="parameter_annotations"> </td>
930
 
</tr>
931
 
<tr>
932
 
<td class="parameter_name"><p>callback</p></td>
933
 
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</p></td>
934
 
<td class="parameter_annotations"> </td>
935
 
</tr>
936
 
<tr>
937
 
<td class="parameter_name"><p>user_data</p></td>
938
 
<td class="parameter_description"><p>data to pass to the callback function</p></td>
939
 
<td class="parameter_annotations"> </td>
940
 
</tr>
941
 
</tbody>
942
 
</table></div>
943
 
</div>
944
 
<p class="since">Since 3.6</p>
945
 
</div>
946
 
<hr>
947
 
<div class="refsect2">
948
 
<a name="e-source-registry-server-authenticate-finish"></a><h3>e_source_registry_server_authenticate_finish ()</h3>
949
 
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
950
 
e_source_registry_server_authenticate_finish
951
 
                               (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
952
 
                                <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
953
 
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
954
 
<p>Finishes the operation started with <a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()"><code class="function">e_source_registry_server_authenticate()</code></a>.
955
 
If an error occurred, the function will set <em class="parameter"><code>error</code></em>
956
 
 and return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
957
 
<div class="refsect3">
958
 
<a name="id-1.4.3.8.7.17.5"></a><h4>Parameters</h4>
959
 
<div class="informaltable"><table width="100%" border="0">
960
 
<colgroup>
961
 
<col width="150px" class="parameters_name">
962
 
<col class="parameters_description">
963
 
<col width="200px" class="parameters_annotations">
964
 
</colgroup>
965
 
<tbody>
966
 
<tr>
967
 
<td class="parameter_name"><p>server</p></td>
968
 
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
969
 
<td class="parameter_annotations"> </td>
970
 
</tr>
971
 
<tr>
972
 
<td class="parameter_name"><p>result</p></td>
973
 
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
974
 
<td class="parameter_annotations"> </td>
975
 
</tr>
976
 
<tr>
977
 
<td class="parameter_name"><p>error</p></td>
978
 
<td class="parameter_description"><p>return location for a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
979
 
<td class="parameter_annotations"> </td>
980
 
</tr>
981
 
</tbody>
982
 
</table></div>
983
 
</div>
984
 
<div class="refsect3">
985
 
<a name="id-1.4.3.8.7.17.6"></a><h4>Returns</h4>
986
 
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
987
 
<p></p>
988
 
</div>
989
 
<p class="since">Since 3.6</p>
 
729
</div>
 
730
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
990
731
</div>
991
732
<hr>
992
733
<div class="refsect2">
1007
748
file fails to load, the error is broadcast through the
1008
749
<span class="type">“load-error”</span> signal.</p>
1009
750
<div class="refsect3">
1010
 
<a name="id-1.4.3.8.7.18.7"></a><h4>Parameters</h4>
 
751
<a name="id-1.4.3.8.7.14.7"></a><h4>Parameters</h4>
1011
752
<div class="informaltable"><table width="100%" border="0">
1012
753
<colgroup>
1013
754
<col width="150px" class="parameters_name">
1029
770
</table></div>
1030
771
</div>
1031
772
<div class="refsect3">
1032
 
<a name="id-1.4.3.8.7.18.8"></a><h4>Returns</h4>
 
773
<a name="id-1.4.3.8.7.14.8"></a><h4>Returns</h4>
1033
774
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the standard directories were successfully opened,
1034
775
but this does not imply the key files were successfully loaded</p>
1035
 
<p></p>
1036
776
</div>
1037
 
<p class="since">Since 3.6</p>
 
777
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
1038
778
</div>
1039
779
</div>
1040
780
<div class="refsect1">
1043
783
<a name="E-SOURCE-REGISTRY-SERVER-OBJECT-PATH:CAPS"></a><h3>E_SOURCE_REGISTRY_SERVER_OBJECT_PATH</h3>
1044
784
<pre class="programlisting">#define             E_SOURCE_REGISTRY_SERVER_OBJECT_PATH</pre>
1045
785
<p>D-Bus object path of the data source server.</p>
1046
 
<p class="since">Since 3.6</p>
 
786
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
1047
787
</div>
1048
788
<hr>
1049
789
<div class="refsect2">
1063
803
</pre>
1064
804
<p>Contains only private data that should be read and manipulated using the
1065
805
functions below.</p>
1066
 
<p class="since">Since 3.6</p>
 
806
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
1067
807
</div>
1068
808
<hr>
1069
809
<div class="refsect2">
1092
832
</div>
1093
833
</div>
1094
834
<div class="footer">
1095
 
<hr>
1096
 
          Generated by GTK-Doc V1.21</div>
 
835
<hr>Generated by GTK-Doc V1.23</div>
1097
836
</body>
1098
837
</html>
 
 
b'\\ No newline at end of file'