evolution-data-server-doc 3.10.4-0ubuntu1.6 / usr / share / gtk-doc / html / libebackend / EBackend.html

This file is indexed.

/usr/share/gtk-doc/html/libebackend/EBackend.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.

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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Backend Utilities (libebackend): EBackend</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Base Classes for Backends">
<link rel="prev" href="ch01.html" title="Base Classes for Backends">
<link rel="next" href="EBackendFactory.html" title="EBackendFactory">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#EBackend.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#EBackend.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
                  <a href="#EBackend.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EBackendFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EBackend.top_of_page"></a>EBackend</span></h2>
<p>EBackend — An abstract base class for backends</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EBackend.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-get-online" title="e_backend_get_online ()">e_backend_get_online</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-set-online" title="e_backend_set_online ()">e_backend_set_online</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ESource</span> *
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-get-source" title="e_backend_get_source ()">e_backend_get_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="returnvalue">GSocketConnectable</span></a> *
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-ref-connectable" title="e_backend_ref_connectable ()">e_backend_ref_connectable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-set-connectable" title="e_backend_set_connectable ()">e_backend_set_connectable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="returnvalue">GMainContext</span></a> *
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-ref-main-context" title="e_backend_ref_main_context ()">e_backend_ref_main_context</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-authenticate-sync" title="e_backend_authenticate_sync ()">e_backend_authenticate_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-authenticate" title="e_backend_authenticate ()">e_backend_authenticate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-authenticate-finish" title="e_backend_authenticate_finish ()">e_backend_authenticate_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="EUserPrompter.html" title="EUserPrompter"><span class="returnvalue">_EUserPrompter</span></a> *
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-get-user-prompter" title="e_backend_get_user_prompter ()">e_backend_get_user_prompter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ETrustPromptResponse</span>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-trust-prompt-sync" title="e_backend_trust_prompt_sync ()">e_backend_trust_prompt_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-trust-prompt" title="e_backend_trust_prompt ()">e_backend_trust_prompt</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ETrustPromptResponse</span>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-trust-prompt-finish" title="e_backend_trust_prompt_finish ()">e_backend_trust_prompt_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-get-destination-address" title="e_backend_get_destination_address ()">e_backend_get_destination_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EBackend.html#e-backend-is-destination-reachable" title="e_backend_is_destination_reachable ()">e_backend_is_destination_reachable</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EBackend.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="type">GSocketConnectable</span></a> *</td>
<td class="property_name"><a class="link" href="EBackend.html#EBackend--connectable" title="The “connectable” property">connectable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</td>
<td class="property_name"><a class="link" href="EBackend.html#EBackend--main-context" title="The “main-context” property">main-context</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EBackend.html#EBackend--online" title="The “online” property">online</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">ESource</span> *</td>
<td class="property_name"><a class="link" href="EBackend.html#EBackend--source" title="The “source” property">source</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="EUserPrompter.html" title="EUserPrompter"><span class="type">EUserPrompter</span></a> *</td>
<td class="property_name"><a class="link" href="EBackend.html#EBackend--user-prompter" title="The “user-prompter” property">user-prompter</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EBackend.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EBackend.html#EBackend-struct" title="struct EBackend">EBackend</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> EBackend
        <span class="lineart">╰──</span> <a class="link" href="ECollectionBackend.html" title="ECollectionBackend">ECollectionBackend</a>
