EBook: Evolution-Data-Server Reference Manual

## EBook EBook |

## Functions

void | (*EBookCallback) ()
void | (*EBookAsyncCallback) ()
void | (*EBookOpenProgressCallback) ()
void | (*EBookIdCallback) ()
void | (*EBookContactCallback) ()
void | (*EBookListCallback) ()
void | (*EBookBookViewCallback) ()
void | (*EBookEListCallback) ()
void | (*EBookIdAsyncCallback) ()
void | (*EBookContactAsyncCallback) ()
void | (*EBookListAsyncCallback) ()
void | (*EBookBookViewAsyncCallback) ()
void | (*EBookEListAsyncCallback) ()
EBook * | e_book_new ()
gboolean | e_book_open ()
gboolean | e_book_async_open ()
gboolean | e_book_open_async ()
gboolean | e_book_remove ()
gboolean | e_book_async_remove ()
gboolean | e_book_remove_async ()
gboolean | e_book_get_required_fields ()
gboolean | e_book_async_get_required_fields ()
gboolean | e_book_get_required_fields_async ()
gboolean | e_book_get_supported_fields ()
gboolean | e_book_async_get_supported_fields ()
gboolean | e_book_get_supported_fields_async ()
gboolean | e_book_get_supported_auth_methods ()
gboolean | e_book_async_get_supported_auth_methods ()
gboolean | e_book_get_supported_auth_methods_async ()
gboolean | e_book_get_contact ()
gboolean | e_book_async_get_contact ()
gboolean | e_book_get_contact_async ()
gboolean | e_book_remove_contact ()
gboolean | e_book_async_remove_contact ()
gboolean | e_book_async_remove_contact_by_id ()
gboolean | e_book_remove_contact_async ()
gboolean | e_book_remove_contact_by_id_async ()
gboolean | e_book_remove_contacts ()
gboolean | e_book_async_remove_contacts ()
gboolean | e_book_remove_contacts_async ()
gboolean | e_book_add_contact ()
gboolean | e_book_async_add_contact ()
gboolean | e_book_add_contact_async ()
gboolean | e_book_commit_contact ()
gboolean | e_book_async_commit_contact ()
gboolean | e_book_commit_contact_async ()
gboolean | e_book_get_book_view ()
gboolean | e_book_async_get_book_view ()
gboolean | e_book_get_book_view_async ()
gboolean | e_book_get_contacts ()
gboolean | e_book_async_get_contacts ()
gboolean | e_book_get_contacts_async ()
gboolean | e_book_get_changes ()
gboolean | e_book_async_get_changes ()
gboolean | e_book_get_changes_async ()
void | e_book_free_change_list ()
ESource * | e_book_get_source ()
const gchar * | e_book_get_static_capabilities ()
gboolean | e_book_check_static_capability ()
gboolean | e_book_is_opened ()
gboolean | e_book_is_writable ()
gboolean | e_book_is_online ()
gboolean | e_book_cancel ()
gboolean | e_book_cancel_async_op ()
gboolean | e_book_get_self ()
gboolean | e_book_set_self ()
gboolean | e_book_is_self ()

## Properties

ESource * | source | Read / Write / Construct Only

## Signals

void | backend-died | Run Last
void | connection-status | Run Last
void | writable-status | Run Last

## Types and Values

struct | EBook
struct | EBookClass

## Object Hierarchy

        GObject
        ╰── EBook

## Implemented Interfaces

EBook implements GInitable.

## Description

The old asynchronous API was deprecated since 3.0 and is replaced with their an equivalent version which has a detailed GError structure in the asynchronous callback, instead of a status code only.

As an example, `e_book_async_open()` is replaced by `e_book_open_async()`.

## Functions

### EBookCallback ()

    void
    (*EBookCallback) (EBook *book,
                      EBookStatus status,
                      gpointer closure);

`EBookCallback` is deprecated and should not be used in newly-written code.

### EBookAsyncCallback ()

    void
    (*EBookAsyncCallback) (EBook *book,
                           const GError *error,
                           gpointer closure);

`EBookAsyncCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
error | a GError or `NULL` |
closure | the callback closure |

Since: 2.32

### EBookOpenProgressCallback ()

    void
    (*EBookOpenProgressCallback) (EBook *book,
                                  const gchar *status_message,
                                  gshort percent,
                                  gpointer closure);

`EBookOpenProgressCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
status_message | a status message |
percent | percent complete (0 - 100) |
closure | the callback closure |

Since: 2.32

### EBookIdCallback ()

    void
    (*EBookIdCallback) (EBook *book,
                        EBookStatus status,
                        const gchar *id,
                        gpointer closure);

`EBookIdCallback` is deprecated and should not be used in newly-written code.

### EBookContactCallback ()

    void
    (*EBookContactCallback) (EBook *book,
                             EBookStatus status,
                             EContact *contact,
                             gpointer closure);

`EBookContactCallback` is deprecated and should not be used in newly-written code.

### EBookListCallback ()

    void
    (*EBookListCallback) (EBook *book,
                          EBookStatus status,
                          GList *list,
                          gpointer closure);

`EBookListCallback` is deprecated and should not be used in newly-written code.

### EBookBookViewCallback ()

    void
    (*EBookBookViewCallback) (EBook *book,
                              EBookStatus status,
                              EBookView *book_view,
                              gpointer closure);

`EBookBookViewCallback` is deprecated and should not be used in newly-written code.

### EBookEListCallback ()

    void
    (*EBookEListCallback) (EBook *book,
                           EBookStatus status,
                           EList *list,
                           gpointer closure);

`EBookEListCallback` is deprecated and should not be used in newly-written code.

### EBookIdAsyncCallback ()

    void
    (*EBookIdAsyncCallback) (EBook *book,
                             const GError *error,
                             const gchar *id,
                             gpointer closure);

`EBookIdAsyncCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
error | a GError or `NULL` |
id | a contact ID |
closure | the callback closure |

Since: 2.32

### EBookContactAsyncCallback ()

    void
    (*EBookContactAsyncCallback) (EBook *book,
                                  const GError *error,
                                  EContact *contact,
                                  gpointer closure);

`EBookContactAsyncCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
error | a GError or `NULL` |
contact | an EContact or `NULL` |
closure | the callback closure |

Since: 2.32

### EBookListAsyncCallback ()

    void
    (*EBookListAsyncCallback) (EBook *book,
                               const GError *error,
                               GList *list,
                               gpointer closure);

`EBookListAsyncCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
error | a GError or `NULL` |
list | a GList of results |
closure | the callback closure |

Since: 2.32

### EBookBookViewAsyncCallback ()

    void
    (*EBookBookViewAsyncCallback) (EBook *book,
                                   const GError *error,
                                   EBookView *book_view,
                                   gpointer closure);

`EBookBookViewAsyncCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
error | a GError or `NULL` |
book_view | an EBookView |
closure | the callback closure |

Since: 2.32

### EBookEListAsyncCallback ()

    void
    (*EBookEListAsyncCallback) (EBook *book,
                                const GError *error,
                                EList *list,
                                gpointer closure);

`EBookEListAsyncCallback` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

#### Parameters

book | an EBook |
error | a GError or `NULL` |
list | an EList of results |
closure | the callback closure |

Since: 2.32

### e_book_new ()

    EBook *
    e_book_new (ESource *source,
                GError **error);

`e_book_new` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_new()` instead.

Creates a new EBook corresponding to the given `source` . There are only two operations that are valid on this book at this point: `e_book_open()`, and `e_book_remove()`.

#### Parameters

source | an ESource |
error | return location for a GError, or `NULL` |

#### Returns

a new but unopened EBook.

### e_book_open ()

    gboolean
    e_book_open (EBook *book,
                 gboolean only_if_exists,
                 GError **error);

`e_book_open` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_open_sync()` on an EBookClient object instead.

Opens the addressbook, making it ready for queries and other operations.

#### Parameters

book | an EBook |
only_if_exists | if `TRUE`, fail if this book doesn't already exist, otherwise create it first |
error | a GError to set on failure |

#### Returns

`TRUE` if the book was successfully opened, `FALSE` otherwise.

### e_book_async_open ()

    gboolean
    e_book_async_open (EBook *book,
                       gboolean only_if_exists,
                       EBookCallback open_response,
                       gpointer closure);

