← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libedata-cal/html/ECalBackend.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/calendar/libedata-cal/html/ECalBackend.html
131
131
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
132
132
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
133
133
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *calobjs</code></em>,
134
 
                                                         <em class="parameter"><code><span class="type">CalObjModType</span> mod</code></em>);
 
134
                                                         <em class="parameter"><code><a href="../libecal/libecal-e-cal-util.html#CalObjModType"><span class="type">CalObjModType</span></a> mod</code></em>);
135
135
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-remove-objects" title="e_cal_backend_remove_objects ()">e_cal_backend_remove_objects</a>        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
136
136
                                                         <em class="parameter"><code><a class="link" href="EDataCal.html" title="EDataCal"><span class="type">EDataCal</span></a> *cal</code></em>,
137
137
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
138
138
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
139
139
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *ids</code></em>,
140
 
                                                         <em class="parameter"><code><span class="type">CalObjModType</span> mod</code></em>);
 
140
                                                         <em class="parameter"><code><a href="../libecal/libecal-e-cal-util.html#CalObjModType"><span class="type">CalObjModType</span></a> mod</code></em>);
141
141
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-receive-objects" title="e_cal_backend_receive_objects ()">e_cal_backend_receive_objects</a>       (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
142
142
                                                         <em class="parameter"><code><a class="link" href="EDataCal.html" title="EDataCal"><span class="type">EDataCal</span></a> *cal</code></em>,
143
143
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
179
179
                                                         <em class="parameter"><code><span class="type">EDataCalView</span> *view</code></em>);
180
180
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-component-created" title="e_cal_backend_notify_component_created ()">e_cal_backend_notify_component_created</a>
181
181
                                                        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
182
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *component</code></em>);
 
182
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *component</code></em>);
183
183
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-component-modified" title="e_cal_backend_notify_component_modified ()">e_cal_backend_notify_component_modified</a>
184
184
                                                        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
185
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *old_component</code></em>,
186
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *new_component</code></em>);
 
185
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *old_component</code></em>,
 
186
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *new_component</code></em>);
187
187
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-component-removed" title="e_cal_backend_notify_component_removed ()">e_cal_backend_notify_component_removed</a>
188
188
                                                        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
189
 
                                                         <em class="parameter"><code>const <span class="type">ECalComponentId</span> *id</code></em>,
190
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *old_component</code></em>,
191
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *new_component</code></em>);
 
189
                                                         <em class="parameter"><code>const <a href="../libecal/ECalComponent.html#ECalComponentId"><span class="type">ECalComponentId</span></a> *id</code></em>,
 
190
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *old_component</code></em>,
 
191
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *new_component</code></em>);
192
192
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-created" title="e_cal_backend_notify_object_created ()">e_cal_backend_notify_object_created</a> (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
193
193
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *calobj</code></em>);
194
194
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-objects-added" title="e_cal_backend_notify_objects_added ()">e_cal_backend_notify_objects_added</a>  (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
203
203
                                                         <em class="parameter"><code><span class="type">EDataCalView</span> *view</code></em>,
204
204
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *objects</code></em>);
205
205
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-removed" title="e_cal_backend_notify_object_removed ()">e_cal_backend_notify_object_removed</a> (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
206
 
                                                         <em class="parameter"><code>const <span class="type">ECalComponentId</span> *id</code></em>,
 
206
                                                         <em class="parameter"><code>const <a href="../libecal/ECalComponent.html#ECalComponentId"><span class="type">ECalComponentId</span></a> *id</code></em>,
207
207
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *old_object</code></em>,
208
208
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *new_object</code></em>);
209
209
<span class="returnvalue">void</span>                <a class="link" href="ECalBackend.html#e-cal-backend-notify-objects-removed" title="e_cal_backend_notify_objects_removed ()">e_cal_backend_notify_objects_removed</a>
236
236
<a name="ECalBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
237
237
<pre class="synopsis">
238
238
  GObject
239
 
   +----EBackend
 
239
   +----<a href="../libebackend/EBackend.html">EBackend</a>
