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

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/EClient.html

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
110
110
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
111
111
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
112
112
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
113
 
<span class="returnvalue">void</span>                <a class="link" href="EClient.html#e-client-remove" title="e_client_remove ()">e_client_remove</a>                     (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
114
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
115
 
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
116
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
117
 
<span class="returnvalue">gboolean</span>            <a class="link" href="EClient.html#e-client-remove-finish" title="e_client_remove_finish ()">e_client_remove_finish</a>              (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
118
 
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
119
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
120
 
<span class="returnvalue">gboolean</span>            <a class="link" href="EClient.html#e-client-remove-sync" title="e_client_remove_sync ()">e_client_remove_sync</a>                (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
121
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
122
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
123
113
<span class="returnvalue">void</span>                <a class="link" href="EClient.html#e-client-refresh" title="e_client_refresh ()">e_client_refresh</a>                    (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
124
114
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
125
115
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
159
149
                                                         <em class="parameter"><code><span class="type">guint</span> known_errors_count</code></em>,
160
150
                                                         <em class="parameter"><code><span class="type">GQuark</span> known_errors_domain</code></em>,
161
151
                                                         <em class="parameter"><code><span class="type">gboolean</span> fail_when_none_matched</code></em>);
 
152
<span class="returnvalue">void</span>                <a class="link" href="EClient.html#e-client-remove" title="e_client_remove ()">e_client_remove</a>                     (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
 
153
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
154
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
155
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
156
<span class="returnvalue">gboolean</span>            <a class="link" href="EClient.html#e-client-remove-finish" title="e_client_remove_finish ()">e_client_remove_finish</a>              (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
 
157
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
158
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
159
<span class="returnvalue">gboolean</span>            <a class="link" href="EClient.html#e-client-remove-sync" title="e_client_remove_sync ()">e_client_remove_sync</a>                (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
 
160
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
161
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
162
162
</pre>
163
163
</div>
164
164
<div class="refsect1">
987
987
</div>
988
988
<hr>
989
989
<div class="refsect2">
990
 
<a name="e-client-remove"></a><h3>e_client_remove ()</h3>
991
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_remove                     (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
992
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
993
 
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
994
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
995
 
<p>
996
 
Removes the backing data for this <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>. For example, with the file
997
 
backend this deletes the database file. You cannot get it back!
998
 
The call is finished by <a class="link" href="EClient.html#e-client-remove-finish" title="e_client_remove_finish ()"><code class="function">e_client_remove_finish()</code></a> from the <em class="parameter"><code>callback</code></em>.
999
 
</p>
1000
 
<div class="variablelist"><table border="0">
1001
 
<col align="left" valign="top">
1002
 
<tbody>
1003
 
<tr>
1004
 
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
1005
 
<td>an <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>
1006
 
</td>
1007
 
</tr>
1008
 
<tr>
1009
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
1010
 
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
1011
 
</td>
1012
 
</tr>
1013
 
<tr>
1014
 
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1015
 
<td>callback to call when a result is ready</td>
1016
 
</tr>
1017
 
<tr>
1018
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1019
 
<td>user data for the <em class="parameter"><code>callback</code></em>
1020
 
</td>
1021
 
</tr>
1022
 
</tbody>
1023
 
</table></div>
1024
 
<p class="since">Since 3.2</p>
1025
 
</div>
1026
 
<hr>
1027
 
<div class="refsect2">
1028
 
<a name="e-client-remove-finish"></a><h3>e_client_remove_finish ()</h3>
1029
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_remove_finish              (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
1030
 
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
1031
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1032
 
<p>
1033
 
Finishes previous call of <a class="link" href="EClient.html#e-client-remove" title="e_client_remove ()"><code class="function">e_client_remove()</code></a>.
1034
 
</p>
1035
 
<div class="variablelist"><table border="0">
1036
 
<col align="left" valign="top">
1037
 
<tbody>
1038
 
<tr>
1039
 
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
1040
 
<td>an <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>
1041
 
</td>
1042
 
</tr>
1043
 
<tr>
1044
 
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
1045
 
<td>a <span class="type">GAsyncResult</span>
1046
 
</td>
1047
 
</tr>
1048
 
<tr>
1049
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1050
 
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1051
 
</td>
1052
 
</tr>
1053
 
<tr>
1054
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1055
 
<td>
1056
 
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
1057
 
</tr>
1058
 
</tbody>
1059
 
</table></div>
1060
 
<p class="since">Since 3.2</p>
1061
 
</div>
1062
 
<hr>
1063
 
<div class="refsect2">
1064
 
<a name="e-client-remove-sync"></a><h3>e_client_remove_sync ()</h3>
1065
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_remove_sync                (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
1066
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
1067
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1068
 
<p>
1069
 
Removes the backing data for this <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>. For example, with the file
1070
 
backend this deletes the database file. You cannot get it back!
1071
 
</p>
1072
 
<div class="variablelist"><table border="0">
1073
 
<col align="left" valign="top">
1074
 
<tbody>
1075
 
<tr>
1076
 
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
1077
 
<td>an <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>
1078
 
</td>
1079
 
</tr>
1080
 
<tr>
1081
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
1082
 
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
1083
 
</td>
1084
 
</tr>
1085
 
<tr>
1086
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1087
 
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1088
 
</td>
1089
 
</tr>
1090
 
<tr>
1091
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1092
 
<td>
1093
 
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
1094
 
</tr>
1095
 
</tbody>
1096
 
</table></div>
1097
 
<p class="since">Since 3.2</p>
1098
 
</div>
1099
 
<hr>
1100
 
<div class="refsect2">
1101
990
<a name="e-client-refresh"></a><h3>e_client_refresh ()</h3>
1102
991
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_refresh                    (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
1103
992
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
1590
1479
</table></div>
1591
1480
<p class="since">Since 3.2</p>
1592
1481
</div>
 
1482
<hr>
 
1483
<div class="refsect2">
 
1484
<a name="e-client-remove"></a><h3>e_client_remove ()</h3>
 
1485
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_remove                     (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1486
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1487
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1488
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1489
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1490
<h3 class="title">Warning</h3>
 
1491
<p><code class="literal">e_client_remove</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="ESource.html#e-source-remove" title="e_source_remove ()"><code class="function">e_source_remove()</code></a> instead.</p>
 
1492
</div>
 
1493
<p>
 
1494
Removes the backing data for this <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>. For example, with the file
 
1495
backend this deletes the database file. You cannot get it back!
 
1496
The call is finished by <a class="link" href="EClient.html#e-client-remove-finish" title="e_client_remove_finish ()"><code class="function">e_client_remove_finish()</code></a> from the <em class="parameter"><code>callback</code></em>.
 
1497
</p>
 
1498
<div class="variablelist"><table border="0">
 
1499
<col align="left" valign="top">
 
1500
<tbody>
 
1501
<tr>
 
1502
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1503
<td>an <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>
 
1504
</td>
 
1505
</tr>
 
1506
<tr>
 
1507
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1508
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1509
</td>
 
1510
</tr>
 
1511
<tr>
 
1512
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1513
<td>callback to call when a result is ready</td>
 
1514
</tr>
 
1515
<tr>
 
1516
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1517
<td>user data for the <em class="parameter"><code>callback</code></em>
 
1518
</td>
 
1519
</tr>
 
1520
</tbody>
 
1521
</table></div>
 
1522
<p class="since">Since 3.2</p>
 
1523
</div>
 
1524
<hr>
 
1525
<div class="refsect2">
 
1526
<a name="e-client-remove-finish"></a><h3>e_client_remove_finish ()</h3>
 
1527
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_remove_finish              (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1528
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1529
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1530
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1531
<h3 class="title">Warning</h3>
 
1532
<p><code class="literal">e_client_remove_finish</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="ESource.html#e-source-remove-finish" title="e_source_remove_finish ()"><code class="function">e_source_remove_finish()</code></a> instead.</p>
 
1533
</div>
 
1534
<p>
 
1535
Finishes previous call of <a class="link" href="EClient.html#e-client-remove" title="e_client_remove ()"><code class="function">e_client_remove()</code></a>.
 
1536
</p>
 
1537
<div class="variablelist"><table border="0">
 
1538
<col align="left" valign="top">
 
1539
<tbody>
 
1540
<tr>
 
1541
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1542
<td>an <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>
 
1543
</td>
 
1544
</tr>
 
1545
<tr>
 
1546
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1547
<td>a <span class="type">GAsyncResult</span>
 
1548
</td>
 
1549
</tr>
 
1550
<tr>
 
1551
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1552
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1553
</td>
 
1554
</tr>
 
1555
<tr>
 
1556
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1557
<td>
 
1558
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1559
</tr>
 
1560
</tbody>
 
1561
</table></div>
 
1562
<p class="since">Since 3.2</p>
 
1563
</div>
 
1564
<hr>
 
1565
<div class="refsect2">
 
1566
<a name="e-client-remove-sync"></a><h3>e_client_remove_sync ()</h3>
 
1567
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_remove_sync                (<em class="parameter"><code><a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1568
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1569
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1570
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1571
<h3 class="title">Warning</h3>
 
1572
<p><code class="literal">e_client_remove_sync</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="ESource.html#e-source-remove-sync" title="e_source_remove_sync ()"><code class="function">e_source_remove_sync()</code></a> instead.</p>
 
1573
</div>
 
1574
<p>
 
1575
Removes the backing data for this <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>. For example, with the file
 
1576
backend this deletes the database file. You cannot get it back!
 
1577
</p>
 
1578
<div class="variablelist"><table border="0">
 
1579
<col align="left" valign="top">
 
1580
<tbody>
 
1581
<tr>
 
1582
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1583
<td>an <a class="link" href="EClient.html" title="EClient"><span class="type">EClient</span></a>
 
1584
</td>
 
1585
</tr>
 
1586
<tr>
 
1587
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1588
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1589
</td>
 
1590
</tr>
 
1591
<tr>
 
1592
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1593
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1594
</td>
 
1595
</tr>
 
1596
<tr>
 
1597
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1598
<td>
 
1599
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1600
</tr>
 
1601
</tbody>
 
1602
</table></div>
 
1603
<p class="since">Since 3.2</p>
 
1604
</div>
1593
1605
</div>
1594
1606
<div class="refsect1">
1595
1607
<a name="EClient.property-details"></a><h2>Property Details</h2>