← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-updates

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/xml/e-book-backend-cache.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/xml/e-book-backend-cache.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="EBookBackendCache.top_of_page">EBookBackendCache</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEDATA-BOOK Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEDATA-BOOK Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EBookBackendCache</refname>
13
14
<refpurpose></refpurpose>
16
17
<refsynopsisdiv id="EBookBackendCache.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
                    <link linkend="EBookBackendCache-struct">EBookBackendCache</link>;
21
 
<link linkend="EBookBackendCache">EBookBackendCache</link>*  <link linkend="e-book-backend-cache-new">e_book_backend_cache_new</link>            (const <link linkend="gchar">gchar</link> *uri);
22
 
<link linkend="EContact">EContact</link>*           <link linkend="e-book-backend-cache-get-contact">e_book_backend_cache_get_contact</link>    (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
23
 
                                                         const <link linkend="gchar">gchar</link> *uid);
24
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-cache-add-contact">e_book_backend_cache_add_contact</link>    (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
25
 
                                                         <link linkend="EContact">EContact</link> *contact);
26
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-cache-remove-contact">e_book_backend_cache_remove_contact</link> (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
27
 
                                                         const <link linkend="gchar">gchar</link> *uid);
28
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-cache-check-contact">e_book_backend_cache_check_contact</link>  (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
29
 
                                                         const <link linkend="gchar">gchar</link> *uid);
30
 
<link linkend="GList">GList</link>*              <link linkend="e-book-backend-cache-get-contacts">e_book_backend_cache_get_contacts</link>   (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
31
 
                                                         const <link linkend="gchar">gchar</link> *query);
32
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-cache-exists">e_book_backend_cache_exists</link>         (const <link linkend="gchar">gchar</link> *uri);
33
 
<link linkend="void">void</link>                <link linkend="e-book-backend-cache-set-populated">e_book_backend_cache_set_populated</link>  (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-cache-is-populated">e_book_backend_cache_is_populated</link>   (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache);
35
 
<link linkend="void">void</link>                <link linkend="e-book-backend-cache-set-time">e_book_backend_cache_set_time</link>       (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
36
 
                                                         const <link linkend="gchar">gchar</link> *t);
37
 
<link linkend="gchar">gchar</link> *             <link linkend="e-book-backend-cache-get-time">e_book_backend_cache_get_time</link>       (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache);
38
 
<link linkend="GPtrArray">GPtrArray</link>*          <link linkend="e-book-backend-cache-search">e_book_backend_cache_search</link>         (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
39
 
                                                         const <link linkend="gchar">gchar</link> *query);
 
20
<synopsis>                    <link linkend="EBookBackendCache-struct">EBookBackendCache</link>;
 
21
<link linkend="EBookBackendCache"><returnvalue>EBookBackendCache</returnvalue></link>*  <link linkend="e-book-backend-cache-new">e_book_backend_cache_new</link>            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri</parameter>);
 
22
<link linkend="EContact"><returnvalue>EContact</returnvalue></link>*           <link linkend="e-book-backend-cache-get-contact">e_book_backend_cache_get_contact</link>    (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
23
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
 
24
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-cache-add-contact">e_book_backend_cache_add_contact</link>    (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
25
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);
 
26
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-cache-remove-contact">e_book_backend_cache_remove_contact</link> (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
27
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
 
28
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-cache-check-contact">e_book_backend_cache_check_contact</link>  (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
29
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
 
30
<link linkend="GList"><returnvalue>GList</returnvalue></link>*              <link linkend="e-book-backend-cache-get-contacts">e_book_backend_cache_get_contacts</link>   (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
31
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);
 
32
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-cache-exists">e_book_backend_cache_exists</link>         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri</parameter>);
 
33
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-cache-set-populated">e_book_backend_cache_set_populated</link>  (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>);
 
34
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-cache-is-populated">e_book_backend_cache_is_populated</link>   (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>);
 
35
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-cache-set-time">e_book_backend_cache_set_time</link>       (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
36
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *t</parameter>);
 
37
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-book-backend-cache-get-time">e_book_backend_cache_get_time</link>       (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>);
 