240
240
         +----ECalBackend
241
241
               +----<a class="link" href="ECalBackendSync.html" title="ECalBackendSync">ECalBackendSync</a>
242
242
</pre>
387
387
<a name="e-cal-backend-get-registry"></a><h3>e_cal_backend_get_registry ()</h3>
388
388
<pre class="programlisting"><span class="returnvalue">ESourceRegistry</span> *   e_cal_backend_get_registry          (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>);</pre>
389
389
<p>
390
 
Returns the data source registry to which <span class="type">"source"</span> belongs.
 
390
Returns the data source registry to which <a href="../libebackend/EBackend.html#EBackend--source"><span class="type">"source"</span></a> belongs.
391
391
</p>
392
392
<div class="variablelist"><table border="0">
393
393
<col align="left" valign="top">
864
864
</p>
865
865
<p>
866
866
The <a class="link" href="ECalBackend.html#e-cal-backend-notify-opened" title="e_cal_backend_notify_opened ()"><code class="function">e_cal_backend_notify_opened()</code></a> is called either from this function
867
 
or from <code class="function">e_cal_backend_authenticate_user()</code>, or after necessary steps
 
867
or from <a href="ECalBackend.html#e-cal-backend-authenticate-user"><code class="function">e_cal_backend_authenticate_user()</code></a>, or after necessary steps
868
868
initiated by these two functions.
869
869
</p>
870
870
<p>
875
875
   with <a class="link" href="ECalBackend.html#e-cal-backend-notify-opened" title="e_cal_backend_notify_opened ()"><code class="function">e_cal_backend_notify_opened()</code></a> about that. This is usually
876
876
   for local backends; their opening phase is finished
877
877
4) or the backend requires authentication, thus it notifies client
878
 
   about that with <code class="function">e_cal_backend_notify_auth_required()</code> and is
 
878
   about that with <a href="ECalBackend.html#e-cal-backend-notify-auth-required"><code class="function">e_cal_backend_notify_auth_required()</code></a> and is
879
879
   waiting for credentials, which will be received from client
880
 
   by <code class="function">e_cal_backend_authenticate_user()</code> call. Backend's opening
 
880
   by <a href="ECalBackend.html#e-cal-backend-authenticate-user"><code class="function">e_cal_backend_authenticate_user()</code></a> call. Backend's opening
881
881
   phase is still running in this case, thus it doesn't call
882
882
   <a class="link" href="ECalBackend.html#e-cal-backend-notify-opened" title="e_cal_backend_notify_opened ()"><code class="function">e_cal_backend_notify_opened()</code></a> within <a class="link" href="ECalBackend.html#e-cal-backend-open" title="e_cal_backend_open ()"><code class="function">e_cal_backend_open()</code></a> call.
883
 
5) when backend receives credentials in <code class="function">e_cal_backend_authenticate_user()</code>
 
883
5) when backend receives credentials in <a href="ECalBackend.html#e-cal-backend-authenticate-user"><code class="function">e_cal_backend_authenticate_user()</code></a>
884
884
   then it tries to authenticate against a server/storage with them
885
885
   and only after it knows result of the authentication, whether user
886
886
   was or wasn't authenticated, it notifies client with the result
900
900
with <a class="link" href="EDataCal.html#e-data-cal-respond-open" title="e_data_cal_respond_open ()"><code class="function">e_data_cal_respond_open()</code></a>, which has no influence on the opening phase,
901
901
or alternatively with <a class="link" href="ECalBackend.html#e-cal-backend-respond-opened" title="e_cal_backend_respond_opened ()"><code class="function">e_cal_backend_respond_opened()</code></a>. Never use authentication
902
902
errors in <a class="link" href="EDataCal.html#e-data-cal-respond-open" title="e_data_cal_respond_open ()"><code class="function">e_data_cal_respond_open()</code></a> to notify the client the authentication is
903
 
required, there is <code class="function">e_cal_backend_notify_auth_required()</code> for this.
 
