| Evolution-Data-Server Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
#include <libedata-book/libedata-book.h> struct EBookBackendCache; struct EBookBackendCacheClass; EBookBackendCache * e_book_backend_cache_new (const gchar *filename); EContact * e_book_backend_cache_get_contact (EBookBackendCache *cache,const gchar *uid); gboolean e_book_backend_cache_add_contact (EBookBackendCache *cache,EContact *contact); gboolean e_book_backend_cache_remove_contact (EBookBackendCache *cache,const gchar *uid); gboolean e_book_backend_cache_check_contact (EBookBackendCache *cache,const gchar *uid); GList * e_book_backend_cache_get_contacts (EBookBackendCache *cache,const gchar *query); void e_book_backend_cache_set_populated (EBookBackendCache *cache); gboolean e_book_backend_cache_is_populated (EBookBackendCache *cache); void e_book_backend_cache_set_time (EBookBackendCache *cache,const gchar *t); gchar * e_book_backend_cache_get_time (EBookBackendCache *cache); GPtrArray * e_book_backend_cache_search (EBookBackendCache *cache,const gchar *query);
struct EBookBackendCache {
};
EBookBackendCache has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Contains only private data that should be read and manipulated using the functions below.
struct EBookBackendCacheClass {
};
EBookBackendCacheClass has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Class structure for the EBookBackendCache class.
EBookBackendCache * e_book_backend_cache_new (const gchar *filename);
e_book_backend_cache_new has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Creates a new EBookBackendCache, which implements a local cache of EContact objects, useful for remote backends.
|
file to write cached data |
Returns : |
a new EBookBackendCache |
EContact * e_book_backend_cache_get_contact (EBookBackendCache *cache,const gchar *uid);
e_book_backend_cache_get_contact has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Get a cached contact. Note that the returned EContact will be newly created, and must be unreffed by the caller when no longer needed.
|
an EBookBackendCache |
|
a unique contact ID |
Returns : |
A cached EContact, or NULL if uid is not cached. |
gboolean e_book_backend_cache_add_contact (EBookBackendCache *cache,EContact *contact);
e_book_backend_cache_add_contact has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Adds contact to cache.
|
an EBookBackendCache |
|
an EContact |
Returns : |
TRUE if the contact was cached successfully, FALSE otherwise. |
gboolean e_book_backend_cache_remove_contact (EBookBackendCache *cache,const gchar *uid);
e_book_backend_cache_remove_contact has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Removes the contact identified by uid from cache.
|
an EBookBackendCache |
|
a unique contact ID |
Returns : |
TRUE if the contact was found and removed, FALSE otherwise. |
gboolean e_book_backend_cache_check_contact (EBookBackendCache *cache,const gchar *uid);
e_book_backend_cache_check_contact has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Checks if the contact identified by uid exists in cache.
|
an EBookBackendCache |
|
a unique contact ID |
Returns : |
TRUE if the cache contains the contact, FALSE otherwise. |
GList * e_book_backend_cache_get_contacts (EBookBackendCache *cache,const gchar *query);
e_book_backend_cache_get_contacts has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Returns a list of EContact elements from cache matching query.
When done with the list, the caller must unref the contacts and
free the list.
|
an EBookBackendCache |
|
an s-expression |
Returns : |
A GList of pointers to EContact. |
void e_book_backend_cache_set_populated (EBookBackendCache *cache);
e_book_backend_cache_set_populated has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Flags cache as being populated - that is, it is up-to-date on the
contents of the book it's caching.
|
an EBookBackendCache |
gboolean e_book_backend_cache_is_populated (EBookBackendCache *cache);
e_book_backend_cache_is_populated has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Checks if cache is populated.
|
an EBookBackendCache |
Returns : |
TRUE if cache is populated, FALSE otherwise. |
void e_book_backend_cache_set_time (EBookBackendCache *cache,const gchar *t);
e_book_backend_cache_set_time is deprecated and should not be used in newly-written code.
gchar * e_book_backend_cache_get_time (EBookBackendCache *cache);
e_book_backend_cache_get_time is deprecated and should not be used in newly-written code.
GPtrArray * e_book_backend_cache_search (EBookBackendCache *cache,const gchar *query);
e_book_backend_cache_search has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Returns an array of pointers to unique contact ID strings for contacts
in cache matching query. When done with the array, the caller must
free the ID strings and the array.
|
an EBookBackendCache |
|
an s-expression |
Returns : |
A GPtrArray of pointers to contact ID strings. |