← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/ESource.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
https://launchpad.net/bugs/1038047
https://launchpad.net/bugs/1038047
* 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:
docs/reference/libedataserver/html/ESource.html
52
52
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-new" title="e_source_new ()">e_source_new</a>                        (<em class="parameter"><code><span class="type">GDBusObject</span> *dbus_object</code></em>,
53
53
                                                         <em class="parameter"><code><span class="type">GMainContext</span> *main_context</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
55
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-new-with-uid" title="e_source_new_with_uid ()">e_source_new_with_uid</a>               (<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
 
56
                                                         <em class="parameter"><code><span class="type">GMainContext</span> *main_context</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
55
58
<span class="returnvalue">guint</span>               <a class="link" href="ESource.html#e-source-hash" title="e_source_hash ()">e_source_hash</a>                       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
56
59
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-equal" title="e_source_equal ()">e_source_equal</a>                      (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source1</code></em>,
57
60
                                                         <em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source2</code></em>);
67
70
                                                         <em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>);
68
71
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-get-writable" title="e_source_get_writable ()">e_source_get_writable</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
69
72
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-get-removable" title="e_source_get_removable ()">e_source_get_removable</a>              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
73
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-get-remote-creatable" title="e_source_get_remote_creatable ()">e_source_get_remote_creatable</a>       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
74
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-get-remote-deletable" title="e_source_get_remote_deletable ()">e_source_get_remote_deletable</a>       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
70
75
<span class="returnvalue">gpointer</span>            <a class="link" href="ESource.html#e-source-get-extension" title="e_source_get_extension ()">e_source_get_extension</a>              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
71
76
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *extension_name</code></em>);
72
77
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-has-extension" title="e_source_has_extension ()">e_source_has_extension</a>              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
102
107
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-write-finish" title="e_source_write_finish ()">e_source_write_finish</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
103
108
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
104
109
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
110
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-remote-create-sync" title="e_source_remote_create_sync ()">e_source_remote_create_sync</a>         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
111
                                                         <em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *scratch_source</code></em>,
 
112
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
113
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
114
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-remote-create" title="e_source_remote_create ()">e_source_remote_create</a>              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
115
                                                         <em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *scratch_source</code></em>,
 
116
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
117
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
118
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
119
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-remote-create-finish" title="e_source_remote_create_finish ()">e_source_remote_create_finish</a>       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
120
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
121
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
122
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-remote-delete-sync" title="e_source_remote_delete_sync ()">e_source_remote_delete_sync</a>         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
123
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
124
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
125
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-remote-delete" title="e_source_remote_delete ()">e_source_remote_delete</a>              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
126
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
127
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
128
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
129
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-remote-delete-finish" title="e_source_remote_delete_finish ()">e_source_remote_delete_finish</a>       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
130
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
131
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
105
132
</pre>
106
133
</div>
107
134
<div class="refsect1">
120
147
<div class="refsect1">
121
148
<a name="ESource.properties"></a><h2>Properties</h2>
122
149
<pre class="synopsis">
123
 
  "<a class="link" href="ESource.html#ESource--dbus-object" title='The "dbus-object" property'>dbus-object</a>"              <a href="../libedbus-private/EDBusObject.html"><span class="type">EDBusObject</span></a>*          : Read / Write / Construct Only
 
150
  "<a class="link" href="ESource.html#ESource--dbus-object" title='The "dbus-object" property'>dbus-object</a>"              <span class="type">EDBusObject</span>*          : Read / Write / Construct Only
124
151
  "<a class="link" href="ESource.html#ESource--display-name" title='The "display-name" property'>display-name</a>"             <span class="type">gchar</span>*                : Read / Write / Construct
125
152
  "<a class="link" href="ESource.html#ESource--enabled" title='The "enabled" property'>enabled</a>"                  <span class="type">gboolean</span>              : Read / Write / Construct
126
153
  "<a class="link" href="ESource.html#ESource--main-context" title='The "main-context" property'>main-context</a>"             <span class="type">GMainContext</span>*         : Read / Write / Construct Only
127
154
  "<a class="link" href="ESource.html#ESource--parent" title='The "parent" property'>parent</a>"                   <span class="type">gchar</span>*                : Read / Write
 
155
  "<a class="link" href="ESource.html#ESource--remote-creatable" title='The "remote-creatable" property'>remote-creatable</a>"         <span class="type">gboolean</span>              : Read
 