38
<link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>*          <link linkend="e-book-backend-cache-search">e_book_backend_cache_search</link>         (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
39
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);
40
40
</synopsis>
41
41
</refsynopsisdiv>
42
 
 
43
42
<refsect1 id="EBookBackendCache.object-hierarchy" role="object_hierarchy">
44
43
<title role="object_hierarchy.title">Object Hierarchy</title>
45
44
<synopsis>
48
47
         +----EBookBackendCache
49
48
</synopsis>
50
49
</refsect1>
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
50
<refsect1 id="EBookBackendCache.properties" role="properties">
57
51
<title role="properties.title">Properties</title>
58
52
<synopsis>
59
 
  &quot;<link linkend="EBookBackendCache--uri">uri</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
 
53
  &quot;<link linkend="EBookBackendCache--uri">uri</link>&quot;                      <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only
60
54
</synopsis>
61
55
</refsect1>
62
56
 
63
 
 
64
 
 
65
57
<refsect1 id="EBookBackendCache.description" role="desc">
66
58
<title role="desc.title">Description</title>
67
59
<para>
68
60
</para>
69
61
</refsect1>
70
 
 
71
62
<refsect1 id="EBookBackendCache.details" role="details">
72
63
<title role="details.title">Details</title>
73
64
<refsect2 id="EBookBackendCache-struct" role="struct">
74
65
<title>EBookBackendCache</title>
75
 
<indexterm zone="EBookBackendCache-struct"><primary sortas="EBookBackendCache">EBookBackendCache</primary></indexterm><programlisting>typedef struct _EBookBackendCache EBookBackendCache;</programlisting>
 
66
<indexterm zone="EBookBackendCache-struct"><primary>EBookBackendCache</primary></indexterm>
 
67
<programlisting>typedef struct _EBookBackendCache EBookBackendCache;</programlisting>
76
68
<para>
77
69
</para></refsect2>
78
70
<refsect2 id="e-book-backend-cache-new" role="function">
79
71
<title>e_book_backend_cache_new ()</title>
80
 
<indexterm zone="e-book-backend-cache-new"><primary sortas="e_book_backend_cache_new">e_book_backend_cache_new</primary></indexterm><programlisting><link linkend="EBookBackendCache">EBookBackendCache</link>*  e_book_backend_cache_new            (const <link linkend="gchar">gchar</link> *uri);</programlisting>
 
72
<indexterm zone="e-book-backend-cache-new"><primary>e_book_backend_cache_new</primary></indexterm>
 
73
<programlisting><link linkend="EBookBackendCache"><returnvalue>EBookBackendCache</returnvalue></link>*  e_book_backend_cache_new            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri</parameter>);</programlisting>
81
74
<para>
82
75
Creates a new <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> object, which implements a local
83
76
cache of <link linkend="EContact"><type>EContact</type></link> objects, useful for remote backends.</para>
84
 
<para>
85
 
</para><variablelist role="params">
 
77
<variablelist role="params">
86
78
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
87
 
<listitem><simpara> URI of the backend to be cached.
 
79
<listitem><simpara>URI of the backend to be cached.
88
80
</simpara></listitem></varlistentry>
89
81
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>.
90
82
</simpara></listitem></varlistentry>
91
83
</variablelist></refsect2>
92
84
<refsect2 id="e-book-backend-cache-get-contact" role="function">
93
85
<title>e_book_backend_cache_get_contact ()</title>
94
 
<indexterm zone="e-book-backend-cache-get-contact"><primary sortas="e_book_backend_cache_get_contact">e_book_backend_cache_get_contact</primary></indexterm><programlisting><link linkend="EContact">EContact</link>*           e_book_backend_cache_get_contact    (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
95
 
                                                         const <link linkend="gchar">gchar</link> *uid);</programlisting>
 
86
<indexterm zone="e-book-backend-cache-get-contact"><primary>e_book_backend_cache_get_contact</primary></indexterm>
 