`e_book_async_open` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_open_async()` instead.

Opens the addressbook, making it ready for queries and other operations. This function does not block.

#### Parameters

book | an EBook |
only_if_exists | if `TRUE`, fail if this book doesn't already exist, otherwise create it first |
open_response | a function to call when the operation finishes. | [scope call][closure closure]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_open_async ()

    gboolean
    e_book_open_async (EBook *book,
                       gboolean only_if_exists,
                       EBookAsyncCallback open_response,
                       gpointer closure);

`e_book_open_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_open()` and `e_client_open_finish()` on an EBookClient object instead.

Opens the addressbook, making it ready for queries and other operations. This function does not block.

#### Parameters

book | an EBook |
only_if_exists | if `TRUE`, fail if this book doesn't already exist, otherwise create it first |
open_response | a function to call when the operation finishes. | [scope call]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_remove ()

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

`e_book_remove` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_remove_sync()` on an EBookClient object instead.

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

#### Parameters

book | an EBook |
error | a GError to set on failure |

#### Returns

`TRUE` on success, `FALSE` on failure.

### e_book_async_remove ()

    gboolean
    e_book_async_remove (EBook *book,
                         EBookCallback cb,
                         gpointer closure);

`e_book_async_remove` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_remove_async()` instead.

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

#### Parameters

book | an EBook |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_remove_async ()

    gboolean
    e_book_remove_async (EBook *book,
                         EBookAsyncCallback cb,
                         gpointer closure);

`e_book_remove_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_remove()` and `e_client_remove_finish()` on an EBookClient object instead.

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

#### Parameters

book | an EBook |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_get_required_fields ()

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

`e_book_get_required_fields` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_get_backend_property_sync()` on an EBookClient object with E_BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS instead.

Gets a list of fields that are required to be filled in for all contacts in this `book` . The list will contain pointers to allocated strings, and both the GList and the strings must be freed by the caller.

#### Parameters

book | an EBook |
fields | a GList of fields to set on success. | [out][transfer full][element-type utf8]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

### e_book_async_get_required_fields ()

    gboolean
    e_book_async_get_required_fields (EBook *book,
                                      EBookEListCallback cb,
                                      gpointer closure);

`e_book_async_get_required_fields` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_get_required_fields_async()` instead.

Gets a list of fields that are required to be filled in for all contacts in this `book` . This function does not block.

#### Parameters

book | an EBook |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if the operation was started, `FALSE` otherwise.

### e_book_get_required_fields_async ()

    gboolean
    e_book_get_required_fields_async (EBook *book,
                                      EBookEListAsyncCallback cb,
                                      gpointer closure);

`e_book_get_required_fields_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_get_backend_property()` and `e_client_get_backend_property_finish()` on an EBookClient object with E_BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS instead.

Gets a list of fields that are required to be filled in for all contacts in this `book` . This function does not block.

#### Parameters

book | an EBook |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if the operation was started, `FALSE` otherwise.

Since: 2.32

### e_book_get_supported_fields ()

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

`e_book_get_supported_fields` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_get_backend_property_sync()` on an EBookClient object with E_BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS instead.

Gets a list of fields that can be stored for contacts in this `book` . Other fields may be discarded. The list will contain pointers to allocated strings, and both the GList and the strings must be freed by the caller.

#### Parameters

book | an EBook |
fields | a GList of fields to set on success. | [out][transfer full][element-type utf8]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_get_supported_fields ()

    gboolean
    e_book_async_get_supported_fields (EBook *book,
                                       EBookEListCallback cb,
                                       gpointer closure);