156
  "<a class="link" href="ESource.html#ESource--remote-deletable" title='The "remote-deletable" property'>remote-deletable</a>"         <span class="type">gboolean</span>              : Read
128
157
  "<a class="link" href="ESource.html#ESource--removable" title='The "removable" property'>removable</a>"                <span class="type">gboolean</span>              : Read
129
 
  "<a class="link" href="ESource.html#ESource--uid" title='The "uid" property'>uid</a>"                      <span class="type">gchar</span>*                : Read
 
158
  "<a class="link" href="ESource.html#ESource--uid" title='The "uid" property'>uid</a>"                      <span class="type">gchar</span>*                : Read / Write / Construct Only
130
159
  "<a class="link" href="ESource.html#ESource--writable" title='The "writable" property'>writable</a>"                 <span class="type">gboolean</span>              : Read
131
160
</pre>
132
161
</div>
244
273
</div>
245
274
<hr>
246
275
<div class="refsect2">
 
276
<a name="e-source-new-with-uid"></a><h3>e_source_new_with_uid ()</h3>
 
277
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           e_source_new_with_uid               (<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
 
278
                                                         <em class="parameter"><code><span class="type">GMainContext</span> *main_context</code></em>,
 
279
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
280
<p>
 
281
Creates a new "scratch" <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> with a predetermined unique identifier.
 
282
</p>
 
283
<p>
 
284
The <a class="link" href="ESource.html#ESource-changed" title='The "changed" signal'><span class="type">"changed"</span></a> signal will be emitted from <em class="parameter"><code>main_context</code></em> if given,
 
285
or else from the thread-default <span class="type">GMainContext</span> at the time this function is
 
286
called.
 
287
</p>
 
288
<div class="variablelist"><table border="0">
 
289
<col align="left" valign="top">
 
290
<tbody>
 
291
<tr>
 
292
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
 
293
<td>a new unique identifier string</td>
 
294
</tr>
 
295
<tr>
 
296
<td><p><span class="term"><em class="parameter"><code>main_context</code></em> :</span></p></td>
 
297
<td>a <span class="type">GMainContext</span> or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
298
</td>
 
299
</tr>
 
300
<tr>
 
301
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
302
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
303
</td>
 
304
</tr>
 
305
<tr>
 
306
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
307
<td>a new scratch <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>, or <code class="literal">NULL</code> on error</td>
 
308
</tr>
 
309
</tbody>
 
310
</table></div>
 
311
<p class="since">Since 3.6</p>
 
312
</div>
 
313
<hr>
 
314
<div class="refsect2">
247
315
<a name="e-source-hash"></a><h3>e_source_hash ()</h3>
248
316
<pre class="programlisting"><span class="returnvalue">guint</span>               e_source_hash                       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
249
317
<p>
563
631
</div>
564
632
<hr>
565
633
<div class="refsect2">
 
634
<a name="e-source-get-remote-creatable"></a><h3>e_source_get_remote_creatable ()</h3>
 
635
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_get_remote_creatable       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
636
<p>
 
637
Returns whether new resources can be created on a remote server by
 
638
calling <a class="link" href="ESource.html#e-source-remote-create" title="e_source_remote_create ()"><code class="function">e_source_remote_create()</code></a> on <em class="parameter"><code>source</code></em>.
 
639
</p>
 
640
<p>
 
641
Generally this is only <code class="literal">TRUE</code> if <em class="parameter"><code>source</code></em> has an <a class="link" href="ESourceCollection.html" title="ESourceCollection"><span class="type">ESourceCollection</span></a>
 
642
extension, which means there is an <span class="type">ECollectionBackend</span> in the D-Bus
 
643
service that can handle create requests.  If <em class="parameter"><code>source</code></em> does not have
 
644
this capability, calls to <a class="link" href="ESource.html#e-source-remote-create" title="e_source_remote_create ()"><code class="function">e_source_remote_create()</code></a> will fail.
 
645
</p>
 
646
<div class="variablelist"><table border="0">
 
647
<col align="left" valign="top">
 
648
<tbody>
 
649
<tr>
 
650
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
651
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
652
</td>
 
653
</tr>
 
654
<tr>
 
655
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
656
<td>whether <em class="parameter"><code>source</code></em> can create remote resources</td>
 
657
</tr>
 
658
</tbody>
 
659
</table></div>
 
660
<p class="since">Since 3.6</p>
 
661
</div>
 
662
<hr>
 
663
<div class="refsect2">
 
664
<a name="e-source-get-remote-deletable"></a><h3>e_source_get_remote_deletable ()</h3>
 
665
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_get_remote_deletable       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
666
<p>
 
667
Returns whether the resource represented by <em class="parameter"><code>source</code></em> can be deleted
 
668
from a remote server by calling <a class="link" href="ESource.html#e-source-remote-delete" title="e_source_remote_delete ()"><code class="function">e_source_remote_delete()</code></a>.
 
669
</p>
 
670
<p>
 
671
Generally this is only <code class="literal">TRUE</code> if <em class="parameter"><code>source</code></em> is a child of an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
672
which has an <a class="link" href="ESourceCollection.html" title="ESourceCollection"><span class="type">ESourceCollection</span></a> extension, which means there is an
 
673
<span class="type">ECollectionBackend</span> in the D-Bus service that can handle delete
 
674
requests.  If <em class="parameter"><code>source</code></em> does not have this capability, calls to
 
675
<a class="link" href="ESource.html#e-source-remote-delete" title="e_source_remote_delete ()"><code class="function">e_source_remote_delete()</code></a> will fail.
 
676
</p>
 
677
<div class="variablelist"><table border="0">
 
678
<col align="left" valign="top">
 
679
<tbody>
 
680
<tr>
 
681
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
682
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
683
</td>
 
684
</tr>
 
685
<tr>
 
686
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
687
<td>whether <em class="parameter"><code>source</code></em> can delete remote resources</td>
 
688
</tr>
 
689
</tbody>
 
690
</table></div>
 
691
<p class="since">Since 3.6</p>
 
692
</div>
 
693
<hr>
 
694
<div class="refsect2">
566
695
<a name="e-source-get-extension"></a><h3>e_source_get_extension ()</h3>
567
696
<pre class="programlisting"><span class="returnvalue">gpointer</span>            e_source_get_extension              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
568
697
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *extension_name</code></em>);</pre>
865
994
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
866
995
<p>
867
996
Requests the D-Bus service to delete the key files for <em class="parameter"><code>source</code></em> and all of
868
 
