![]() |
![]() |
![]() |
Evolution API Reference: libebook, the Addressbook Library | ![]() |
---|---|---|---|---|
EBook; EBook* e_book_new (ESource *source, GError **error); EBook* e_book_new_default_addressbook (GError **error); EBook* e_book_new_from_uri (const char *uri, GError **error); EBook* e_book_new_system_addressbook (GError **error); gboolean e_book_set_default_addressbook (EBook *book, GError **error); gboolean e_book_set_default_source (ESource *source, GError **error); gboolean e_book_remove (EBook *book, GError **error); gboolean e_book_open (EBook *book, gboolean only_if_exists, GError **error); gboolean e_book_get_supported_fields (EBook *book, GList **fields, GError **error); gboolean e_book_get_supported_auth_methods (EBook *book, GList **auth_methods, GError **error); gboolean e_book_get_required_fields (EBook *book, GList **fields, GError **error); ESource* e_book_get_source (EBook *book); gboolean e_book_is_online (EBook *book); gboolean e_book_is_opened (EBook *book); gboolean e_book_authenticate_user (EBook *book, const char *user, const char *passwd, const char *auth_method, GError **error); gboolean e_book_get_contact (EBook *book, const char *id, EContact **contact, GError **error); gboolean e_book_remove_contact (EBook *book, const char *id, GError **error); gboolean e_book_remove_contacts (EBook *book, GList *ids, GError **error); gboolean e_book_add_contact (EBook *book, EContact *contact, GError **error); gboolean e_book_commit_contact (EBook *book, EContact *contact, GError **error); gboolean e_book_get_book_view (EBook *book, EBookQuery *query, GList *requested_fields, int max_results, EBookView **book_view, GError **error); gboolean e_book_get_contacts (EBook *book, EBookQuery *query, GList **contacts, GError **error); gboolean e_book_get_changes (EBook *book, char *changeid, GList **changes, GError **error); void e_book_free_change_list (GList *change_list); const char* e_book_get_uri (EBook *book); const char* e_book_get_static_capabilities (EBook *book, GError **error); gboolean e_book_check_static_capability (EBook *book, const char *cap); gboolean e_book_is_writable (EBook *book); gboolean e_book_cancel (EBook *book, GError **error); gboolean e_book_get_self (EContact **contact, EBook **book, GError **error); gboolean e_book_set_self (EBook *book, EContact *contact, GError **error); gboolean e_book_is_self (EContact *contact); gboolean e_book_get_addressbooks (ESourceList **addressbook_sources, GError **error); void (*EBookCallback) (EBook *book, EBookStatus status, gpointer closure); void (*EBookOpenProgressCallback) (EBook *book, const char *status_message, short percent , gpointer closure); void (*EBookIdCallback) (EBook *book, EBookStatus status, const char *id, gpointer closure); void (*EBookEListCallback) (EBook *book, EBookStatus status, EList *list, gpointer closure); void (*EBookListCallback) (EBook *book, EBookStatus status, GList *list, gpointer closure); void (*EBookContactCallback) (EBook *book, EBookStatus status, EContact *contact, gpointer closure); void (*EBookBookViewCallback) (EBook *book, EBookStatus status, EBookView *book_view, gpointer closure); guint e_book_async_open (EBook *book, gboolean only_if_exists, EBookCallback open_response, gpointer closure); guint e_book_async_remove (EBook *book, EBookCallback cb, gpointer closure); guint e_book_async_get_supported_fields (EBook *book, EBookEListCallback cb, gpointer closure); guint e_book_async_get_supported_auth_methods (EBook *book, EBookEListCallback cb, gpointer closure); guint e_book_async_authenticate_user (EBook *book, const char *user, const char *passwd, const char *auth_method, EBookCallback cb, gpointer closure); guint e_book_async_get_contact (EBook *book, const char *id, EBookContactCallback cb, gpointer closure); guint e_book_async_get_contacts (EBook *book, EBookQuery *query, EBookListCallback cb, gpointer closure); guint e_book_async_remove_contact (EBook *book, EContact *contact, EBookCallback cb, gpointer closure); guint e_book_async_remove_contact_by_id (EBook *book, const char *id, EBookCallback cb, gpointer closure); guint e_book_async_remove_contacts (EBook *book, GList *ids, EBookCallback cb, gpointer closure); gboolean e_book_async_add_contact (EBook *book, EContact *contact, EBookIdCallback cb, gpointer closure); guint e_book_async_commit_contact (EBook *book, EContact *contact, EBookCallback cb, gpointer closure); guint e_book_async_get_book_view (EBook *book, EBookQuery *query, GList *requested_fields, int max_results, EBookBookViewCallback cb, gpointer closure); guint e_book_async_get_changes (EBook *book, char *changeid, EBookListCallback cb, gpointer closure); guint e_book_async_get_required_fields (EBook *book, EBookEListCallback cb, gpointer closure);
"auth-required" : Run Last "backend-died" : Run Last "connection-status" : Run Last "writable-status" : Run Last
Represents a complete addressbook. Event notifications and callbacks go to the EBookListener. Contrast with EBookView, which represents a search of the addressbook.
EBook* e_book_new_default_addressbook (GError **error);
|
|
Returns : |
EBook* e_book_new_from_uri (const char *uri, GError **error);
|
|
|
|
Returns : |
EBook* e_book_new_system_addressbook (GError **error);
|
|
Returns : |
gboolean e_book_set_default_addressbook (EBook *book, GError **error);
|
|
|
|
Returns : |
gboolean e_book_set_default_source (ESource *source, GError **error);
|
|
|
|
Returns : |
gboolean e_book_open (EBook *book, gboolean only_if_exists, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_get_supported_fields (EBook *book, GList **fields, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_get_supported_auth_methods (EBook *book, GList **auth_methods, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_get_required_fields (EBook *book, GList **fields, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_authenticate_user (EBook *book, const char *user, const char *passwd, const char *auth_method, GError **error);
|
|
|
|
|
|
|
|
|
|
Returns : |
gboolean e_book_get_contact (EBook *book, const char *id, EContact **contact, GError **error);
|
|
|
|
|
|
|
|
Returns : |
gboolean e_book_remove_contact (EBook *book, const char *id, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_remove_contacts (EBook *book, GList *ids, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_add_contact (EBook *book, EContact *contact, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_commit_contact (EBook *book, EContact *contact, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_get_book_view (EBook *book, EBookQuery *query, GList *requested_fields, int max_results, EBookView **book_view, GError **error);
|
|
|
|
|
|
|
|
|
|
|
|
Returns : |
gboolean e_book_get_contacts (EBook *book, EBookQuery *query, GList **contacts, GError **error);
|
|
|
|
|
|
|
|
Returns : |
gboolean e_book_get_changes (EBook *book, char *changeid, GList **changes, GError **error);
|
|
|
|
|
|
|
|
Returns : |
const char* e_book_get_static_capabilities (EBook *book, GError **error);
|
|
|
|
Returns : |
gboolean e_book_check_static_capability (EBook *book, const char *cap);
|
|
|
|
Returns : |
gboolean e_book_get_self (EContact **contact, EBook **book, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_set_self (EBook *book, EContact *contact, GError **error);
|
|
|
|
|
|
Returns : |
gboolean e_book_get_addressbooks (ESourceList **addressbook_sources, GError **error);
|
|
|
|
Returns : |
void (*EBookCallback) (EBook *book, EBookStatus status, gpointer closure);
|
|
|
|
|
void (*EBookOpenProgressCallback) (EBook *book, const char *status_message, short percent , gpointer closure);
|
|
|
|
|
|
|
void (*EBookIdCallback) (EBook *book, EBookStatus status, const char *id, gpointer closure);
|
|
|
|
|
|
|
void (*EBookEListCallback) (EBook *book, EBookStatus status, EList *list, gpointer closure);
|
|
|
|
|
|
|
void (*EBookListCallback) (EBook *book, EBookStatus status, GList *list, gpointer closure);
|
|
|
|
|
|
|
void (*EBookContactCallback) (EBook *book, EBookStatus status, EContact *contact, gpointer closure);
|
|
|
|
|
|
|
void (*EBookBookViewCallback) (EBook *book, EBookStatus status, EBookView *book_view, gpointer closure);
|
|
|
|
|
|
|
guint e_book_async_open (EBook *book, gboolean only_if_exists, EBookCallback open_response, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_remove (EBook *book, EBookCallback cb, gpointer closure);
|
|
|
|
|
|
Returns : |
guint e_book_async_get_supported_fields (EBook *book, EBookEListCallback cb, gpointer closure);
|
|
|
|
|
|
Returns : |
guint e_book_async_get_supported_auth_methods (EBook *book, EBookEListCallback cb, gpointer closure);
|
|
|
|
|
|
Returns : |
guint e_book_async_authenticate_user (EBook *book, const char *user, const char *passwd, const char *auth_method, EBookCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_get_contact (EBook *book, const char *id, EBookContactCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_get_contacts (EBook *book, EBookQuery *query, EBookListCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_remove_contact (EBook *book, EContact *contact, EBookCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_remove_contact_by_id (EBook *book, const char *id, EBookCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_remove_contacts (EBook *book, GList *ids, EBookCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
gboolean e_book_async_add_contact (EBook *book, EContact *contact, EBookIdCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_commit_contact (EBook *book, EContact *contact, EBookCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_get_book_view (EBook *book, EBookQuery *query, GList *requested_fields, int max_results, EBookBookViewCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_get_changes (EBook *book, char *changeid, EBookListCallback cb, gpointer closure);
|
|
|
|
|
|
|
|
Returns : |
guint e_book_async_get_required_fields (EBook *book, EBookEListCallback cb, gpointer closure);
|
|
|
|
|
|
Returns : |
"auth-required"
signalvoid user_function (EBook *ebook, gpointer user_data) : Run Last
Authentication is required to access this source. You should call e_book_authenticate_user or e_book_async_authenticate_user.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"backend-died"
signalvoid user_function (EBook *ebook, gpointer user_data) : Run Last
The backend for this address book has died.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"connection-status"
signalvoid user_function (EBook *ebook, gboolean arg1, gpointer user_data) : Run Last
The connection status for this book is being reported.
|
the object which received the signal. |
|
TRUE if the connection is online, FALSE otherwise. |
|
user data set when the signal handler was connected. |
"writable-status"
signalvoid user_function (EBook *ebook, gboolean arg1, gpointer user_data) : Run Last
The writable status for this book is being reported.
|
the object which received the signal. |
|
TRUE if the book is writable, FALSE otherwise. |
|
user data set when the signal handler was connected. |