903
required, there is <a href="ECalBackend.html#e-cal-backend-notify-auth-required"><code class="function">e_cal_backend_notify_auth_required()</code></a> for this.
904
904
</p>
905
905
<div class="variablelist"><table border="0">
906
906
<col align="left" valign="top">
1183
1183
</tr>
1184
1184
</tbody>
1185
1185
</table></div>
 
1186
<p class="since">Since 3.6</p>
1186
1187
</div>
1187
1188
<hr>
1188
1189
<div class="refsect2">
1192
1193
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
1193
1194
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
1194
1195
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *calobjs</code></em>,
1195
 
                                                         <em class="parameter"><code><span class="type">CalObjModType</span> mod</code></em>);</pre>
 
1196
                                                         <em class="parameter"><code><a href="../libecal/libecal-e-cal-util.html#CalObjModType"><span class="type">CalObjModType</span></a> mod</code></em>);</pre>
1196
1197
<p>
1197
1198
Calls the modify_objects method on the given backend.
1198
1199
This might be finished with <a class="link" href="EDataCal.html#e-data-cal-respond-modify-objects" title="e_data_cal_respond_modify_objects ()"><code class="function">e_data_cal_respond_modify_objects()</code></a>.
1228
1229
</tr>
1229
1230
</tbody>
1230
1231
</table></div>
 
1232
<p class="since">Since 3.6</p>
1231
1233
</div>
1232
1234
<hr>
1233
1235
<div class="refsect2">
1237
1239
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
1238
1240
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
1239
1241
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *ids</code></em>,
1240
 
                                                         <em class="parameter"><code><span class="type">CalObjModType</span> mod</code></em>);</pre>
 
1242
                                                         <em class="parameter"><code><a href="../libecal/libecal-e-cal-util.html#CalObjModType"><span class="type">CalObjModType</span></a> mod</code></em>);</pre>
1241
1243
<p>
1242
1244
Removes objects in a calendar backend.  The backend will notify all of its
1243
1245
clients about the change.
1266
1268
</tr>
1267
1269
<tr>
1268
1270
<td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
1269
 
<td>List of <span class="type">ECalComponentId</span> objects identifying the objects to remove</td>
 
1271
<td>List of <a href="../libecal/ECalComponent.html#ECalComponentId"><span class="type">ECalComponentId</span></a> objects identifying the objects to remove</td>
1270
1272
</tr>
1271
1273
<tr>
1272
1274
<td><p><span class="term"><em class="parameter"><code>mod</code></em> :</span></p></td>
1274
1276
</tr>
1275
1277
</tbody>
1276
1278
</table></div>
 
1279
<p class="since">Since 3.6</p>
1277
1280
</div>
1278
1281
<hr>
1279
1282
<div class="refsect2">
1612
1615
<a name="e-cal-backend-notify-component-created"></a><h3>e_cal_backend_notify_component_created ()</h3>
1613
1616
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_backend_notify_component_created
1614
1617
                                                        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
1615
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *component</code></em>);</pre>
 
1618
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *component</code></em>);</pre>
1616
1619
<p>
1617
1620
Notifies each of the backend's listeners about a new object.
1618
1621
</p>
1619
1622
<p>
1620
 
Like <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-created" title="e_cal_backend_notify_object_created ()"><code class="function">e_cal_backend_notify_object_created()</code></a> except takes an <span class="type">ECalComponent</span>
 
1623
Like <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-created" title="e_cal_backend_notify_object_created ()"><code class="function">e_cal_backend_notify_object_created()</code></a> except takes an <a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a>
1621
1624
instead of an ical string representation and uses the <span class="type">EDataCalView</span>'s
1622
1625
fields-of-interest to filter out unwanted information from ical strings
1623
1626
sent over the bus.
1632
1635
</tr>
1633
1636
<tr>
1634
1637
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1635
 
<td>the newly created <span class="type">ECalComponent</span>
 
1638
<td>the newly created <a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a>
1636
1639
</td>
1637
1640
</tr>
1638
1641
</tbody>
1644
1647
<a name="e-cal-backend-notify-component-modified"></a><h3>e_cal_backend_notify_component_modified ()</h3>
1645
1648
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_backend_notify_component_modified
1646
1649
                                                        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