its descendants and broadcast their removal to all clients.  If an error
869
 
occurs, the functon will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
997
its descendants and broadcast their removal to all clients.  The <em class="parameter"><code>source</code></em>
 
998
must be <a class="link" href="ESource.html#ESource--removable" title='The "removable" property'><span class="type">"removable"</span></a>.
 
999
</p>
 
1000
<p>
 
1001
If an error occurs, the functon will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
870
1002
</p>
871
1003
<div class="variablelist"><table border="0">
872
1004
<col align="left" valign="top">
903
1035
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
904
1036
<p>
905
1037
Asynchronously requests the D-Bus service to delete the key files for
906
 
<em class="parameter"><code>source</code></em> all of its descendants and broadcast their removal to all clients.
 
1038
<em class="parameter"><code>source</code></em> and all of its descendants and broadcast their removal to all
 
1039
clients.  The <em class="parameter"><code>source</code></em> must be <a class="link" href="ESource.html#ESource--removable" title='The "removable" property'><span class="type">"removable"</span></a>.
907
1040
</p>
908
1041
<p>
909
1042
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called.  You can then
944
1077
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
945
1078
<p>
946
1079
Finishes the operation started with <a class="link" href="ESource.html#e-source-remove" title="e_source_remove ()"><code class="function">e_source_remove()</code></a>.  If an
947
 
error occured, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
1080
error occurred, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
948
1081
</p>
949
1082
<div class="variablelist"><table border="0">
950
1083
<col align="left" valign="top">
980
1113
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
981
1114
<p>
982
1115
Submits the current contents of <em class="parameter"><code>source</code></em> to the D-Bus service to be
983
 
written to disk and broadcast to other clients.  This can only be
984
 
called on <a class="link" href="ESource.html#ESource--writable" title='The "writable" property'><span class="type">"writable"</span></a> data sources.
 
1116
written to disk and broadcast to other clients.  The <em class="parameter"><code>source</code></em> must
 
1117
be <a class="link" href="ESource.html#ESource--writable" title='The "writable" property'><span class="type">"writable"</span></a>.
 
1118
</p>
 
1119
<p>
 
1120
If an error occurs, the functon will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
985
1121
</p>
986
1122
<div class="variablelist"><table border="0">
987
1123
<col align="left" valign="top">
1019
1155
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
1020
1156
<p>
1021
1157
Asynchronously submits the current contents of <em class="parameter"><code>source</code></em> to the D-Bus
1022
 