`e_book_async_get_supported_fields` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_get_supported_fields_async()` instead.

Gets a list of fields that can be stored for contacts in this `book` . Other fields may be discarded. This function does not block.

#### Parameters

book | an EBook |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

### e_book_get_supported_fields_async ()

    gboolean
    e_book_get_supported_fields_async (EBook *book,
                                       EBookEListAsyncCallback cb,
                                       gpointer closure);

`e_book_get_supported_fields_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_get_backend_property()` and `e_client_get_backend_property_finish()` on an EBookClient object with E_BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS instead.

Gets a list of fields that can be stored for contacts in this `book` . Other fields may be discarded. This function does not block.

#### Parameters

book | an EBook |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

Since: 2.32

### e_book_get_supported_auth_methods ()

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

`e_book_get_supported_auth_methods` has been deprecated since version 3.2 and should not be used in newly-written code.

The property is no longer supported.

Queries `book` for the list of authentication methods it supports. The list will contain pointers to allocated strings, and both the GList and the strings must be freed by the caller.

#### Parameters

book | an EBook |
auth_methods | a GList of auth methods to set on success. | [out][transfer full][element-type utf8]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_get_supported_auth_methods ()

    gboolean
    e_book_async_get_supported_auth_methods
                                   (EBook *book,
                                    EBookEListCallback cb,
                                    gpointer closure);

`e_book_async_get_supported_auth_methods` has been deprecated since version 3.0 and should not be used in newly-written code.

The property is no longer supported.

Queries `book` for the list of authentication methods it supports. This function does not block.

#### Parameters

book | an EBook |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

### e_book_get_supported_auth_methods_async ()

    gboolean
    e_book_get_supported_auth_methods_async
                                   (EBook *book,
                                    EBookEListAsyncCallback cb,
                                    gpointer closure);

`e_book_get_supported_auth_methods_async` has been deprecated since version 3.2 and should not be used in newly-written code.

The property is no longer supported.

Queries `book` for the list of authentication methods it supports. This function does not block.

#### Parameters

book | an EBook |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

Since: 2.32

### e_book_get_contact ()

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

`e_book_get_contact` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_contact_sync()` instead.

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

#### Parameters

book | an EBook |
id | a unique string ID specifying the contact |
contact | an EContact. | [out][transfer full]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_get_contact ()

    gboolean
    e_book_async_get_contact (EBook *book,
                              const gchar *id,
                              EBookContactCallback cb,
                              gpointer closure);

`e_book_async_get_contact` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_get_contact_async()` instead.

Retrieves a contact specified by `id` from `book` .

#### Parameters

book | an EBook |
id | a unique string ID specifying the contact |
cb | function to call when operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_get_contact_async ()

    gboolean
    e_book_get_contact_async (EBook *book,
                              const gchar *id,
                              EBookContactAsyncCallback cb,
                              gpointer closure);

`e_book_get_contact_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_contact()` and `e_book_client_get_contact_finish()` instead.

Retrieves a contact specified by `id` from `book` .

#### Parameters

book | an EBook |
id | a unique string ID specifying the contact |
cb | function to call when operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_remove_contact ()

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

`e_book_remove_contact` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_remove_contact_by_uid_sync()` or `e_book_client_remove_contact_sync()` instead.

Removes the contact with id `id` from `book` .

#### Parameters

book | an EBook |
id | a string |
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_remove_contact ()

    gboolean
    e_book_async_remove_contact (EBook *book,
                                 EContact *contact,
                                 EBookCallback cb,
                                 gpointer closure);

`e_book_async_remove_contact` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_remove_contact_async()` instead.

Removes `contact` from `book` .

#### Parameters

book | an EBook |
contact | an EContact |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_remove_contact_by_id ()

    gboolean
    e_book_async_remove_contact_by_id (EBook *book,
                                       const gchar *id,
                                       EBookCallback cb,
                                       gpointer closure);

`e_book_async_remove_contact_by_id` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_remove_contact_by_id_async()` instead.

Removes the contact with id `id` from `book` .

#### Parameters

book | an EBook |
id | a unique ID string specifying the contact |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_remove_contact_async ()

    gboolean
    e_book_remove_contact_async (EBook *book,
                                 EContact *contact,
                                 EBookAsyncCallback cb,
                                 gpointer closure);

`e_book_remove_contact_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_remove_contact()` and `e_book_client_remove_contact_finish()` instead.

Removes `contact` from `book` .

#### Parameters

book | an EBook |
contact | an EContact |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_remove_contact_by_id_async ()

    gboolean
    e_book_remove_contact_by_id_async (EBook *book,
                                       const gchar *id,
                                       EBookAsyncCallback cb,
                                       gpointer closure);

`e_book_remove_contact_by_id_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_remove_contact_by_uid()` and `e_book_client_remove_contact_by_uid_finish()` instead.

Removes the contact with id `id` from `book` .

#### Parameters

book | an EBook |
id | a unique ID string specifying the contact |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_remove_contacts ()

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

