|
|
|
Evolution-Data-Server Manual: Address Book Client (libebook) | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
struct EBook; EBook * e_book_new (ESource *source,GError **error); EBook * e_book_new_default_addressbook (GError **error); EBook * e_book_new_from_uri (const gchar *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 gchar *user,const gchar *passwd,const gchar *auth_method,GError **error); gboolean e_book_get_contact (EBook *book,const gchar *id,EContact **contact,GError **error); gboolean e_book_remove_contact (EBook *book,const gchar *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,gint 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,const gchar *changeid,GList **changes,GError **error); void e_book_free_change_list (GList *change_list); const gchar * e_book_get_uri (EBook *book); const gchar * e_book_get_static_capabilities (EBook *book,GError **error); gboolean e_book_check_static_capability (EBook *book,const gchar *cap); gboolean e_book_is_writable (EBook *book); gboolean e_book_cancel (EBook *book,GError **error); gboolean e_book_cancel_async_op (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); #define e_return_error_if_fail (expr, error_code) #define e_return_async_error_if_fail (expr, error) #define e_return_async_error_val_if_fail (expr, error) #define e_return_ex_async_error_if_fail (expr, error) #define e_return_ex_async_error_val_if_fail (expr, error) void (*EBookAsyncCallback) (EBook *book,const GError *error,gpointer closure); void (*EBookOpenProgressCallback) (EBook *book,const gchar *status_message,gshort percent,gpointer closure); void (*EBookIdAsyncCallback) (EBook *book,const GError *error,const gchar *id,gpointer closure); void (*EBookContactAsyncCallback) (EBook *book,const GError *error,EContact *contact,gpointer closure); void (*EBookListAsyncCallback) (EBook *book,const GError *error,GList *list,gpointer closure); void (*EBookBookViewAsyncCallback) (EBook *book,const GError *error,EBookView *book_view,gpointer closure); void (*EBookEListAsyncCallback) (EBook *book,const GError *error,EList *list,gpointer closure); void (*EBookCallback) (EBook *book,EBookStatus status,gpointer closure); void (*EBookIdCallback) (EBook *book,EBookStatus status,const gchar *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); gboolean e_book_open_async (EBook *book,gboolean only_if_exists,EBookAsyncCallback open_response,gpointer closure); gboolean e_book_remove_async (EBook *book,EBookAsyncCallback cb,gpointer closure); gboolean e_book_get_supported_fields_async (EBook *book,EBookEListAsyncCallback cb,gpointer closure); gboolean e_book_get_supported_auth_methods_async (EBook *book,EBookEListAsyncCallback cb,gpointer closure); gboolean e_book_authenticate_user_async (EBook *book,const gchar *user,const gchar *passwd,const gchar *auth_method,EBookAsyncCallback cb,gpointer closure); gboolean e_book_get_contact_async (EBook *book,const gchar *id,EBookContactAsyncCallback cb,gpointer closure); gboolean e_book_get_contacts_async (EBook *book,EBookQuery *query,EBookListAsyncCallback cb,gpointer closure); gboolean e_book_remove_contact_async (EBook *book,EContact *contact,EBookAsyncCallback cb,gpointer closure); gboolean e_book_remove_contact_by_id_async (EBook *book,const gchar *id,EBookAsyncCallback cb,gpointer closure); gboolean e_book_remove_contacts_async (EBook *book,GList *ids,EBookAsyncCallback cb,gpointer closure); gboolean e_book_add_contact_async (EBook *book,EContact *contact,EBookIdAsyncCallback cb,gpointer closure); gboolean e_book_commit_contact_async (EBook *book,EContact *contact,EBookAsyncCallback cb,gpointer closure); gboolean e_book_get_book_view_async (EBook *book,EBookQuery *query,GList *requested_fields,gint max_results,EBookBookViewAsyncCallback cb,gpointer closure); gboolean e_book_get_changes_async (EBook *book,const gchar *changeid,EBookListAsyncCallback cb,gpointer closure); gboolean e_book_get_required_fields_async (EBook *book,EBookEListAsyncCallback cb,gpointer closure); gboolean e_book_async_open (EBook *book,gboolean only_if_exists,EBookCallback open_response,gpointer closure); gboolean e_book_async_remove (EBook *book,EBookCallback cb,gpointer closure); gboolean e_book_async_get_supported_fields (EBook *book,EBookEListCallback cb,gpointer closure); gboolean e_book_async_get_supported_auth_methods (EBook *book,EBookEListCallback cb,gpointer closure); gboolean e_book_async_authenticate_user (EBook *book,const gchar *user,const gchar *passwd,const gchar *auth_method,EBookCallback cb,gpointer closure); gboolean e_book_async_get_contact (EBook *book,const gchar *id,EBookContactCallback cb,gpointer closure); gboolean e_book_async_get_contacts (EBook *book,EBookQuery *query,EBookListCallback cb,gpointer closure); gboolean e_book_async_remove_contact (EBook *book,EContact *contact,EBookCallback cb,gpointer closure); gboolean e_book_async_remove_contact_by_id (EBook *book,const gchar *id,EBookCallback cb,gpointer closure); gboolean 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); gboolean e_book_async_commit_contact (EBook *book,EContact *contact,EBookCallback cb,gpointer closure); gboolean e_book_async_get_book_view (EBook *book,EBookQuery *query,GList *requested_fields,gint max_results,EBookBookViewCallback cb,gpointer closure); gboolean e_book_async_get_changes (EBook *book,const gchar *changeid,EBookListCallback cb,gpointer closure); gboolean 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
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().
struct EBook;
EBook is deprecated and should not be used in newly-written code.
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().
EBook * e_book_new_default_addressbook (GError **error);
e_book_new_default_addressbook has been deprecated since version 3.2 and should not be used in newly-written code. Use e_book_client_new_default() instead.
Creates a new EBook corresponding to the user's default address book.
See the documentation for e_book_new() for further information.
EBook * e_book_new_from_uri (const gchar *uri,GError **error);
e_book_new_from_uri has been deprecated since version 3.2 and should not be used in newly-written code. Use e_book_client_new_from_uri() instead.
Creates a new EBook corresponding to the given uri. See the documentation for e_book_new for further information.
EBook * e_book_new_system_addressbook (GError **error);
e_book_new_system_addressbook has been deprecated since version 3.2 and should not be used in newly-written code. Use e_book_client_new_system() instead.
Creates a new EBook corresponding to the user's system address book.
See the documentation for e_book_new() for further information.
gboolean e_book_set_default_addressbook (EBook *book,GError **error);
e_book_set_default_addressbook has been deprecated since version 3.2 and should not be used in newly-written code. Use e_book_client_set_default_addressbook() instead.
sets the ESource of the EBook as the "default" addressbook. This is the source that will be loaded in the e_book_get_default_addressbook call.
gboolean e_book_set_default_source (ESource *source,GError **error);
e_book_set_default_source has been deprecated since version 3.2 and should not be used in newly-written code. Use e_book_client_set_default_source() instead.
Sets source as the default address book. This is the source that
will be loaded in the e_book_get_default_addressbook call.
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!
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.
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 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.
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. Use e_client_get_backend_property_sync() on
an EBookClient object with BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS instead.
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.
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 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.
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.
|
an EBook |
Returns : |
The source. [transfer none] |
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.
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.
gboolean e_book_authenticate_user (EBook *book,const gchar *user,const gchar *passwd,const gchar *auth_method,GError **error);
e_book_authenticate_user has been deprecated since version 3.2 and should not be used in newly-written code. Connect to EClient::authenticate signal instead.
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.
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.
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.
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.
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.
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.
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 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.
|
an EBook |
|
an EBookQuery |
|
a GList containing the names of fields to return, or NULL for all. [allow-none][element-type utf8] |
|
the maximum number of contacts to show (or 0 for all) |
|
A EBookView pointer, will be set to the view. [out] |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise |
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.
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.
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.
|
a GList of EBookChange items. [element-type EBookChange] |
const gchar * e_book_get_uri (EBook *book);
e_book_get_uri has been deprecated since version 3.2 and should not be used in newly-written code. Use e_client_get_uri() on an EBookClient object instead.
Get the URI that this book has loaded. This string should not be freed.
|
an EBook |
Returns : |
The URI. |
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.
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.
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.
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() or e_client_cancel_op() 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.
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() or e_client_cancel_op() on an EBookClient object instead.
Similar to above e_book_cancel function, only cancels last, still running, asynchronous operation.
Since 2.24
gboolean e_book_get_self (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.
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.
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.
gboolean e_book_get_addressbooks (ESourceList **addressbook_sources,GError **error);
e_book_get_addressbooks has been deprecated since version 3.2 and should not be used in newly-written code. Use e_book_client_get_sources() instead.
Populate *addressbook_sources with the list of all sources which have been added to Evolution.
#define e_return_error_if_fail(expr,error_code)
FIXME Document me!
Since 2.30
#define e_return_ex_async_error_val_if_fail(expr, error)
Since 2.32
void (*EBookAsyncCallback) (EBook *book,const GError *error,gpointer closure);
EBookAsyncCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookOpenProgressCallback) (EBook *book,const gchar *status_message,gshort percent,gpointer closure);
EBookOpenProgressCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookIdAsyncCallback) (EBook *book,const GError *error,const gchar *id,gpointer closure);
EBookIdAsyncCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookContactAsyncCallback) (EBook *book,const GError *error,EContact *contact,gpointer closure);
EBookContactAsyncCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookListAsyncCallback) (EBook *book,const GError *error,GList *list,gpointer closure);
EBookListAsyncCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookBookViewAsyncCallback) (EBook *book,const GError *error,EBookView *book_view,gpointer closure);
EBookBookViewAsyncCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookEListAsyncCallback) (EBook *book,const GError *error,EList *list,gpointer closure);
EBookEListAsyncCallback is deprecated and should not be used in newly-written code.
Since 2.32
void (*EBookCallback) (EBook *book,EBookStatus status,gpointer closure);
EBookCallback is deprecated and should not be used in newly-written code.
void (*EBookIdCallback) (EBook *book,EBookStatus status,const gchar *id,gpointer closure);
EBookIdCallback is deprecated and should not be used in newly-written code.
void (*EBookEListCallback) (EBook *book,EBookStatus status,EList *list,gpointer closure);
EBookEListCallback is deprecated and should not be used in newly-written code.
void (*EBookListCallback) (EBook *book,EBookStatus status,GList *list,gpointer closure);
EBookListCallback is deprecated and should not be used in newly-written code.
void (*EBookContactCallback) (EBook *book,EBookStatus status,EContact *contact,gpointer closure);
EBookContactCallback is deprecated and should not be used in newly-written code.
void (*EBookBookViewCallback) (EBook *book,EBookStatus status,EBookView *book_view,gpointer closure);
EBookBookViewCallback is deprecated and should not be used in newly-written code.
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.
|
an EBook |
|
if TRUE, fail if this book doesn't already exist, otherwise create it first |
|
a function to call when the operation finishes. [scope call] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise. |
Since 2.32
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!
|
an EBook |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise. |
Since 2.32
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 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.
|
an EBook |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 2.32
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. Use e_client_get_backend_property() and e_client_get_backend_property_finish()
on an EBookClient object with BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS instead.
Queries book for the list of authentication methods it supports.
This function does not block.
|
an EBook |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 2.32
gboolean e_book_authenticate_user_async (EBook *book,const gchar *user,const gchar *passwd,const gchar *auth_method,EBookAsyncCallback cb,gpointer closure);
e_book_authenticate_user_async has been deprecated since version 3.2 and should not be used in newly-written code. Connect to EClient::authenticate signal instead.
Authenticate 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.
This function does not block.
|
an EBook |
|
user name |
|
password |
|
string indicating authentication method |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise. |
Since 2.32
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.
|
an EBook |
|
a unique string ID specifying the contact |
|
function to call when operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise |
Since 2.32
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.
|
an EBook |
|
an EBookQuery |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
FALSE on success, TRUE otherwise |
Since 2.32
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.
|
an EBook |
|
an EContact |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise |
Since 2.32
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.
|
an EBook |
|
a unique ID string specifying the contact |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise |
Since 2.32
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.
|
an EBook |
|
a GList of const gchar *id's. [element-type utf8] |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise |
Since 2.32
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.
|
an EBook |
|
an EContact |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if the operation was started, FALSE otherwise. |
Since 2.32
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.
|
an EBook |
|
an EContact |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if the operation was started, FALSE otherwise. |
Since 2.32
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 a EBookView with the fields
specified by requested_fields and limited at max_results records.
|
an EBook |
|
an EBookQuery |
|
a GList containing the names of fields to return, or NULL for all. [allow-none][element-type utf8] |
|
the maximum number of contacts to show (or 0 for all) |
|
a function to call when the operation finishes. [scope call] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise |
Since 2.32
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.
|
an EBook |
|
the change ID |
|
function to call when operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE on success, FALSE otherwise |
Since 2.32
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 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.
|
an EBook |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if the operation was started, FALSE otherwise. |
Since 2.32
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.
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!
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.
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. Use e_book_get_supported_auth_methods_async() instead.
Queries book for the list of authentication methods it supports.
This function does not block.
gboolean e_book_async_authenticate_user (EBook *book,const gchar *user,const gchar *passwd,const gchar *auth_method,EBookCallback cb,gpointer closure);
e_book_async_authenticate_user has been deprecated since version 3.0 and should not be used in newly-written code. Use e_book_authenticate_user_async() instead.
Authenticate 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.
This function does not block.
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.
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.
|
an EBook |
|
an EBookQuery |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
FALSE on success, TRUE otherwise |
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.
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.
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.
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.
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.
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 a EBookView with the fields
specified by requested_fields and limited at max_results records.
|
an EBook |
|
an EBookQuery |
|
a GList containing the names of fields to return, or NULL for all. [element-type utf8] |
|
the maximum number of contacts to show (or 0 for all) |
|
a function to call when the operation finishes. [scope call] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise |
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.
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.