service to be written to disk and broadcast to other clients.  This
1023
 
can only be called on <a class="link" href="ESource.html#ESource--writable" title='The "writable" property'><span class="type">"writable"</span></a> data sources.
 
1158
service to be written to disk and broadcast to other clients.  The
 
1159
<em class="parameter"><code>source</code></em> must be <a class="link" href="ESource.html#ESource--writable" title='The "writable" property'><span class="type">"writable"</span></a>.
1024
1160
</p>
1025
1161
<p>
1026
1162
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called.  You can then
1091
1227
</table></div>
1092
1228
<p class="since">Since 3.6</p>
1093
1229
</div>
 
1230
<hr>
 
1231
<div class="refsect2">
 
1232
<a name="e-source-remote-create-sync"></a><h3>e_source_remote_create_sync ()</h3>
 
1233
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_remote_create_sync         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
1234
                                                         <em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *scratch_source</code></em>,
 
1235
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1236
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1237
<p>
 
1238
Creates a new remote resource by picking out relevant details from
 
1239
<em class="parameter"><code>scratch_source</code></em>.  The <em class="parameter"><code>scratch_source</code></em> must be an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> with no
 
1240
<span class="type">GDBusObject</span>.  The <em class="parameter"><code>source</code></em> must be <a class="link" href="ESource.html#ESource--remote-creatable" title='The "remote-creatable" property'><span class="type">"remote-creatable"</span></a>.
 
1241
</p>
 
1242
<p>
 
1243
The details required to create the resource vary by <span class="type">ECollectionBackend</span>,
 
1244
but in most cases the <em class="parameter"><code>scratch_source</code></em> need only define the resource type
 
1245
(address book, calendar, etc.), a display name for the resource, and
 
1246
possibly a server-side path or ID for the resource.
 
1247
</p>
 
1248
<p>
 
1249
If an error occurs, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
1250
</p>
 
1251
<div class="variablelist"><table border="0">
 
1252
<col align="left" valign="top">
 
1253
<tbody>
 
1254
<tr>
 
1255
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
1256
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1257
</td>
 
1258
</tr>
 
1259
<tr>
 
1260
<td><p><span class="term"><em class="parameter"><code>scratch_source</code></em> :</span></p></td>
 
1261
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> describing the resource to create</td>
 
1262
</tr>
 
1263
<tr>
 
1264
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1265
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1266
</td>
 
1267
</tr>
 
1268
<tr>
 
1269
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1270
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
1271
</td>
 
1272
</tr>
 
1273
<tr>
 
1274
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1275
<td>
 
1276
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
 
1277
</tr>
 
1278
</tbody>
 
1279
</table></div>
 
1280
<p class="since">Since 3.6</p>
 
1281
</div>
 
1282
<hr>
 
1283
<div class="refsect2">
 
1284
<a name="e-source-remote-create"></a><h3>e_source_remote_create ()</h3>
 
1285
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_remote_create              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
1286
                                                         <em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *scratch_source</code></em>,
 
1287
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1288
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1289
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1290
<p>
 
1291
Asynchronously creates a new remote resource by picking out relevant
 
1292
details from <em class="parameter"><code>scratch_source</code></em>.  The <em class="parameter"><code>scratch_source</code></em> must be an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1293
with no <span class="type">GDBusObject</span>.  The <em class="parameter"><code>source</code></em> must be <a class="link" href="ESource.html#ESource--remote-creatable" title='The "remote-creatable" property'><span class="type">"remote-creatable"</span></a>.
 
1294
</p>
 
1295
<p>
 
1296
The details required to create the resource vary by <span class="type">ECollectionBackend</span>,
 
1297
but in most cases the <em class="parameter"><code>scratch_source</code></em> need only define the resource type
 
1298
(address book, calendar, etc.), a display name for the resource, and
 
1299
possibly a server-side path or ID for the resource.
 
1300
</p>
 
1301
<p>
 
1302
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called.  You can then
 
1303
call <code class="function">3_source_remote_create_finish()</code> to get the result of the operation.
 
1304
</p>
 
1305
<div class="variablelist"><table border="0">
 
1306
<col align="left" valign="top">
 
1307
<tbody>
 
1308
<tr>
 
1309
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
1310
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1311
</td>
 
1312
</tr>
 
1313
<tr>
 
1314
<td><p><span class="term"><em class="parameter"><code>scratch_source</code></em> :</span></p></td>
 
1315
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> describing the resource to create</td>
 