1647
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *old_component</code></em>,
1648
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *new_component</code></em>);</pre>
 
1650
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *old_component</code></em>,
 
1651
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *new_component</code></em>);</pre>
1649
1652
<p>
1650
1653
Notifies each of the backend's listeners about a modified object.
1651
1654
</p>
1652
1655
<p>
1653
 
Like <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-modified" title="e_cal_backend_notify_object_modified ()"><code class="function">e_cal_backend_notify_object_modified()</code></a> except takes an <span class="type">ECalComponent</span>
 
1656
Like <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-modified" title="e_cal_backend_notify_object_modified ()"><code class="function">e_cal_backend_notify_object_modified()</code></a> except takes an <a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a>
1654
1657
instead of an ical string representation and uses the <span class="type">EDataCalView</span>'s
1655
1658
fields-of-interest to filter out unwanted information from ical strings
1656
1659
sent over the bus.
1665
1668
</tr>
1666
1669
<tr>
1667
1670
<td><p><span class="term"><em class="parameter"><code>old_component</code></em> :</span></p></td>
1668
 
<td>the <span class="type">ECalComponent</span> before the modification</td>
 
1671
<td>the <a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> before the modification</td>
1669
1672
</tr>
1670
1673
<tr>
1671
1674
<td><p><span class="term"><em class="parameter"><code>new_component</code></em> :</span></p></td>
1672
 
<td>the <span class="type">ECalComponent</span> after the modification</td>
 
1675
<td>the <a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> after the modification</td>
1673
1676
</tr>
1674
1677
</tbody>
1675
1678
</table></div>
1680
1683
<a name="e-cal-backend-notify-component-removed"></a><h3>e_cal_backend_notify_component_removed ()</h3>
1681
1684
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_backend_notify_component_removed
1682
1685
                                                        (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
1683
 
                                                         <em class="parameter"><code>const <span class="type">ECalComponentId</span> *id</code></em>,
1684
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *old_component</code></em>,
1685
 
                                                         <em class="parameter"><code><span class="type">ECalComponent</span> *new_component</code></em>);</pre>
 
1686
                                                         <em class="parameter"><code>const <a href="../libecal/ECalComponent.html#ECalComponentId"><span class="type">ECalComponentId</span></a> *id</code></em>,
 
1687
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *old_component</code></em>,
 
1688
                                                         <em class="parameter"><code><a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a> *new_component</code></em>);</pre>
1686
1689
<p>
1687
1690
Notifies each of the backend's listeners about a removed object.
1688
1691
</p>
1689
1692
<p>
1690
 
Like <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-removed" title="e_cal_backend_notify_object_removed ()"><code class="function">e_cal_backend_notify_object_removed()</code></a> except takes an <span class="type">ECalComponent</span>
 
1693
Like <a class="link" href="ECalBackend.html#e-cal-backend-notify-object-removed" title="e_cal_backend_notify_object_removed ()"><code class="function">e_cal_backend_notify_object_removed()</code></a> except takes an <a href="../libecal/ECalComponent.html"><span class="type">ECalComponent</span></a>
1691
1694
instead of an ical string representation and uses the <span class="type">EDataCalView</span>'s
1692
1695
fields-of-interest to filter out unwanted information from ical strings
1693
1696
sent over the bus.
1817
1820
<div class="refsect2">
1818
1821
<a name="e-cal-backend-notify-object-removed"></a><h3>e_cal_backend_notify_object_removed ()</h3>
1819
1822
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_backend_notify_object_removed (<em class="parameter"><code><a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>,
1820
 
                                                         <em class="parameter"><code>const <span class="type">ECalComponentId</span> *id</code></em>,
 
1823
                                                         <em class="parameter"><code>const <a href="../libecal/ECalComponent.html#ECalComponentId"><span class="type">ECalComponentId</span></a> *id</code></em>,
1821
1824
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *old_object</code></em>,
1822
1825
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *new_object</code></em>);</pre>
1823
1826
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">