`e_book_remove_contacts` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_remove_contacts_sync()` instead.

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

#### Parameters

book | an EBook |
ids | an GList of const gchar *id's. | [element-type utf8]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_remove_contacts ()

    gboolean
    e_book_async_remove_contacts (EBook *book,
                                  GList *ids,
                                  EBookCallback cb,
                                  gpointer closure);

`e_book_async_remove_contacts` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_remove_contacts_async()` instead.

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

#### Parameters

book | an EBook |
ids | a GList of const gchar *id's. | [element-type utf8]
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_remove_contacts_async ()

    gboolean
    e_book_remove_contacts_async (EBook *book,
                                  GList *ids,
                                  EBookAsyncCallback cb,
                                  gpointer closure);

`e_book_remove_contacts_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_remove_contacts()` and `e_book_client_remove_contacts_finish()` instead.

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

#### Parameters

book | an EBook |
ids | a GList of const gchar *id's. | [element-type utf8]
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_add_contact ()

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

`e_book_add_contact` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_add_contact_sync()` instead.

Adds `contact` to `book` .

#### Parameters

book | an EBook |
contact | an EContact |
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

### e_book_async_add_contact ()

    gboolean
    e_book_async_add_contact (EBook *book,
                              EContact *contact,
                              EBookIdCallback cb,
                              gpointer closure);

`e_book_async_add_contact` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_add_contact_async()` instead.

Adds `contact` to `book` without blocking.

#### Parameters

book | an EBook |
contact | an EContact |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if the operation was started, `FALSE` otherwise.

### e_book_add_contact_async ()

    gboolean
    e_book_add_contact_async (EBook *book,
                              EContact *contact,
                              EBookIdAsyncCallback cb,
                              gpointer closure);

`e_book_add_contact_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_add_contact()` and `e_book_client_add_contact_finish()` instead.

Adds `contact` to `book` without blocking.

#### Parameters

book | an EBook |
contact | an EContact |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if the operation was started, `FALSE` otherwise.

Since: 2.32

### e_book_commit_contact ()

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

`e_book_commit_contact` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_modify_contact_sync()` instead.

Applies the changes made to `contact` to the stored version in `book` .

#### Parameters

book | an EBook |
contact | an EContact |
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_commit_contact ()

    gboolean
    e_book_async_commit_contact (EBook *book,
                                 EContact *contact,
                                 EBookCallback cb,
                                 gpointer closure);

`e_book_async_commit_contact` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_commit_contact_async()` instead.

Applies the changes made to `contact` to the stored version in `book` without blocking.

#### Parameters

book | an EBook |
contact | an EContact |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if the operation was started, `FALSE` otherwise.

### e_book_commit_contact_async ()

    gboolean
    e_book_commit_contact_async (EBook *book,
                                 EContact *contact,
                                 EBookAsyncCallback cb,
                                 gpointer closure);

`e_book_commit_contact_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_modify_contact()` and `e_book_client_modify_contact_finish()` instead.

Applies the changes made to `contact` to the stored version in `book` without blocking.

#### Parameters

book | an EBook |
contact | an EContact |
cb | function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if the operation was started, `FALSE` otherwise.

Since: 2.32

### e_book_get_book_view ()

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

`e_book_get_book_view` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_view_sync()` instead.

Query `book` with `query` , creating an 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.

#### Parameters

book | an EBook |
query | an EBookQuery |
requested_fields | a GList containing the names of fields to return, or NULL for all. | [allow-none][element-type utf8]
max_results | the maximum number of contacts to show (or 0 for all) |
book_view | An EBookView pointer, will be set to the view. | [out]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_async_get_book_view ()

    gboolean
    e_book_async_get_book_view (EBook *book,
                                EBookQuery *query,
                                GList *requested_fields,
                                gint max_results,
                                EBookBookViewCallback cb,
                                gpointer closure);

`e_book_async_get_book_view` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_get_book_view_async()` instead.

Query `book` with `query` , creating an EBookView with the fields specified by `requested_fields` and limited at `max_results` records.

#### Parameters

book | an EBook |
query | an EBookQuery |
requested_fields | a GList containing the names of fields to return, or NULL for all. | [element-type utf8]
max_results | the maximum number of contacts to show (or 0 for all) |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