87
<programlisting><link linkend="EContact"><returnvalue>EContact</returnvalue></link>*           e_book_backend_cache_get_contact    (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
88
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
96
89
<para>
97
90
Get a cached contact. Note that the returned <link linkend="EContact"><type>EContact</type></link> will be
98
91
newly created, and must be unreffed by the caller when no longer
99
92
needed.</para>
100
 
<para>
101
 
</para><variablelist role="params">
 
93
<variablelist role="params">
102
94
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
103
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
95
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
104
96
</simpara></listitem></varlistentry>
105
97
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
106
 
<listitem><simpara> a unique contact ID
 
98
<listitem><simpara>a unique contact ID
107
99
</simpara></listitem></varlistentry>
108
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A cached <link linkend="EContact"><type>EContact</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>uid</parameter> is not cached.
 
100
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A cached <link linkend="EContact"><type>EContact</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>uid</parameter> is not cached.
109
101
</simpara></listitem></varlistentry>
110
102
</variablelist></refsect2>
111
103
<refsect2 id="e-book-backend-cache-add-contact" role="function">
112
104
<title>e_book_backend_cache_add_contact ()</title>
113
 
<indexterm zone="e-book-backend-cache-add-contact"><primary sortas="e_book_backend_cache_add_contact">e_book_backend_cache_add_contact</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_cache_add_contact    (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
114
 
                                                         <link linkend="EContact">EContact</link> *contact);</programlisting>
 
105
<indexterm zone="e-book-backend-cache-add-contact"><primary>e_book_backend_cache_add_contact</primary></indexterm>
 
106
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_cache_add_contact    (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
107
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);</programlisting>
115
108
<para>
116
109
Adds <parameter>contact</parameter> to <parameter>cache</parameter>.</para>
117
 
<para>
118
 
</para><variablelist role="params">
 
110
<variablelist role="params">
119
111
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
120
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
112
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
121
113
</simpara></listitem></varlistentry>
122
114
<varlistentry><term><parameter>contact</parameter>&#160;:</term>
123
 
<listitem><simpara> an <link linkend="EContact"><type>EContact</type></link>
 
115
<listitem><simpara>an <link linkend="EContact"><type>EContact</type></link>
124
116
</simpara></listitem></varlistentry>
125
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the contact was cached successfully, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
117
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the contact was cached successfully, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
126
118
</simpara></listitem></varlistentry>
127
119
</variablelist></refsect2>
128
120
<refsect2 id="e-book-backend-cache-remove-contact" role="function">
129
121
<title>e_book_backend_cache_remove_contact ()</title>
130
 
<indexterm zone="e-book-backend-cache-remove-contact"><primary sortas="e_book_backend_cache_remove_contact">e_book_backend_cache_remove_contact</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_cache_remove_contact (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
131
 
                                                         const <link linkend="gchar">gchar</link> *uid);</programlisting>
 
122
<indexterm zone="e-book-backend-cache-remove-contact"><primary>e_book_backend_cache_remove_contact</primary></indexterm>
 
123
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_cache_remove_contact (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
124
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
132
125
<para>
133
126
Removes the contact identified by <parameter>uid</parameter> from <parameter>cache</parameter>.</para>
134
 
<para>
135
 
</para><variablelist role="params">
 
127
<variablelist role="params">
136
128
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
137
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
129
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
138
130
</simpara></listitem></varlistentry>
139
131
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
140
 
<listitem><simpara> a unique contact ID
 
132
<listitem><simpara>a unique contact ID
141
133
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the contact was found and removed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
134
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the contact was found and removed, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
143
135
</simpara></listitem></varlistentry>
144
136
</variablelist></refsect2>
145
137
<refsect2 id="e-book-backend-cache-check-contact" role="function">
146
138
<title>e_book_backend_cache_check_contact ()</title>
147
 
<indexterm zone="e-book-backend-cache-check-contact"><primary sortas="e_book_backend_cache_check_contact">e_book_backend_cache_check_contact</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_cache_check_contact  (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
148
 
                                                         const <link linkend="gchar">gchar</link> *uid);</programlisting>
 
139
<indexterm zone="e-book-backend-cache-check-contact"><primary>e_book_backend_cache_check_contact</primary></indexterm>
 
140
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_cache_check_contact  (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
141
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
149
142
<para>
150
143
Checks if the contact identified by <parameter>uid</parameter> exists in <parameter>cache</parameter>.</para>
151
 
<para>
152
 
</para><variablelist role="params">
 
144
<variablelist role="params">
153
145
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
154
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
146
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
155
147
</simpara></listitem></varlistentry>
156
148
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
157
 
<listitem><simpara> a unique contact ID
 
149
<listitem><simpara>a unique contact ID
158
150
</simpara></listitem></varlistentry>
159
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the cache contains the contact, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
151
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the cache contains the contact, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
160
152
</simpara></listitem></varlistentry>
161
153
</variablelist></refsect2>
162
154
<refsect2 id="e-book-backend-cache-get-contacts" role="function">
163
155
<title>e_book_backend_cache_get_contacts ()</title>
164
 
<indexterm zone="e-book-backend-cache-get-contacts"><primary sortas="e_book_backend_cache_get_contacts">e_book_backend_cache_get_contacts</primary></indexterm><programlisting><link linkend="GList">GList</link>*              e_book_backend_cache_get_contacts   (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
165
 
                                                         const <link linkend="gchar">gchar</link> *query);</programlisting>
 
156
<indexterm zone="e-book-backend-cache-get-contacts"><primary>e_book_backend_cache_get_contacts</primary></indexterm>
 
157
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>*              e_book_backend_cache_get_contacts   (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
158
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);</programlisting>
166
159
<para>
167
160
Returns a list of <link linkend="EContact"><type>EContact</type></link> elements from <parameter>cache</parameter> matching <parameter>query</parameter>.
168
161
When done with the list, the caller must unref the contacts and
169
162
free the list.</para>
170
 
<para>
171
 
</para><variablelist role="params">
 
163
<variablelist role="params">
172
164
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
173
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
165
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
174
166
</simpara></listitem></varlistentry>
175
167
<varlistentry><term><parameter>query</parameter>&#160;:</term>
176
 
<listitem><simpara> an s-expression
 
168
<listitem><simpara>an s-expression
177
169
</simpara></listitem></varlistentry>
178
170
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="EContact"><type>EContact</type></link>.
179
171
</simpara></listitem></varlistentry>
180
172
</variablelist></refsect2>
181
173
<refsect2 id="e-book-backend-cache-exists" role="function">
182
174
<title>e_book_backend_cache_exists ()</title>
183
 
<indexterm zone="e-book-backend-cache-exists"><primary sortas="e_book_backend_cache_exists">e_book_backend_cache_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_cache_exists         (const <link linkend="gchar">gchar</link> *uri);</programlisting>
 
175
<indexterm zone="e-book-backend-cache-exists"><primary>e_book_backend_cache_exists</primary></indexterm>
 
176
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_cache_exists         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri</parameter>);</programlisting>
184
177
<para>
185
178
Checks if an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> exists at <parameter>uri</parameter>.</para>
186
 
<para>
187
 
</para><variablelist role="params">
 
179
<variablelist role="params">
188
180
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
189
 
<listitem><simpara> URI for the cache
 
181
<listitem><simpara>URI for the cache
190
182
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if cache exists, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if not.
 
183
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if cache exists, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
192
184
</simpara></listitem></varlistentry>
193
185
</variablelist></refsect2>
194
186
<refsect2 id="e-book-backend-cache-set-populated" role="function">
195
187
<title>e_book_backend_cache_set_populated ()</title>
196
 
<indexterm zone="e-book-backend-cache-set-populated"><primary sortas="e_book_backend_cache_set_populated">e_book_backend_cache_set_populated</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_cache_set_populated  (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache);</programlisting>
 
188
<indexterm zone="e-book-backend-cache-set-populated"><primary>e_book_backend_cache_set_populated</primary></indexterm>
 
189
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_cache_set_populated  (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>);</programlisting>
197
190
<para>
198
191
Flags <parameter>cache</parameter> as being populated - that is, it is up-to-date on the
199
192
contents of the book it's caching.</para>
200
 
<para>
201
 
</para><variablelist role="params">
 
193
<variablelist role="params">
202
194
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
203
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
195
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
204
196
</simpara></listitem></varlistentry>
205
197
</variablelist></refsect2>
206
198
<refsect2 id="e-book-backend-cache-is-populated" role="function">
207
199
<title>e_book_backend_cache_is_populated ()</title>
208
 
<indexterm zone="e-book-backend-cache-is-populated"><primary sortas="e_book_backend_cache_is_populated">e_book_backend_cache_is_populated</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_cache_is_populated   (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache);</programlisting>
 
200
<indexterm zone="e-book-backend-cache-is-populated"><primary>e_book_backend_cache_is_populated</primary></indexterm>
 
201
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_cache_is_populated   (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>);</programlisting>
209
202
<para>
210
203
Checks if <parameter>cache</parameter> is populated.</para>
211
 
<para>
212
 
</para><variablelist role="params">
 
204
<variablelist role="params">
213
205
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
214
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
206
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
215
207
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>cache</parameter> is populated, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
208
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>cache</parameter> is populated, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
217
209
</simpara></listitem></varlistentry>
218
210
</variablelist></refsect2>
219
211
<refsect2 id="e-book-backend-cache-set-time" role="function">
220
212
<title>e_book_backend_cache_set_time ()</title>
221
 
<indexterm zone="e-book-backend-cache-set-time"><primary sortas="e_book_backend_cache_set_time">e_book_backend_cache_set_time</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_cache_set_time       (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
222
 
                                                         const <link linkend="gchar">gchar</link> *t);</programlisting>
 
213
<indexterm zone="e-book-backend-cache-set-time"><primary>e_book_backend_cache_set_time</primary></indexterm>
 
214
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_cache_set_time       (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
215
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *t</parameter>);</programlisting>
223
216
<para>
224
217
</para><variablelist role="params">
225
218
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
231
224
</variablelist></refsect2>
232
225
<refsect2 id="e-book-backend-cache-get-time" role="function">
233
226
<title>e_book_backend_cache_get_time ()</title>
234
 
<indexterm zone="e-book-backend-cache-get-time"><primary sortas="e_book_backend_cache_get_time">e_book_backend_cache_get_time</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_book_backend_cache_get_time       (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache);</programlisting>
 
227
<indexterm zone="e-book-backend-cache-get-time"><primary>e_book_backend_cache_get_time</primary></indexterm>
 
228
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_book_backend_cache_get_time       (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>);</programlisting>
235
229
<para>
236
230
</para><variablelist role="params">
237
231
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
242
236
</variablelist></refsect2>
243
237
<refsect2 id="e-book-backend-cache-search" role="function">
244
238
<title>e_book_backend_cache_search ()</title>
245
 
<indexterm zone="e-book-backend-cache-search"><primary sortas="e_book_backend_cache_search">e_book_backend_cache_search</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*          e_book_backend_cache_search         (<link linkend="EBookBackendCache">EBookBackendCache</link> *cache,
246
 
                                                         const <link linkend="gchar">gchar</link> *query);</programlisting>
 
239
<indexterm zone="e-book-backend-cache-search"><primary>e_book_backend_cache_search</primary></indexterm>
 
240
<programlisting><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>*          e_book_backend_cache_search         (<parameter><link linkend="EBookBackendCache"><type>EBookBackendCache</type></link> *cache</parameter>,
 
241
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);</programlisting>
247
242
<para>
248
243
Returns an array of pointers to unique contact ID strings for contacts
249
244
in <parameter>cache</parameter> matching <parameter>query</parameter>. When done with the array, the caller must
250
245
free the ID strings and the array.</para>
251
 
<para>
252
 
</para><variablelist role="params">
 
246
<variablelist role="params">
253
247
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
254
 
<listitem><simpara> an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
 
248
<listitem><simpara>an <link linkend="EBookBackendCache"><type>EBookBackendCache</type></link>
255
249
</simpara></listitem></varlistentry>
256
250
<varlistentry><term><parameter>query</parameter>&#160;:</term>
257
 
<listitem><simpara> an s-expression
 
251
<listitem><simpara>an s-expression
258
252
</simpara></listitem></varlistentry>
259
253
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GPtrArray"><type>GPtrArray</type></link> of pointers to contact ID strings.
260
254
</simpara></listitem></varlistentry>
264
258
<refsect1 id="EBookBackendCache.property-details" role="property_details">
265
259
<title role="property_details.title">Property Details</title>
266
260
<refsect2 id="EBookBackendCache--uri" role="property"><title>The <literal>&quot;uri&quot;</literal> property</title>
267
 
<indexterm zone="EBookBackendCache--uri"><primary sortas="EBookBackendCache:uri">EBookBackendCache:uri</primary></indexterm><programlisting>  &quot;uri&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
261
<indexterm zone="EBookBackendCache--uri"><primary>EBookBackendCache:uri</primary></indexterm>
 
262
<programlisting>  &quot;uri&quot;                      <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only</programlisting>
268
263
<para></para><para>Default value: ""</para>
269
264
</refsect2>
270
265
</refsect1>
271
266
 
272
 
 
273
 
 
274
 
 
275
267
</refentry>