![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Address Book Backend (libedata-book) | ![]() |
---|---|---|---|---|
Top | Description |
struct EBookBackendSqliteDB; EbSdbSearchData; EBookBackendSqliteDB * e_book_backend_sqlitedb_new (const gchar *path
,const gchar *email_id
,const gchar *folderid
,const gchar *folder_name
,gboolean store_vcard
,GError **error
); gboolean e_book_backend_sqlitedb_add_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,EContact *contact
,gboolean partial_content
,GError **error
); gboolean e_book_backend_sqlitedb_add_contacts (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GSList *contacts
,gboolean partial_content
,GError **error
); gboolean e_book_backend_sqlitedb_remove_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
); gboolean e_book_backend_sqlitedb_remove_contacts (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GSList *uids
,GError **error
); gboolean e_book_backend_sqlitedb_has_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,gboolean *partial_content
,GError **error
); EContact * e_book_backend_sqlitedb_get_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
); gchar * e_book_backend_sqlitedb_get_vcard_string (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
); GSList * e_book_backend_sqlitedb_search (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *sexp
,GSList *fields_of_interest
,GError **error
); GSList * e_book_backend_sqlitedb_search_uids (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *sexp
,GError **error
); gboolean e_book_backend_sqlitedb_get_is_populated (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
); gboolean e_book_backend_sqlitedb_set_is_populated (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,gboolean populated
,GError **error
); gchar * e_book_backend_sqlitedb_get_sync_data (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
); gboolean e_book_backend_sqlitedb_set_sync_data (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *sync_data
,GError **error
); gchar * e_book_backend_sqlitedb_get_key_value (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *key
,GError **error
); gboolean e_book_backend_sqlitedb_set_key_value (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *key
,const gchar *value
,GError **error
); gchar * e_book_backend_sqlitedb_get_contact_bdata (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
); gboolean e_book_backend_sqlitedb_set_contact_bdata (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,const gchar *value
,GError **error
); gboolean e_book_backend_sqlitedb_get_has_partial_content (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
); gboolean e_book_backend_sqlitedb_set_has_partial_content (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,gboolean partial_content
,GError **error
); GSList * e_book_backend_sqlitedb_get_partially_cached_ids (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
); gboolean e_book_backend_sqlitedb_delete_addressbook (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
); gboolean e_book_backend_sqlitedb_remove (EBookBackendSqliteDB *ebsdb
,GError **error
); void e_book_backend_sqlitedb_search_data_free (EbSdbSearchData *s_data
);
struct EBookBackendSqliteDB { GObject parent; EBookBackendSqliteDBPrivate *priv; };
EBookBackendSqliteDB * e_book_backend_sqlitedb_new (const gchar *path
,const gchar *email_id
,const gchar *folderid
,const gchar *folder_name
,gboolean store_vcard
,GError **error
);
If the path for multiple addressbooks are same, the contacts from all addressbooks would be stored in same db in different tables.
|
location where the db would be created |
|
folder id of the address-book |
|
name of the address-book |
|
True if the vcard should be stored inside db, if FALSE only the summary fields would be stored inside db. |
gboolean e_book_backend_sqlitedb_add_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,EContact *contact
,gboolean partial_content
,GError **error
);
This is a convenience wrapper for e_book_backend_sqlitedb_add_contacts, which is the preferred means to add multiple contacts when possible.
|
folder id |
|
EContact to be added |
|
contact does not contain full information. Used when the backend cache's partial information for auto-completion. |
Returns : |
TRUE on success. |
gboolean e_book_backend_sqlitedb_add_contacts (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GSList *contacts
,gboolean partial_content
,GError **error
);
|
folder id |
|
list of EContacts |
|
contact does not contain full information. Used when the backend cache's partial information for auto-completion. |
Returns : |
TRUE on success. |
gboolean e_book_backend_sqlitedb_remove_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
);
gboolean e_book_backend_sqlitedb_remove_contacts (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GSList *uids
,GError **error
);
gboolean e_book_backend_sqlitedb_has_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,gboolean *partial_content
,GError **error
);
EContact * e_book_backend_sqlitedb_get_contact (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
);
gchar * e_book_backend_sqlitedb_get_vcard_string (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
);
GSList * e_book_backend_sqlitedb_search (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *sexp
,GSList *fields_of_interest
,GError **error
);
Summary fields - uid, nickname, given_name, family_name, file_as email_1, email_2, email_3, email_4, is_list, list_show_addresses, wants_html
|
search expression. &fields_of_interest: a GList containing the names of fields to return, or NULL for all. At the moment if this is non-null, the vcard will be populated with summary fields, else it would return the whole vcard if its stored in the db. [not implemented fully] |
|
Search on summary fields is always supported. Search expression containing any other field is supported only if backend chooses to store the vcard inside the db. |
Returns : |
List of EbSdbSearchData. |
GSList * e_book_backend_sqlitedb_search_uids (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *sexp
,GError **error
);
gboolean e_book_backend_sqlitedb_get_is_populated (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
);
gboolean e_book_backend_sqlitedb_set_is_populated (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,gboolean populated
,GError **error
);
gchar * e_book_backend_sqlitedb_get_sync_data (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
);
gboolean e_book_backend_sqlitedb_set_sync_data (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *sync_data
,GError **error
);
gchar * e_book_backend_sqlitedb_get_key_value (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *key
,GError **error
);
gboolean e_book_backend_sqlitedb_set_key_value (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *key
,const gchar *value
,GError **error
);
gchar * e_book_backend_sqlitedb_get_contact_bdata (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,GError **error
);
gboolean e_book_backend_sqlitedb_set_contact_bdata (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,const gchar *uid
,const gchar *value
,GError **error
);
gboolean e_book_backend_sqlitedb_get_has_partial_content (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
);
Returns : |
TRUE if the vcards stored in the db were downloaded partially. It is to indicate the stored vcards does not contain the full data. |
gboolean e_book_backend_sqlitedb_set_has_partial_content (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,gboolean partial_content
,GError **error
);
GSList * e_book_backend_sqlitedb_get_partially_cached_ids (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
);
gboolean e_book_backend_sqlitedb_delete_addressbook (EBookBackendSqliteDB *ebsdb
,const gchar *folderid
,GError **error
);
gboolean e_book_backend_sqlitedb_remove (EBookBackendSqliteDB *ebsdb
,GError **error
);
void e_book_backend_sqlitedb_search_data_free
(EbSdbSearchData *s_data
);