22
22
<th width="100%" align="center">Evolution API Reference: libedata-book, the Addressbook backend library</th>
23
23
<td><a accesskey="n" href="EBookBackendSync.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
25
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2558049" class="shortcut">Top</a>
27
<a href="#id2564734" class="shortcut">Description</a>
29
<a href="#id2564710" class="shortcut">Object Hierarchy</a></nobr></td></tr>
25
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2613858" class="shortcut">Top</a>
27
<a href="#id2620557" class="shortcut">Description</a>
29
<a href="#id2620533" class="shortcut">Object Hierarchy</a></nobr></td></tr>
31
31
<div class="refentry" lang="en">
32
32
<a name="EBookBackendSummary"></a><div class="titlepage"></div>
33
33
<div class="refnamediv"><table width="100%"><tr>
36
<a name="id2558049"></a><span class="refentrytitle">EBookBackendSummary</span>
36
<a name="id2613858"></a><span class="refentrytitle">EBookBackendSummary</span>
38
38
<p>EBookBackendSummary</p>
48
struct <a href="EBookBackendSummary.html#EBookBackendSummary-struct">EBookBackendSummary</a>;
49
<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* <a href="EBookBackendSummary.html#e-book-backend-summary-new">e_book_backend_summary_new</a> (const char *summary_path,
48
struct <a class="link" href="EBookBackendSummary.html#EBookBackendSummary-struct">EBookBackendSummary</a>;
49
<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-new">e_book_backend_summary_new</a> (const char *summary_path,
50
50
int flush_timeout_millis);
52
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
53
>gboolean</a> <a href="EBookBackendSummary.html#e-book-backend-summary-load">e_book_backend_summary_load</a> (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
55
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
56
>gboolean</a> <a href="EBookBackendSummary.html#e-book-backend-summary-save">e_book_backend_summary_save</a> (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
57
void <a href="EBookBackendSummary.html#e-book-backend-summary-add-contact">e_book_backend_summary_add_contact</a> (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
51
gboolean <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-load">e_book_backend_summary_load</a> (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
52
gboolean <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-save">e_book_backend_summary_save</a> (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
53
void <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-add-contact">e_book_backend_summary_add_contact</a> (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
58
54
EContact *contact);
59
void <a href="EBookBackendSummary.html#e-book-backend-summary-remove-contact">e_book_backend_summary_remove_contact</a>
60
(<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
63
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
64
>gboolean</a> <a href="EBookBackendSummary.html#e-book-backend-summary-check-contact">e_book_backend_summary_check_contact</a>
65
(<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
67
void <a href="EBookBackendSummary.html#e-book-backend-summary-touch">e_book_backend_summary_touch</a> (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
69
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
70
>gboolean</a> <a href="EBookBackendSummary.html#e-book-backend-summary-is-up-to-date">e_book_backend_summary_is_up_to_date</a>
71
(<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
55
void <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-remove-contact">e_book_backend_summary_remove_contact</a>
56
(<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
58
gboolean <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-check-contact">e_book_backend_summary_check_contact</a>
59
(<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
61
void <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-touch">e_book_backend_summary_touch</a> (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
62
gboolean <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-is-up-to-date">e_book_backend_summary_is_up_to_date</a>
63
(<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
74
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
75
>gboolean</a> <a href="EBookBackendSummary.html#e-book-backend-summary-is-summary-query">e_book_backend_summary_is_summary_query</a>
76
(<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
79
href="/opt/gnome/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
80
>GPtrArray</a>* <a href="EBookBackendSummary.html#e-book-backend-summary-search">e_book_backend_summary_search</a> (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
82
char* <a href="EBookBackendSummary.html#e-book-backend-summary-get-summary-vcard">e_book_backend_summary_get_summary_vcard</a>
83
(<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
65
gboolean <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-is-summary-query">e_book_backend_summary_is_summary_query</a>
66
(<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
68
GPtrArray* <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-search">e_book_backend_summary_search</a> (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
70
char* <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-get-summary-vcard">e_book_backend_summary_get_summary_vcard</a>
71
(<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
89
77
<div class="refsect1" lang="en">
90
<a name="id2564710"></a><h2>Object Hierarchy</h2>
78
<a name="id2620533"></a><h2>Object Hierarchy</h2>
91
79
<pre class="synopsis">
94
href="/opt/gnome/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
96
82
+----EBookBackendSummary
99
85
<div class="refsect1" lang="en">
100
<a name="id2564734"></a><h2>Description</h2>
86
<a name="id2620557"></a><h2>Description</h2>
105
91
<div class="refsect1" lang="en">
106
<a name="id2564749"></a><h2>Details</h2>
92
<a name="id2620573"></a><h2>Details</h2>
107
93
<div class="refsect2" lang="en">
108
<a name="id2564760"></a><h3>
94
<a name="id2620584"></a><h3>
109
95
<a name="EBookBackendSummary-struct"></a>struct EBookBackendSummary</h3>
110
<a class="indexterm" name="id2554098"></a><pre class="programlisting">struct EBookBackendSummary;</pre>
96
<a class="indexterm" name="id2587520"></a><pre class="programlisting">struct EBookBackendSummary;</pre>
116
102
<div class="refsect2" lang="en">
117
<a name="id2554114"></a><h3>
103
<a name="id2587536"></a><h3>
118
104
<a name="e-book-backend-summary-new"></a>e_book_backend_summary_new ()</h3>
119
<a class="indexterm" name="id2554125"></a><pre class="programlisting"><a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* e_book_backend_summary_new (const char *summary_path,
105
<a class="indexterm" name="id2587547"></a><pre class="programlisting"><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* e_book_backend_summary_new (const char *summary_path,
120
106
int flush_timeout_millis);</pre>
122
Creates an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
108
Creates an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
123
109
or otherwise affecting the file. <em class="parameter"><code>flush_timeout_millis</code></em>
124
110
specifies how much time should elapse, at a minimum, from
125
111
the summary is changed until it is flushed to disk.</p>
288
260
<col align="left" valign="top">
291
<td><span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
292
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
263
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
264
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
296
<td><span class="term"><em class="parameter"><code>id</code></em> :</span></td>
268
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
297
269
<td> a unique contact ID string
301
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
303
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
304
><code class="literal">TRUE</code></a> if the summary exists, <a
305
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
306
><code class="literal">FALSE</code></a> otherwise.
273
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
274
<td> <code class="literal">TRUE</code> if the summary exists, <code class="literal">FALSE</code> otherwise.
322
290
<div class="variablelist"><table border="0">
323
291
<col align="left" valign="top">
325
<td><span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
326
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
293
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
294
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
332
300
<div class="refsect2" lang="en">
333
<a name="id2600750"></a><h3>
301
<a name="id2627075"></a><h3>
334
302
<a name="e-book-backend-summary-is-up-to-date"></a>e_book_backend_summary_is_up_to_date ()</h3>
335
<a class="indexterm" name="id2600763"></a><pre class="programlisting"><a
336
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
337
>gboolean</a> e_book_backend_summary_is_up_to_date
338
(<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
303
<a class="indexterm" name="id2627089"></a><pre class="programlisting">gboolean e_book_backend_summary_is_up_to_date
304
(<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
341
307
Checks if <em class="parameter"><code>summary</code></em> is more recent than <em class="parameter"><code>t</code></em>.</p>
346
312
<col align="left" valign="top">
349
<td><span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
350
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
315
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
316
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
354
<td><span class="term"><em class="parameter"><code>t</code></em> :</span></td>
320
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
355
321
<td> the time to compare with
359
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
361
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
362
><code class="literal">TRUE</code></a> if the summary is up to date, <a
363
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
364
><code class="literal">FALSE</code></a> otherwise.
325
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
326
<td> <code class="literal">TRUE</code> if the summary is up to date, <code class="literal">FALSE</code> otherwise.
386
346
<col align="left" valign="top">
389
<td><span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
390
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
349
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
350
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
394
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
354
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
395
355
<td> an s-expression to check
399
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
401
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
402
><code class="literal">TRUE</code></a> if the query can be satisfied, <a
403
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
404
><code class="literal">FALSE</code></a> otherwise.
359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
360
<td> <code class="literal">TRUE</code> if the query can be satisfied, <code class="literal">FALSE</code> otherwise.