|  |  |  | Evolution API Reference: libedata-book, the Addressbook backend library |  | 
|---|---|---|---|---|
struct EBookBackendSummary; EBookBackendSummary* e_book_backend_summary_new (const char *summary_path, int flush_timeout_millis); gboolean e_book_backend_summary_load (EBookBackendSummary *summary); gboolean e_book_backend_summary_save (EBookBackendSummary *summary); void e_book_backend_summary_add_contact (EBookBackendSummary *summary, EContact *contact); void e_book_backend_summary_remove_contact (EBookBackendSummary *summary, const char *id); gboolean e_book_backend_summary_check_contact (EBookBackendSummary *summary, const char *id); void e_book_backend_summary_touch (EBookBackendSummary *summary); gboolean e_book_backend_summary_is_up_to_date (EBookBackendSummary *summary, time_t t); gboolean e_book_backend_summary_is_summary_query (EBookBackendSummary *summary, const char *query); GPtrArray* e_book_backend_summary_search (EBookBackendSummary *summary, const char *query); char* e_book_backend_summary_get_summary_vcard (EBookBackendSummary *summary, const char *id);
EBookBackendSummary* e_book_backend_summary_new (const char *summary_path, int flush_timeout_millis);
Creates an EBookBackendSummary object without loading it
or otherwise affecting the file. flush_timeout_millis
specifies how much time should elapse, at a minimum, from
the summary is changed until it is flushed to disk.
| summary_path: | a local file system path | 
| flush_timeout_millis: | a flush interval, in milliseconds | 
| Returns : | A new EBookBackendSummary. | 
gboolean e_book_backend_summary_load (EBookBackendSummary *summary);
Attempts to load summary from disk. The load is successful if
the file was located, it was in the correct format, and it was
not out of date.
| summary: | an EBookBackendSummary | 
| Returns : | TRUEif the load succeeded,FALSEif it failed. | 
gboolean e_book_backend_summary_save (EBookBackendSummary *summary);
Attempts to save summary to disk.
| summary: | an EBookBackendSummary | 
| Returns : | TRUEif the save succeeded,FALSEotherwise. | 
void e_book_backend_summary_add_contact (EBookBackendSummary *summary, EContact *contact);
Adds a summary of contact to summary. Does not check if
the contact already has a summary.
| summary: | an EBookBackendSummary | 
| contact: | an EContact to add | 
void                e_book_backend_summary_remove_contact
                                                        (EBookBackendSummary *summary,
                                                         const char *id);
Removes the summary of the contact identified by id from summary.
| summary: | an EBookBackendSummary | 
| id: | a unique contact ID string | 
gboolean e_book_backend_summary_check_contact (EBookBackendSummary *summary, const char *id);
Checks if a summary of the contact identified by id
exists in summary.
| summary: | an EBookBackendSummary | 
| id: | a unique contact ID string | 
| Returns : | TRUEif the summary exists,FALSEotherwise. | 
void e_book_backend_summary_touch (EBookBackendSummary *summary);
Indicates that summary has changed and should be flushed to disk.
| summary: | an EBookBackendSummary | 
gboolean e_book_backend_summary_is_up_to_date (EBookBackendSummary *summary, time_t t);
Checks if summary is more recent than t.
| summary: | an EBookBackendSummary | 
| t: | the time to compare with | 
| Returns : | TRUEif the summary is up to date,FALSEotherwise. | 
gboolean e_book_backend_summary_is_summary_query (EBookBackendSummary *summary, const char *query);
Checks if query can be satisfied by searching only the fields
stored by summary.
| summary: | an EBookBackendSummary | 
| query: | an s-expression to check | 
| Returns : | TRUEif the query can be satisfied,FALSEotherwise. | 
GPtrArray* e_book_backend_summary_search (EBookBackendSummary *summary, const char *query);
Searches summary for contacts matching query.
| summary: | an EBookBackendSummary | 
| query: | an s-expression | 
| Returns : | A GPtrArray of pointers to contact ID strings. | 
char*               e_book_backend_summary_get_summary_vcard
                                                        (EBookBackendSummary *summary,
                                                         const char *id);
Constructs and returns a VCard from the contact summary specified
by id.
| summary: | an EBookBackendSummary | 
| id: | a unique contact ID | 
| Returns : | A new VCard, or NULLif the contact summary didn't exist. |