1316
</tr>
 
1317
<tr>
 
1318
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1319
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1320
</td>
 
1321
</tr>
 
1322
<tr>
 
1323
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1324
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request
 
1325
is satisfied. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span>
 
1326
</td>
 
1327
</tr>
 
1328
<tr>
 
1329
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1330
<td>data to pass to the callback function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
1331
</td>
 
1332
</tr>
 
1333
</tbody>
 
1334
</table></div>
 
1335
<p class="since">Since 3.6</p>
 
1336
</div>
 
1337
<hr>
 
1338
<div class="refsect2">
 
1339
<a name="e-source-remote-create-finish"></a><h3>e_source_remote_create_finish ()</h3>
 
1340
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_remote_create_finish       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
1341
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1342
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1343
<p>
 
1344
Finishes the operation started with <a class="link" href="ESource.html#e-source-remote-create" title="e_source_remote_create ()"><code class="function">e_source_remote_create()</code></a>.  If
 
1345
an error occurred, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
1346
</p>
 
1347
<div class="variablelist"><table border="0">
 
1348
<col align="left" valign="top">
 
1349
<tbody>
 
1350
<tr>
 
1351
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
1352
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1353
</td>
 
1354
</tr>
 
1355
<tr>
 
1356
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1357
<td>a <span class="type">GAsyncResult</span>
 
1358
</td>
 
1359
</tr>
 
1360
<tr>
 
1361
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1362
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
1363
</td>
 
1364
</tr>
 
1365
<tr>
 
1366
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1367
<td>
 
1368
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
 
1369
</tr>
 
1370
</tbody>
 
1371
</table></div>
 
1372
<p class="since">Since 3.6</p>
 
1373
</div>
 
1374
<hr>
 
1375
<div class="refsect2">
 
1376
<a name="e-source-remote-delete-sync"></a><h3>e_source_remote_delete_sync ()</h3>
 
1377
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_remote_delete_sync         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
1378
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1379
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1380
<p>
 
1381
Deletes the resource represented by <em class="parameter"><code>source</code></em> from a remote server.
 
1382
The <em class="parameter"><code>source</code></em> must be <a class="link" href="ESource.html#ESource--remote-deletable" title='The "remote-deletable" property'><span class="type">"remote-deletable"</span></a>.  This will also delete
 
1383
the key file for <em class="parameter"><code>source</code></em> and broadcast its removal to all clients,
 
1384
similar to <a class="link" href="ESource.html#e-source-remove-sync" title="e_source_remove_sync ()"><code class="function">e_source_remove_sync()</code></a>.
 
1385
</p>
 
1386
<p>
 
1387
If an error occurs, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
1388
</p>
 
1389
<div class="variablelist"><table border="0">
 
1390
<col align="left" valign="top">
 
1391
<tbody>
 
1392
<tr>
 
1393
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
1394
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1395
</td>
 
1396
</tr>
 
1397
<tr>
 
1398
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1399
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1400
</td>
 
1401
</tr>
 
1402
<tr>
 
1403
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1404
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
1405
</td>
 
1406
</tr>
 
1407
<tr>
 
1408
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1409
<td>
 
1410
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
 
1411
</tr>
 
1412
</tbody>
 
1413
</table></div>
 
1414
<p class="since">Since 3.6</p>
 
1415
</div>
 
1416
<hr>
 
1417
<div class="refsect2">
 
1418
<a name="e-source-remote-delete"></a><h3>e_source_remote_delete ()</h3>
 
1419
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_remote_delete              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
1420
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1421
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1422
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1423
<p>
 
1424
Asynchronously deletes the resource represented by <em class="parameter"><code>source</code></em> from a remote
 
1425
server.  The <em class="parameter"><code>source</code></em> must be <a class="link" href="ESource.html#ESource--remote-deletable" title='The "remote-deletable" property'><span class="type">"remote-deletable"</span></a>.  This will also
 
1426
delete the key file for <em class="parameter"><code>source</code></em> and broadcast its removal to all clients,
 
1427
similar to <a class="link" href="ESource.html#e-source-remove" title="e_source_remove ()"><code class="function">e_source_remove()</code></a>.
 
1428
</p>
 
1429
<p>
 
1430
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called.  You can then
 
1431
call <a class="link" href="ESource.html#e-source-remote-delete-finish" title="e_source_remote_delete_finish ()"><code class="function">e_source_remote_delete_finish()</code></a> to get the result of the operation.
 
1432
</p>
 
