Evolution-Data-Server Manual: Address Book Backend (libedata-book) | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy |
Synopsis
struct EBookBackendSummary; EBookBackendSummary * e_book_backend_summary_new (const gchar *summary_path
,gint 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 gchar *id
); gboolean e_book_backend_summary_check_contact (EBookBackendSummary *summary
,const gchar *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 gchar *query
); GPtrArray * e_book_backend_summary_search (EBookBackendSummary *summary
,const gchar *query
); gchar * e_book_backend_summary_get_summary_vcard (EBookBackendSummary *summary
,const gchar *id
);
Details
e_book_backend_summary_new ()
EBookBackendSummary * e_book_backend_summary_new (const gchar *summary_path
,gint 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.
|
a local file system path |
|
a flush interval, in milliseconds |
Returns : |
A new EBookBackendSummary. |
e_book_backend_summary_load ()
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.
|
an EBookBackendSummary |
Returns : |
TRUE if the load succeeded, FALSE if it failed. |
e_book_backend_summary_save ()
gboolean e_book_backend_summary_save (EBookBackendSummary *summary
);
Attempts to save summary
to disk.
|
an EBookBackendSummary |
Returns : |
TRUE if the save succeeded, FALSE otherwise. |
e_book_backend_summary_add_contact ()
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.
|
an EBookBackendSummary |
|
an EContact to add |
e_book_backend_summary_remove_contact ()
void e_book_backend_summary_remove_contact (EBookBackendSummary *summary
,const gchar *id
);
Removes the summary of the contact identified by id
from summary
.
|
an EBookBackendSummary |
|
a unique contact ID string |
e_book_backend_summary_check_contact ()
gboolean e_book_backend_summary_check_contact (EBookBackendSummary *summary
,const gchar *id
);
Checks if a summary of the contact identified by id
exists in summary
.
|
an EBookBackendSummary |
|
a unique contact ID string |
Returns : |
TRUE if the summary exists, FALSE otherwise. |
e_book_backend_summary_touch ()
void e_book_backend_summary_touch (EBookBackendSummary *summary
);
Indicates that summary
has changed and should be flushed to disk.
|
an EBookBackendSummary |
e_book_backend_summary_is_up_to_date ()
gboolean e_book_backend_summary_is_up_to_date (EBookBackendSummary *summary
,time_t t
);
Checks if summary
is more recent than t
.
|
an EBookBackendSummary |
|
the time to compare with |
Returns : |
TRUE if the summary is up to date, FALSE otherwise. |
e_book_backend_summary_is_summary_query ()
gboolean e_book_backend_summary_is_summary_query (EBookBackendSummary *summary
,const gchar *query
);
Checks if query
can be satisfied by searching only the fields
stored by summary
.
|
an EBookBackendSummary |
|
an s-expression to check |
Returns : |
TRUE if the query can be satisfied, FALSE otherwise. |
e_book_backend_summary_search ()
GPtrArray * e_book_backend_summary_search (EBookBackendSummary *summary
,const gchar *query
);
Searches summary
for contacts matching query
.
|
an EBookBackendSummary |
|
an s-expression |
Returns : |
A GPtrArray of pointers to contact ID strings. |
e_book_backend_summary_get_summary_vcard ()
gchar * e_book_backend_summary_get_summary_vcard (EBookBackendSummary *summary
,const gchar *id
);
Constructs and returns a VCard from the contact summary specified
by id
.
|
an EBookBackendSummary |
|
a unique contact ID |
Returns : |
A new VCard, or NULL if the contact summary didn't exist. |