struct EBook

struct EBook;

EBook has no publicly available members.

e_book_new ()

EBook*      e_book_new                      (void);

Creates a new EBook. Use e_book_load_uri() or e_book_load_local_addressbook() to access a data store. Alternatively use e_book_get_default_addressbook().

e_book_load_source ()

gboolean    e_book_load_source              (EBook *book,
                                             ESource *source,
                                             gboolean only_if_exists,
                                             GError **error);

Load the specified source into the book.

e_book_load_uri ()

gboolean    e_book_load_uri                 (EBook *book,
                                             const char *uri,
                                             gboolean only_if_exists,
                                             GError **error);

Create an ESource from url and load the source. See e_book_load_source().

e_book_remove ()

gboolean    e_book_remove                   (EBook *book,
                                             GError **error);

Remove the backing data for this EBook. For example, with the file backend this deletes the database file. You cannot get it back!

e_book_load_local_addressbook ()

gboolean    e_book_load_local_addressbook   (EBook *book,
                                             GError **error);

Load the local address book into book.

e_book_get_supported_fields ()

gboolean    e_book_get_supported_fields     (EBook *book,
                                             GList **fields,
                                             GError **error);

Queries book for the list of fields it supports. Mostly for use by the contact editor so it knows what fields to sensitize.

e_book_get_supported_auth_methods ()

gboolean    e_book_get_supported_auth_methods
                                            (EBook *book,
                                             GList **auth_methods,
                                             GError **error);

Queries book for the list of authentication methods it supports.

e_book_authenticate_user ()

gboolean    e_book_authenticate_user        (EBook *book,
                                             const char *user,
                                             const char *passwd,
                                             const char *auth_method,
                                             GError **error);

Authenticates user with passwd, using the auth method auth_method. auth_method must be one of the authentication methods returned using e_book_get_supported_auth_methods.

e_book_get_contact ()

gboolean    e_book_get_contact              (EBook *book,
                                             const char *id,
                                             EContact **contact,
                                             GError **error);

Fills in contact with the contents of the vcard in book corresponding to id.

e_book_remove_contact ()

gboolean    e_book_remove_contact           (EBook *book,
                                             const char *id,
                                             GError **error);

Removes the contact with id id from book.

e_book_remove_contacts ()

gboolean    e_book_remove_contacts          (EBook *book,
                                             GList *ids,
                                             GError **error);

Removes the contacts with ids from the list ids from book. This is always more efficient than calling e_book_remove_contact_by_id if you have more than one id to remove, as some backends can implement it as a batch request.

e_book_add_contact ()

gboolean    e_book_add_contact              (EBook *book,
                                             EContact *contact,
                                             GError **error);

adds contact to book.

e_book_commit_contact ()

gboolean    e_book_commit_contact           (EBook *book,
                                             EContact *contact,
                                             GError **error);

applies the changes made to contact to the stored version in book.

e_book_get_book_view ()

gboolean    e_book_get_book_view            (EBook *book,
                                             EBookQuery *query,
                                             GList *requested_fields,
                                             int max_results,
                                             EBookView **book_view,
                                             GError **error);

Query book with query, creating a EBookView in book_view with the fields specified by requested_fields and limited at max_results records. On an error, error is set and FALSE returned.

e_book_get_contacts ()

gboolean    e_book_get_contacts             (EBook *book,
                                             EBookQuery *query,
                                             GList **contacts,
                                             GError **error);

Query book with query, setting contacts to the list of contacts which matched. On failed, error will be set and FALSE returned.

e_book_get_changes ()

gboolean    e_book_get_changes              (EBook *book,
                                             char *changeid,
                                             GList **changes,
                                             GError **error);

e_book_free_change_list ()

void        e_book_free_change_list         (GList *change_list);

e_book_get_uri ()

const char* e_book_get_uri                  (EBook *book);

Get the URI that this book has loaded. This string should not be freed.

e_book_get_static_capabilities ()

const char* e_book_get_static_capabilities  (EBook *book,
                                             GError **error);

Get the list of capabilities which the backend for this address book supports. This string should not be freed.

e_book_check_static_capability ()

gboolean    e_book_check_static_capability  (EBook *book,
                                             const char *cap);

Check to see if the backend for this address book supports the capability cap.

e_book_is_writable ()

gboolean    e_book_is_writable              (EBook *book);

Check if this book is writable.

e_book_cancel ()

gboolean    e_book_cancel                   (EBook *book,
                                             GError **error);

Used to cancel an already running operation on book. This function makes a synchronous CORBA to the backend telling it to cancel the operation. If the operation wasn't cancellable (either transiently or permanently) or had already comopleted on the server side, this function will return E_BOOK_STATUS_COULD_NOT_CANCEL, and the operation will continue uncancelled. If the operation could be cancelled, this function will return E_BOOK_ERROR_OK, and the blocked e_book function corresponding to current operation will return with a status of E_BOOK_STATUS_CANCELLED.

e_book_get_self ()

gboolean    e_book_get_self                 (EContact **contact,
                                             EBook **book,
                                             GError **error);

e_book_set_self ()

gboolean    e_book_set_self                 (EBook *book,
                                             EContact *contact,
                                             GError **error);

e_book_is_self ()

gboolean    e_book_is_self                  (EContact *contact);

e_book_get_default_addressbook ()

gboolean    e_book_get_default_addressbook  (EBook **book,
                                             GError **error);

Convience function to open the default address book. Pass it the address of a EBook* and if this returns TRUE, book is set to an opened EBook.

e_book_get_addressbooks ()

gboolean    e_book_get_addressbooks         (ESourceList **addressbook_sources,
                                             GError **error);

Populate *addressbook_sources with the list of all sources which have been added to Evolution.

The "backend-died" signal

void        user_function                  (EBook *ebook,
                                            gpointer user_data);

The backend for this address book has died.

The "writable-status" signal

void        user_function                  (EBook *ebook,
                                            gboolean arg1,
                                            gpointer user_data);