1433
<div class="variablelist"><table border="0">
 
1434
<col align="left" valign="top">
 
1435
<tbody>
 
1436
<tr>
 
1437
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
1438
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1439
</td>
 
1440
</tr>
 
1441
<tr>
 
1442
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1443
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1444
</td>
 
1445
</tr>
 
1446
<tr>
 
1447
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1448
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request
 
1449
is satisfied. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span>
 
1450
</td>
 
1451
</tr>
 
1452
<tr>
 
1453
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1454
<td>data to pass to the callback function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
1455
</td>
 
1456
</tr>
 
1457
</tbody>
 
1458
</table></div>
 
1459
<p class="since">Since 3.6</p>
 
1460
</div>
 
1461
<hr>
 
1462
<div class="refsect2">
 
1463
<a name="e-source-remote-delete-finish"></a><h3>e_source_remote_delete_finish ()</h3>
 
1464
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_remote_delete_finish       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
1465
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1466
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1467
<p>
 
1468
Finishes the operation started with <a class="link" href="ESource.html#e-source-remote-delete" title="e_source_remote_delete ()"><code class="function">e_source_remote_delete()</code></a>.  If
 
1469
an error occurred, the function will set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
 
1470
</p>
 
1471
<div class="variablelist"><table border="0">
 
1472
<col align="left" valign="top">
 
1473
<tbody>
 
1474
<tr>
 
1475
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
1476
<td>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
 
1477
</td>
 
1478
</tr>
 
1479
<tr>
 
1480
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1481
<td>a <span class="type">GAsyncResult</span>
 
1482
</td>
 
1483
</tr>
 
1484
<tr>
 
1485
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1486
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
1487
</td>
 
1488
</tr>
 
1489
<tr>
 
1490
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1491
<td>
 
1492
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
 
1493
</tr>
 
1494
</tbody>
 
1495
</table></div>
 
1496
<p class="since">Since 3.6</p>
 
1497
</div>
1094
1498
</div>
1095
1499
<div class="refsect1">
1096
1500
<a name="ESource.property-details"></a><h2>Property Details</h2>
1097
1501
<div class="refsect2">
1098
1502
<a name="ESource--dbus-object"></a><h3>The <code class="literal">"dbus-object"</code> property</h3>
1099
 
<pre class="programlisting">  "dbus-object"              <a href="../libedbus-private/EDBusObject.html"><span class="type">EDBusObject</span></a>*          : Read / Write / Construct Only</pre>
 
1503
<pre class="programlisting">  "dbus-object"              <span class="type">EDBusObject</span>*          : Read / Write / Construct Only</pre>
1100
1504
<p>The D-Bus object for the data source.</p>
1101
1505
</div>
1102
1506
<hr>
1128
1532
</div>
1129
1533
<hr>
1130
1534
<div class="refsect2">
 
1535
<a name="ESource--remote-creatable"></a><h3>The <code class="literal">"remote-creatable"</code> property</h3>
 
1536
<pre class="programlisting">  "remote-creatable"         <span class="type">gboolean</span>              : Read</pre>
 
1537
<p>Whether the data source can create remote resources.</p>
 
1538
<p>Default value: FALSE</p>
 
1539
</div>
 
1540
<hr>
 
1541
<div class="refsect2">
 
1542
<a name="ESource--remote-deletable"></a><h3>The <code class="literal">"remote-deletable"</code> property</h3>
 
1543
<pre class="programlisting">  "remote-deletable"         <span class="type">gboolean</span>              : Read</pre>
 
1544
<p>Whether the data source can delete remote resources.</p>
 
1545
<p>Default value: FALSE</p>
 
1546
</div>
 
1547
<hr>
 
1548
<div class="refsect2">
1131
1549
<a name="ESource--removable"></a><h3>The <code class="literal">"removable"</code> property</h3>
1132
1550
<pre class="programlisting">  "removable"                <span class="type">gboolean</span>              : Read</pre>
1133
1551
<p>Whether the data source is removable.</p>
1136
1554
<hr>
1137
1555
<div class="refsect2">
1138
1556
<a name="ESource--uid"></a><h3>The <code class="literal">"uid"</code> property</h3>
1139
 
<pre class="programlisting">  "uid"                      <span class="type">gchar</span>*                : Read</pre>
 
1557
<pre class="programlisting">  "uid"                      <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
1140
1558
<p>The unique identity of the data source.</p>
1141
1559
<p>Default value: NULL</p>
1142
1560
</div>