~cyphermox/ubuntu/quantal/evolution-data-server/autopkgtests

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/CamelOfflineFolder.html

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-09-19 12:15:29 UTC
  • mfrom: (1.1.93 upstream)
  • Revision ID: package-import@ubuntu.com-20110919121529-nsmfnges77ec7hux
Tags: 3.1.92-0ubuntu1
* New upstream release.
  - Cannot add more than one appointment per session (LP: #852277)
  - Contacts calendar backend doesn't show events (LP: #853905)
  - Set X-Evolution-Source header consistently (LP: #660626)

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelOfflineFolder</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Folders.html" title="Folders">
9
9
<link rel="prev" href="camel-camel-folder-thread.html" title="camel-folder-thread">
10
10
<link rel="next" href="CamelOfflineJournal.html" title="CamelOfflineJournal">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
42
42
<div class="refsynopsisdiv">
43
43
<a name="CamelOfflineFolder.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">struct              <a class="link" href="CamelOfflineFolder.html#CamelOfflineFolder-struct" title="struct CamelOfflineFolder">CamelOfflineFolder</a>;
45
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-get-offline-sync" title="camel_offline_folder_get_offline_sync ()">camel_offline_folder_get_offline_sync</a>
 
45
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-get-offline-sync" title="camel_offline_folder_get_offline_sync ()">camel_offline_folder_get_offline_sync</a>
46
46
                                                        (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>);
47
47
<span class="returnvalue">void</span>                <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-set-offline-sync" title="camel_offline_folder_set_offline_sync ()">camel_offline_folder_set_offline_sync</a>
48
48
                                                        (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> offline_sync</code></em>);
50
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-sync" title="camel_offline_folder_downsync_sync ()">camel_offline_folder_downsync_sync</a>  (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
51
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *expression</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
53
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
49
                                                         <em class="parameter"><code><span class="type">gboolean</span> offline_sync</code></em>);
 
50
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-sync" title="camel_offline_folder_downsync_sync ()">camel_offline_folder_downsync_sync</a>  (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
 
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
54
54
<span class="returnvalue">void</span>                <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync" title="camel_offline_folder_downsync ()">camel_offline_folder_downsync</a>       (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
55
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *expression</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> io_priority</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
59
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
60
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-finish" title="camel_offline_folder_downsync_finish ()">camel_offline_folder_downsync_finish</a>
 
55
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
 
56
                                                         <em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
59
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
60
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-finish" title="camel_offline_folder_downsync_finish ()">camel_offline_folder_downsync_finish</a>
61
61
                                                        (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
63
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
62
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
63
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
64
64
</pre>
65
65
</div>
66
66
<div class="refsect1">
67
67
<a name="CamelOfflineFolder.object-hierarchy"></a><h2>Object Hierarchy</h2>
68
68
<pre class="synopsis">
69
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
69
  GObject
70
70
   +----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
71
71
         +----<a class="link" href="CamelFolder.html" title="CamelFolder">CamelFolder</a>
72
72
               +----CamelOfflineFolder
75
75
<div class="refsect1">
76
76
<a name="CamelOfflineFolder.properties"></a><h2>Properties</h2>
77
77
<pre class="synopsis">
78
 
  "<a class="link" href="CamelOfflineFolder.html#CamelOfflineFolder--offline-sync" title='The "offline-sync" property'>offline-sync</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
78
  "<a class="link" href="CamelOfflineFolder.html#CamelOfflineFolder--offline-sync" title='The "offline-sync" property'>offline-sync</a>"             <span class="type">gboolean</span>              : Read / Write
79
79
</pre>
80
80
</div>
81
81
<div class="refsect1">
94
94
<hr>
95
95
<div class="refsect2">
96
96
<a name="camel-offline-folder-get-offline-sync"></a><h3>camel_offline_folder_get_offline_sync ()</h3>
97
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            camel_offline_folder_get_offline_sync
 
97
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_offline_folder_get_offline_sync
98
98
                                                        (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>);</pre>
99
99
<div class="variablelist"><table border="0">
100
100
<col align="left" valign="top">
111
111
<a name="camel-offline-folder-set-offline-sync"></a><h3>camel_offline_folder_set_offline_sync ()</h3>
112
112
<pre class="programlisting"><span class="returnvalue">void</span>                camel_offline_folder_set_offline_sync
113
113
                                                        (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
114
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> offline_sync</code></em>);</pre>
 
114
                                                         <em class="parameter"><code><span class="type">gboolean</span> offline_sync</code></em>);</pre>
115
115
<div class="variablelist"><table border="0">
116
116
<col align="left" valign="top">
117
117
<tbody>
131
131
<hr>
132
132
<div class="refsect2">
133
133
<a name="camel-offline-folder-downsync-sync"></a><h3>camel_offline_folder_downsync_sync ()</h3>
134
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            camel_offline_folder_downsync_sync  (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
135
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *expression</code></em>,
136
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
137
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
134
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_offline_folder_downsync_sync  (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
 
135
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
 
136
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
137
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
138
138
<p>
139
139
Synchronizes messages in <em class="parameter"><code>folder</code></em> described by the search <em class="parameter"><code>expression</code></em> to
140
140
the local machine for offline availability.
150
150
<tr>
151
151
<td><p><span class="term"><em class="parameter"><code>expression</code></em> :</span></p></td>
152
152
<td>search expression describing which set of messages
153
 
to downsync (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for all)</td>
 
153
to downsync (<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for all)</td>
154
154
</tr>
155
155
<tr>
156
156
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
157
 
<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
157
<td>optional <span class="type">GCancellable</span> object, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
158
158
</td>
159
159
</tr>
160
160
<tr>
161
161
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
162
 
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
162
<td>return location for a <span class="type">GError</span>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
163
163
</td>
164
164
</tr>
165
165
<tr>
166
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
167
<td>
168
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</td>
 
168
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error</td>
169
169
</tr>
170
170
</tbody>
171
171
</table></div>
175
175
<div class="refsect2">
176
176
<a name="camel-offline-folder-downsync"></a><h3>camel_offline_folder_downsync ()</h3>
177
177
<pre class="programlisting"><span class="returnvalue">void</span>                camel_offline_folder_downsync       (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
178
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *expression</code></em>,
179
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> io_priority</code></em>,
180
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
181
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
182
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
178
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
 
179
                                                         <em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
 
180
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
181
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
182
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
183
183
<p>
184
184
Synchronizes messages in <em class="parameter"><code>folder</code></em> described by the search <em class="parameter"><code>expression</code></em> to
185
185
the local machine asynchronously for offline availability.
200
200
<tr>
201
201
<td><p><span class="term"><em class="parameter"><code>expression</code></em> :</span></p></td>
202
202
<td>search expression describing which set of messages
203
 
to downsync (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for all)</td>
 
203
to downsync (<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for all)</td>
204
204
</tr>
205
205
<tr>
206
206
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
208
208
</tr>
209
209
<tr>
210
210
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
211
 
<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <code class="literal">NULl</code>
 
211
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULl</code>
212
212
</td>
213
213
</tr>
214
214
<tr>
215
215
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
216
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</td>
 
216
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
217
217
</tr>
218
218
<tr>
219
219
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
226
226
<hr>
227
227
<div class="refsect2">
228
228
<a name="camel-offline-folder-downsync-finish"></a><h3>camel_offline_folder_downsync_finish ()</h3>
229
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            camel_offline_folder_downsync_finish
 
229
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_offline_folder_downsync_finish
230
230
                                                        (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
231
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
232
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
231
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
232
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
233
233
<p>
234
234
Finishes the operation started with <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync" title="camel_offline_folder_downsync ()"><code class="function">camel_offline_folder_downsync()</code></a>.
235
235
</p>
243
243
</tr>
244
244
<tr>
245
245
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
246
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
 
246
<td>a <span class="type">GAsyncResult</span>
247
247
</td>
248
248
</tr>
249
249
<tr>
250
250
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
251
 
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
251
<td>return location for a <span class="type">GError</span>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
252
252
</td>
253
253
</tr>
254
254
<tr>
255
255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
256
256
<td>
257
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</td>
 
257
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error</td>
258
258
</tr>
259
259
</tbody>
260
260
</table></div>
265
265
<a name="CamelOfflineFolder.property-details"></a><h2>Property Details</h2>
266
266
<div class="refsect2">
267
267
<a name="CamelOfflineFolder--offline-sync"></a><h3>The <code class="literal">"offline-sync"</code> property</h3>
268
 
<pre class="programlisting">  "offline-sync"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
268
<pre class="programlisting">  "offline-sync"             <span class="type">gboolean</span>              : Read / Write</pre>
269
269
<p>Copy folder content locally for offline operation.</p>
270
270
<p>Default value: FALSE</p>
271
271
</div>
273
273
</div>
274
274
<div class="footer">
275
275
<hr>
276
 
          Generated by GTK-Doc V1.17</div>
 
276
          Generated by GTK-Doc V1.18</div>
277
277
</body>
278
278
</html>
 
 
b'\\ No newline at end of file'