### e_book_get_book_view_async ()

    gboolean
    e_book_get_book_view_async (EBook *book,
                                EBookQuery *query,
                                GList *requested_fields,
                                gint max_results,
                                EBookBookViewAsyncCallback cb,
                                gpointer closure);

`e_book_get_book_view_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_view()` and `e_book_client_get_view_finish()` instead.

Query `book` with `query` , creating an EBookView with the fields specified by `requested_fields` and limited at `max_results` records.

#### Parameters

book | an EBook |
query | an EBookQuery |
requested_fields | a GList containing the names of fields to return, or NULL for all. | [allow-none][element-type utf8]
max_results | the maximum number of contacts to show (or 0 for all) |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` if successful, `FALSE` otherwise

Since: 2.32

### e_book_get_contacts ()

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

`e_book_get_contacts` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_contacts_sync()` instead.

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

#### Parameters

book | an EBook |
query | an EBookQuery |
contacts | a GList pointer, will be set to the list of contacts. | [element-type utf8]
error | a GError to set on failure |

#### Returns

`TRUE` on success, `FALSE` otherwise

### e_book_async_get_contacts ()

    gboolean
    e_book_async_get_contacts (EBook *book,
                               EBookQuery *query,
                               EBookListCallback cb,
                               gpointer closure);

`e_book_async_get_contacts` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_get_contacts_async()` instead.

Query `book` with `query` .

#### Parameters

book | an EBook |
query | an EBookQuery |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`FALSE` on success, `TRUE` otherwise

### e_book_get_contacts_async ()

    gboolean
    e_book_get_contacts_async (EBook *book,
                               EBookQuery *query,
                               EBookListAsyncCallback cb,
                               gpointer closure);

`e_book_get_contacts_async` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_contacts()` and `e_book_client_get_contacts_finish()` instead.

Query `book` with `query` .

#### Parameters

book | an EBook |
query | an EBookQuery |
cb | a function to call when the operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`FALSE` on success, `TRUE` otherwise

Since: 2.32

### e_book_get_changes ()

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

`e_book_get_changes` has been deprecated since version 3.2 and should not be used in newly-written code.

This function has been dropped completely.

Get the set of changes since the previous call to `e_book_get_changes()` for a given change ID.

[skip]

#### Parameters

book | an EBook |
changeid | the change ID |
changes | return location for a GList of EBookChange items. | [out][transfer full]
error | a GError to set on failure. |

#### Returns

`TRUE` on success, `FALSE` otherwise

### e_book_async_get_changes ()

    gboolean
    e_book_async_get_changes (EBook *book,
                              const gchar *changeid,
                              EBookListCallback cb,
                              gpointer closure);

`e_book_async_get_changes` has been deprecated since version 3.0 and should not be used in newly-written code.

Use `e_book_get_changes_async()` instead.

Get the set of changes since the previous call to `e_book_async_get_changes()` for a given change ID.

#### Parameters

book | an EBook |
changeid | the change ID |
cb | function to call when operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` on success, `FALSE` otherwise

### e_book_get_changes_async ()

    gboolean
    e_book_get_changes_async (EBook *book,
                              const gchar *changeid,
                              EBookListAsyncCallback cb,
                              gpointer closure);

`e_book_get_changes_async` has been deprecated since version 3.2 and should not be used in newly-written code.

This function has been dropped completely.

Get the set of changes since the previous call to `e_book_async_get_changes()` for a given change ID.

#### Parameters

book | an EBook |
changeid | the change ID |
cb | function to call when operation finishes. | [scope async]
closure | data to pass to callback function |

#### Returns

`TRUE` on success, `FALSE` otherwise

Since: 2.32

### e_book_free_change_list ()

    void
    e_book_free_change_list (GList *change_list);

`e_book_free_change_list` has been deprecated since version 3.2 and should not be used in newly-written code.

Related function has been dropped completely.

Free the contents of change_list, and the list itself.

#### Parameters

change_list | a GList of EBookChange items. | [element-type EBookChange]

### e_book_get_source ()

    ESource *
    e_book_get_source (EBook *book);

`e_book_get_source` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_get_source()` on an EBookClient object instead.

Get the ESource that this book has loaded.

#### Parameters

book | an EBook |

#### Returns

The source.

[transfer none]

### e_book_get_static_capabilities ()

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