</pre>
</div>
<div class="refsect1">
<a name="EBackend.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libebackend/libebackend.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="EBackend.description"></a><h2>Description</h2>
<p>An <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> is paired with an <span class="type">ESource</span> to facilitate performing
actions on the local or remote resource described by the <span class="type">ESource</span>.</p>
<p>In other words, whereas a certain backend type knows how to talk to a
certain type of server or data store, the <span class="type">ESource</span> fills in configuration
details such as host name, user name, resource path, etc.</p>
<p>All <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instances are created by an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a>.</p>
</div>
<div class="refsect1">
<a name="EBackend.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-backend-get-online"></a><h3>e_backend_get_online ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_backend_get_online (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>Returns the online state of <em class="parameter"><code>backend</code></em>
: <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>backend</code></em>
 is online,
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if offline.</p>
<p>If the <a class="link" href="EBackend.html#EBackend--connectable" title="The “connectable” property"><span class="type">“connectable”</span></a> property is non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <em class="parameter"><code>backend</code></em>
 will
automatically determine whether the network service should be reachable,
and hence whether the <em class="parameter"><code>backend</code></em>
 is <a class="link" href="EBackend.html#EBackend--online" title="The “online” property"><span class="type">“online”</span></a>.  But subclasses may
override the online state if, for example, a connection attempt fails.</p>
<div class="refsect3">
<a name="id-1.2.2.9.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.2.7"></a><h4>Returns</h4>
<p> the online state</p>
<p></p>
</div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-set-online"></a><h3>e_backend_set_online ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_backend_set_online (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                      <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> online</code></em>);</pre>
<p>Sets the online state of <em class="parameter"><code>backend</code></em>
: <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>backend</code></em>
 is online,
<em class="parameter"><code>FALSE</code></em>
 if offline.</p>
<p>If the <a class="link" href="EBackend.html#EBackend--connectable" title="The “connectable” property"><span class="type">“connectable”</span></a> property is non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <em class="parameter"><code>backend</code></em>
 will
automatically determine whether the network service should be reachable,
and hence whether the <em class="parameter"><code>backend</code></em>
 is <a class="link" href="EBackend.html#EBackend--online" title="The “online” property"><span class="type">“online”</span></a>.  But subclasses may
override the online state if, for example, a connection attempt fails.</p>
<div class="refsect3">
<a name="id-1.2.2.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>online</p></td>
<td class="parameter_description"><p>the online state</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-get-source"></a><h3>e_backend_get_source ()</h3>
<pre class="programlisting"><span class="returnvalue">ESource</span> *
e_backend_get_source (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>Returns the <span class="type">ESource</span> to which <em class="parameter"><code>backend</code></em>
 is paired.</p>
<div class="refsect3">
<a name="id-1.2.2.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.4.6"></a><h4>Returns</h4>
<p> the <span class="type">ESource</span> to which <em class="parameter"><code>backend</code></em>
is paired</p>
<p></p>
</div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-ref-connectable"></a><h3>e_backend_ref_connectable ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="returnvalue">GSocketConnectable</span></a> *
e_backend_ref_connectable (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>Returns the socket endpoint for the network service to which <em class="parameter"><code>backend</code></em>

is a client, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>backend</code></em>
 does not use network sockets.</p>
<p>The initial value of the <a class="link" href="EBackend.html#EBackend--connectable" title="The “connectable” property"><span class="type">“connectable”</span></a> property is derived from
the <span class="type">ESourceAuthentication</span> extension of the <em class="parameter"><code>backend</code></em>
's <a class="link" href="EBackend.html#EBackend--source" title="The “source” property"><span class="type">“source”</span></a>
property, if the extension is present.</p>
<p>The returned <a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="type">GSocketConnectable</span></a> is referenced for thread-safety and
must be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="id-1.2.2.9.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.5.8"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="type">GSocketConnectable</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-set-connectable"></a><h3>e_backend_set_connectable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_backend_set_connectable (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="type">GSocketConnectable</span></a> *connectable</code></em>);</pre>
<p>Sets the socket endpoint for the network service to which <em class="parameter"><code>backend</code></em>
 is
a client.  This can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>backend</code></em>
 does not use network sockets.</p>
<p>The initial value of the <a class="link" href="EBackend.html#EBackend--connectable" title="The “connectable” property"><span class="type">“connectable”</span></a> property is derived from
the <span class="type">ESourceAuthentication</span> extension of the <em class="parameter"><code>backend</code></em>
's <a class="link" href="EBackend.html#EBackend--source" title="The “source” property"><span class="type">“source”</span></a>
property, if the extension is present.</p>
<div class="refsect3">
<a name="id-1.2.2.9.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connectable</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="type">GSocketConnectable</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-ref-main-context"></a><h3>e_backend_ref_main_context ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="returnvalue">GMainContext</span></a> *
e_backend_ref_main_context (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> on which event sources for <em class="parameter"><code>backend</code></em>
 are to
be attached.</p>
<p>The returned <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> is referenced for thread-safety and must be
unreferenced with <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#g-main-context-unref"><code class="function">g_main_context_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="id-1.2.2.9.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.7.7"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-authenticate-sync"></a><h3>e_backend_authenticate_sync ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_backend_authenticate_sync (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                             <em class="parameter"><code><span class="type">ESourceAuthenticator</span> *auth</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Convenience function providing a consistent authentication interface
for backends running in either the registry service itself or a client
process communicating with the registry service over D-Bus.</p>
<p>Authenticates <em class="parameter"><code>backend</code></em>
's <a class="link" href="EBackend.html#EBackend--source" title="The “source” property"><span class="type">“source”</span></a>, using <em class="parameter"><code>auth</code></em>
 to handle
authentication attempts.  The <em class="parameter"><code>backend</code></em>
 and <em class="parameter"><code>auth</code></em>
 arguments may be one
and the same if <em class="parameter"><code>backend</code></em>
 implements the <span class="type">ESourceAuthenticator</span> interface.
The operation loops until authentication is successful or the user aborts
further authentication attempts.  If an error occurs, the function will
set <em class="parameter"><code>error</code></em>
 and return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>auth</p></td>
<td class="parameter_description"><p>an <span class="type">ESourceAuthenticator</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.8.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-authenticate"></a><h3>e_backend_authenticate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_backend_authenticate (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                        <em class="parameter"><code><span class="type">ESourceAuthenticator</span> *auth</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Convenience function providing a consistent authentication interface
for backends running in either the registry service itself or a client
process communicating with the registry service over D-Bus.</p>
<p>Asynchronously authenticates <em class="parameter"><code>backend</code></em>
's <a class="link" href="EBackend.html#EBackend--source" title="The “source” property"><span class="type">“source”</span></a>, using <em class="parameter"><code>auth</code></em>

to handle authentication attempts.  The <em class="parameter"><code>backend</code></em>
 and <em class="parameter"><code>auth</code></em>
 arguments may
be one and the same if <em class="parameter"><code>backend</code></em>
 implements the <span class="type">ESourceAuthenticator</span>
interface.  The operation loops until authentication is succesful or the
user aborts further authentication attempts.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called.  You can then
call <a class="link" href="EBackend.html#e-backend-authenticate-finish" title="e_backend_authenticate_finish ()"><code class="function">e_backend_authenticate_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="id-1.2.2.9.9.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>auth</p></td>
<td class="parameter_description"><p>an <span class="type">ESourceAuthenticator</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-authenticate-finish"></a><h3>e_backend_authenticate_finish ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_backend_authenticate_finish (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes the operation started with <a class="link" href="EBackend.html#e-backend-authenticate" title="e_backend_authenticate ()"><code class="function">e_backend_authenticate()</code></a>.  If
an error occurred, the function will set <em class="parameter"><code>error</code></em>
 and return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.10.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-get-user-prompter"></a><h3>e_backend_get_user_prompter ()</h3>
<pre class="programlisting">struct <a class="link" href="EUserPrompter.html" title="EUserPrompter"><span class="returnvalue">_EUserPrompter</span></a> *
e_backend_get_user_prompter (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>Gets an instance of <a class="link" href="EUserPrompter.html" title="EUserPrompter"><span class="type">EUserPrompter</span></a>, associated with this <em class="parameter"><code>backend</code></em>
.
The instance is owned by the <em class="parameter"><code>backend</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.2.9.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.11.6"></a><h4>Returns</h4>
<p> an <a class="link" href="EUserPrompter.html" title="EUserPrompter"><span class="type">EUserPrompter</span></a> instance. </p>
<p><span class="annotation">[transfer-none]</span></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-trust-prompt-sync"></a><h3>e_backend_trust_prompt_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">ETrustPromptResponse</span>
e_backend_trust_prompt_sync (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                             <em class="parameter"><code>const <span class="type">ENamedParameters</span> *parameters</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Asks a user a trust prompt with given <em class="parameter"><code>parameters</code></em>
, and returns what
user responded. This blocks until the response is delivered.</p>
<div class="refsect3">
<a name="id-1.2.2.9.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parameters</p></td>
<td class="parameter_description"><p>an <span class="type">ENamedParameters</span> with values for the trust prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.12.6"></a><h4>Returns</h4>
<p> an <span class="type">ETrustPromptResponse</span> what user responded</p>
<p>Note: The function can return also <code class="literal">E_TRUST_PROMPT_RESPONSE_UNKNOWN</code>,
it's on error or if user closes the trust prompt dialog with other
than the offered buttons. Usual behaviour in such case is to treat
it as a temporary reject.</p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-trust-prompt"></a><h3>e_backend_trust_prompt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_backend_trust_prompt (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                        <em class="parameter"><code>const <span class="type">ENamedParameters</span> *parameters</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Initiates a user trust prompt with given <em class="parameter"><code>parameters</code></em>
.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then
call <a class="link" href="EBackend.html#e-backend-trust-prompt-finish" title="e_backend_trust_prompt_finish ()"><code class="function">e_backend_trust_prompt_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="id-1.2.2.9.13.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parameters</p></td>
<td class="parameter_description"><p>an <span class="type">ENamedParameters</span> with values for the trust prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-trust-prompt-finish"></a><h3>e_backend_trust_prompt_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">ETrustPromptResponse</span>
e_backend_trust_prompt_finish (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes the operation started with <a class="link" href="EBackend.html#e-backend-trust-prompt" title="e_backend_trust_prompt ()"><code class="function">e_backend_trust_prompt()</code></a>.
If an error occurred, the function will set <em class="parameter"><code>error</code></em>
 and return
<code class="literal">E_TRUST_PROMPT_RESPONSE_UNKNOWN</code>.</p>
<div class="refsect3">
<a name="id-1.2.2.9.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.14.6"></a><h4>Returns</h4>
<p> an <span class="type">ETrustPromptResponse</span> what user responded</p>
<p>Note: The function can return also <code class="literal">E_TRUST_PROMPT_RESPONSE_UNKNOWN</code>,
it's on error or if user closes the trust prompt dialog with other
than the offered buttons. Usual behaviour in such case is to treat
it as a temporary reject.</p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-get-destination-address"></a><h3>e_backend_get_destination_address ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_backend_get_destination_address (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                                   <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **host</code></em>,
                                   <em class="parameter"><code><span class="type">guint16</span> *port</code></em>);</pre>
<p>Provides destination server host name and port to which
the backend connects. This is used to determine required
connection point for <code class="function">e_backend_destination_is_reachable()</code>.
The <em class="parameter"><code>host</code></em>
 is a newly allocated string, which will be freed
with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. When <em class="parameter"><code>backend</code></em>
 sets both <em class="parameter"><code>host</code></em>
 and <em class="parameter"><code>port</code></em>
, then
it should return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, indicating it's a remote backend.
Default implementation returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, which is treated
like the backend is local, no checking for server reachability
is possible.</p>
<div class="refsect3">
<a name="id-1.2.2.9.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>host</p></td>
<td class="parameter_description"><p> destination server host name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p> destination server port. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.15.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, when it's a remote backend and provides both
<em class="parameter"><code>host</code></em>
and <em class="parameter"><code>port</code></em>
; <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-is-destination-reachable"></a><h3>e_backend_is_destination_reachable ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_backend_is_destination_reachable (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>,
                                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Checks whether the <em class="parameter"><code>backend</code></em>
's destination server, as returned
by <a class="link" href="EBackend.html#e-backend-get-destination-address" title="e_backend_get_destination_address ()"><code class="function">e_backend_get_destination_address()</code></a>, is reachable.
If the <a class="link" href="EBackend.html#e-backend-get-destination-address" title="e_backend_get_destination_address ()"><code class="function">e_backend_get_destination_address()</code></a> returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, this function
returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, meaning the destination is always reachable.
This uses <a href="/usr/share/gtk-doc/html/gio/GNetworkMonitor.html"><span class="type">GNetworkMonitor</span></a>'s <a href="/usr/share/gtk-doc/html/gio/GNetworkMonitor.html#g-network-monitor-can-reach"><code class="function">g_network_monitor_can_reach()</code></a>
for reachability tests.</p>
<div class="refsect3">
<a name="id-1.2.2.9.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> instance, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.16.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, when destination server address is reachable or
the backend doesn't provide destination address; <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if
the backend destination server cannot be reached currently.</p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
</div>
<div class="refsect1">
<a name="EBackend.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EBackend-struct"></a><h3>struct EBackend</h3>
<pre class="programlisting">struct EBackend;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since 3.4</p>
</div>
</div>
<div class="refsect1">
<a name="EBackend.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EBackend--connectable"></a><h3>The <code class="literal">“connectable”</code> property</h3>
<pre class="programlisting">  “connectable”              <a href="/usr/share/gtk-doc/html/gio/GSocketConnectable.html"><span class="type">GSocketConnectable</span></a> *</pre>
<p>Socket endpoint of a network service.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="EBackend--main-context"></a><h3>The <code class="literal">“main-context”</code> property</h3>
<pre class="programlisting">  “main-context”             <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</pre>
<p>The main loop context on which to attach event sources.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="EBackend--online"></a><h3>The <code class="literal">“online”</code> property</h3>
<pre class="programlisting">  “online”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the backend is online.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EBackend--source"></a><h3>The <code class="literal">“source”</code> property</h3>
<pre class="programlisting">  “source”                   <span class="type">ESource</span> *</pre>
<p>The data source being acted upon.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="EBackend--user-prompter"></a><h3>The <code class="literal">“user-prompter”</code> property</h3>
<pre class="programlisting">  “user-prompter”            <a class="link" href="EUserPrompter.html" title="EUserPrompter"><span class="type">EUserPrompter</span></a> *</pre>
<p>User prompter instance.</p>
<p>Flags: Read</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.