![]() |
![]() |
![]() |
Evolution-Data-Server Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
EBookBackendSummaryEBookBackendSummary — A utility for storing contact data and searching for contacts |
#include <libedata-book/libedata-book.h> struct EBookBackendSummary; struct EBookBackendSummaryClass; 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
);
struct EBookBackendSummary { };
EBookBackendSummary
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 EBookBackendSummaryClass { };
EBookBackendSummaryClass
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Class structure for the deprecated API for accessing the addressbook
EBookBackendSummary * e_book_backend_summary_new (const gchar *summary_path
,gint flush_timeout_millis
);
e_book_backend_summary_new
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
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. |
gboolean e_book_backend_summary_load (EBookBackendSummary *summary
);
e_book_backend_summary_load
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
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. |
gboolean e_book_backend_summary_save (EBookBackendSummary *summary
);
e_book_backend_summary_save
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Attempts to save summary
to disk.
|
an EBookBackendSummary |
Returns : |
TRUE if the save succeeded, FALSE otherwise. |
void e_book_backend_summary_add_contact (EBookBackendSummary *summary
,EContact *contact
);
e_book_backend_summary_add_contact
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Adds a summary of contact
to summary
. Does not check if
the contact already has a summary.
|
an EBookBackendSummary |
|
an EContact to add |
void e_book_backend_summary_remove_contact (EBookBackendSummary *summary
,const gchar *id
);
e_book_backend_summary_remove_contact
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Removes the summary of the contact identified by id
from summary
.
|
an EBookBackendSummary |
|
a unique contact ID string |
gboolean e_book_backend_summary_check_contact (EBookBackendSummary *summary
,const gchar *id
);
e_book_backend_summary_check_contact
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
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. |
void e_book_backend_summary_touch (EBookBackendSummary *summary
);
e_book_backend_summary_touch
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Indicates that summary
has changed and should be flushed to disk.
|
an EBookBackendSummary |
gboolean e_book_backend_summary_is_up_to_date (EBookBackendSummary *summary
,time_t t
);
e_book_backend_summary_is_up_to_date
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
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. |
gboolean e_book_backend_summary_is_summary_query (EBookBackendSummary *summary
,const gchar *query
);
e_book_backend_summary_is_summary_query
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
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. |
GPtrArray * e_book_backend_summary_search (EBookBackendSummary *summary
,const gchar *query
);
e_book_backend_summary_search
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
Searches summary
for contacts matching query
.
|
an EBookBackendSummary |
|
an s-expression |
Returns : |
A GPtrArray of pointers to contact ID strings. |
gchar * e_book_backend_summary_get_summary_vcard (EBookBackendSummary *summary
,const gchar *id
);
e_book_backend_summary_get_summary_vcard
has been deprecated since version 3.12 and should not be used in newly-written code. Use EBookSqlite instead
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. |