`e_book_get_static_capabilities` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_get_capabilities()` on an EBookClient object.

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

#### Parameters

book | an EBook |
error | an GError to set on failure |

#### Returns

The capabilities list

### e_book_check_static_capability ()

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

`e_book_check_static_capability` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_check_capability()` on an EBookClient object instead.

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

#### Parameters

book | an EBook |
cap | A capability string |

#### Returns

`TRUE` if the backend supports `cap` , `FALSE` otherwise.

### e_book_is_opened ()

    gboolean
    e_book_is_opened (EBook *book);

`e_book_is_opened` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_is_opened()` on an EBookClient object instead.

Check if this book has been opened.

#### Parameters

book | and EBook |

#### Returns

`TRUE` if this book has been opened, otherwise `FALSE`.

### e_book_is_writable ()

    gboolean
    e_book_is_writable (EBook *book);

`e_book_is_writable` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_is_readonly()` on an EBookClient object instead.

Check if this book is writable.

#### Parameters

book | an EBook |

#### Returns

`TRUE` if this book is writable, otherwise `FALSE`.

### e_book_is_online ()

    gboolean
    e_book_is_online (EBook *book);

`e_book_is_online` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_is_online()` on an EBookClient object instead.

Check if this book is connected.

#### Parameters

book | an EBook |

#### Returns

`TRUE` if this book is connected, otherwise `FALSE`.

### e_book_cancel ()

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

`e_book_cancel` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_cancel_all()` on an EBookClient object instead.

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.

#### Parameters

book | an EBook |
error | a GError to set on failure |

#### Returns

`TRUE` on success, `FALSE` otherwise

### e_book_cancel_async_op ()

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

`e_book_cancel_async_op` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_client_cancel_all()` on an EBookClient object instead.

Similar to above e_book_cancel function, only cancels last, still running, asynchronous operation.

#### Parameters

book | an EBook |
error | return location for a GError, or `NULL` |

#### Returns

`TRUE` on success, `FALSE` otherwise

Since: 2.24

### e_book_get_self ()

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

`e_book_get_self` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_get_self()` instead.

Get the EContact referring to the user of the address book and set it in `contact` and `book` .

#### Parameters

registry | an ESourceRegistry |
contact | an EContact pointer to set. | [out]
book | an EBook pointer to set. | [out]
error | a GError to set on failure |

#### Returns

`TRUE` if successful, otherwise `FALSE`.

### e_book_set_self ()

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

`e_book_set_self` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_set_self()` instead.

Specify that `contact` residing in `book` is the EContact that refers to the user of the address book.

#### Parameters

book | an EBook |
contact | an EContact |
error | a GError to set on failure |

#### Returns

`TRUE` if successful, `FALSE` otherwise.

### e_book_is_self ()

    gboolean
    e_book_is_self (EContact *contact);

`e_book_is_self` has been deprecated since version 3.2 and should not be used in newly-written code.

Use `e_book_client_is_self()` instead.

Check if `contact` is the user of the address book.

#### Parameters

contact | an EContact |

#### Returns

`TRUE` if `contact` is the user, `FALSE` otherwise.

## Types and Values

### struct EBook

    struct EBook;

`EBook` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

The deprecated API for accessing the addressbook

Since: 2.32

### struct EBookClass

    struct EBookClass {
    	/*
    	 * Signals.
    	 */
    	void (* writable_status) (EBook *book, gboolean writable);
    	void (* connection_status) (EBook *book, gboolean connected);
    	void (* backend_died)    (EBook *book);
    };

`EBookClass` has been deprecated since version 3.2 and should not be used in newly-written code.

Use EBookClient instead

Class structure for the deprecated API for accessing the addressbook

#### Members

`writable_status` () | deprecated |
`connection_status` () | deprecated |
`backend_died` () | deprecated |

Since: 2.32

## Property Details

### The `“source”` property

      “source”                   ESource *

The data source for this EBook.

Owner: EBook

Flags: Read / Write / Construct Only

## Signal Details

### The `“backend-died”` signal

    void
    user_function (EBook   *ebook,
                   gpointer user_data)

Flags: Run Last

### The `“connection-status”` signal

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

Flags: Run Last

### The `“writable-status”` signal

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

Flags: Run Last