EBookClient

EBookClient

Synopsis

#define             BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS
#define             BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS
#define             BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS
#define             E_BOOK_CLIENT_ERROR
enum                EBookClientError;
const gchar *	      e_book_client_error_to_string       (EBookClientError code);
GError *	           e_book_client_error_create          (EBookClientError code,
                                                         const gchar *custom_msg);
struct              EBookClient;
EBookClient *	      e_book_client_new                   (ESource *source,
                                                         GError **error);
EBookClient *	      e_book_client_new_from_uri          (const gchar *uri,
                                                         GError **error);
EBookClient *	      e_book_client_new_system            (GError **error);
EBookClient *	      e_book_client_new_default           (GError **error);
gboolean            e_book_client_set_default           (EBookClient *client,
                                                         GError **error);
gboolean            e_book_client_set_default_source    (ESource *source,
                                                         GError **error);
gboolean            e_book_client_get_sources           (ESourceList **sources,
                                                         GError **error);
gboolean            e_book_client_get_self              (EContact **contact,
                                                         EBookClient **client,
                                                         GError **error);
gboolean            e_book_client_set_self              (EBookClient *client,
                                                         EContact *contact,
                                                         GError **error);
gboolean            e_book_client_is_self               (EContact *contact);
void                e_book_client_add_contact           (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_add_contact_finish    (EBookClient *client,
                                                         GAsyncResult *result,
                                                         gchar **added_uid,
                                                         GError **error);
gboolean            e_book_client_add_contact_sync      (EBookClient *client,
                                                         EContact *contact,
                                                         gchar **added_uid,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_add_contacts          (EBookClient *client,
                                                         GSList *contacts,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_add_contacts_finish   (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GSList **added_uids,
                                                         GError **error);
gboolean            e_book_client_add_contacts_sync     (EBookClient *client,
                                                         GSList *contacts,
                                                         GSList **added_uids,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_modify_contact        (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_modify_contact_finish (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            e_book_client_modify_contact_sync   (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_modify_contacts       (EBookClient *client,
                                                         GSList *contacts,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_modify_contacts_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            e_book_client_modify_contacts_sync  (EBookClient *client,
                                                         GSList *contacts,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_remove_contact        (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_remove_contact_finish (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            e_book_client_remove_contact_sync   (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_remove_contact_by_uid (EBookClient *client,
                                                         const gchar *uid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_remove_contact_by_uid_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            e_book_client_remove_contact_by_uid_sync
                                                        (EBookClient *client,
                                                         const gchar *uid,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_remove_contacts       (EBookClient *client,
                                                         const GSList *uids,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_remove_contacts_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            e_book_client_remove_contacts_sync  (EBookClient *client,
                                                         const GSList *uids,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_get_contact           (EBookClient *client,
                                                         const gchar *uid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_get_contact_finish    (EBookClient *client,
                                                         GAsyncResult *result,
                                                         EContact **contact,
                                                         GError **error);
gboolean            e_book_client_get_contact_sync      (EBookClient *client,
                                                         const gchar *uid,
                                                         EContact **contact,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_get_contacts          (EBookClient *client,
                                                         const gchar *sexp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_get_contacts_finish   (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GSList **contacts,
                                                         GError **error);
gboolean            e_book_client_get_contacts_sync     (EBookClient *client,
                                                         const gchar *sexp,
                                                         GSList **contacts,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_get_contacts_uids     (EBookClient *client,
                                                         const gchar *sexp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_get_contacts_uids_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GSList **contacts_uids,
                                                         GError **error);
gboolean            e_book_client_get_contacts_uids_sync
                                                        (EBookClient *client,
                                                         const gchar *sexp,
                                                         GSList **contacts_uids,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_book_client_get_view              (EBookClient *client,
                                                         const gchar *sexp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_book_client_get_view_finish       (EBookClient *client,
                                                         GAsyncResult *result,
                                                         EBookClientView **view,
                                                         GError **error);
gboolean            e_book_client_get_view_sync         (EBookClient *client,
                                                         const gchar *sexp,
                                                         EBookClientView **view,
                                                         GCancellable *cancellable,
                                                         GError **error);

Object Hierarchy

  GObject
   +----EClient
         +----EBookClient

Description

Details

BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS

#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS		"required-fields"

FIXME: Document me.

Since 3.2


BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS

#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS		"supported-fields"

FIXME: Document me.

Since 3.2


BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS

#define BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS "supported-auth-methods"

FIXME: Document me.

Since 3.2


E_BOOK_CLIENT_ERROR

#define E_BOOK_CLIENT_ERROR e_book_client_error_quark ()

FIXME: Document me.

Since 3.2


enum EBookClientError

typedef enum {
	E_BOOK_CLIENT_ERROR_NO_SUCH_BOOK,
	E_BOOK_CLIENT_ERROR_CONTACT_NOT_FOUND,
	E_BOOK_CLIENT_ERROR_CONTACT_ID_ALREADY_EXISTS,
	E_BOOK_CLIENT_ERROR_NO_SUCH_SOURCE,
	E_BOOK_CLIENT_ERROR_NO_SPACE
} EBookClientError;

FIXME: Document me.

Since 3.2


e_book_client_error_to_string ()

const gchar *	      e_book_client_error_to_string       (EBookClientError code);

FIXME: Document me.

Since 3.2


e_book_client_error_create ()

GError *	           e_book_client_error_create          (EBookClientError code,
                                                         const gchar *custom_msg);

code :

an EBookClientError code to create

custom_msg :

custom message to use for the error; can be NULL

Returns :

a new GError containing an E_BOOK_CLIENT_ERROR of the given code. If the custom_msg is NULL, then the error message is the one returned from e_book_client_error_to_string() for the code, otherwise the given message is used. Returned pointer should be freed with g_error_free().

Since 3.2


struct EBookClient

struct EBookClient;

Contains only private data that should be read and manipulated using the functions below.

Since 3.2


e_book_client_new ()

EBookClient *	      e_book_client_new                   (ESource *source,
                                                         GError **error);

Creates a new EBookClient corresponding to the given source. There are only two operations that are valid on this book at this point: e_client_open(), and e_client_remove().

source :

An ESource pointer

error :

A GError pointer

Returns :

a new but unopened EBookClient.

Since 3.2


e_book_client_new_from_uri ()

EBookClient *	      e_book_client_new_from_uri          (const gchar *uri,
                                                         GError **error);

Creates a new EBookClient corresponding to the given uri. See the documentation for e_book_client_new() for further information.

uri :

the URI to load

error :

A GError pointer

Returns :

a new but unopened EBookClient.

Since 3.2


e_book_client_new_system ()

EBookClient *	      e_book_client_new_system            (GError **error);

Creates a new EBookClient corresponding to the user's system addressbook. See the documentation for e_book_client_new() for further information.

error :

A GError pointer

Returns :

a new but unopened EBookClient.

Since 3.2


e_book_client_new_default ()

EBookClient *	      e_book_client_new_default           (GError **error);

Creates a new EBookClient corresponding to the user's default address book. See the documentation for e_book_client_new() for further information.

error :

return location for a GError, or NULL

Returns :

a new but unopened EBookClient

Since 3.2


e_book_client_set_default ()

gboolean            e_book_client_set_default           (EBookClient *client,
                                                         GError **error);

Sets the ESource of the EBookClient as the "default" addressbook. This is the source that will be loaded in the e_book_client_get_default_addressbook() call.

client :

An EBookClient pointer

error :

A GError pointer

Returns :

TRUE if the setting was stored in libebook's ESourceList, otherwise FALSE.

Since 3.2


e_book_client_set_default_source ()

gboolean            e_book_client_set_default_source    (ESource *source,
                                                         GError **error);

Sets source as the "default" addressbook. This is the source that will be loaded in the e_book_client_get_default_addressbook() call.

source :

An ESource pointer

error :

A GError pointer

Returns :

TRUE if the setting was stored in libebook's ESourceList, otherwise FALSE.

Since 3.2


e_book_client_get_sources ()

gboolean            e_book_client_get_sources           (ESourceList **sources,
                                                         GError **error);

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

sources :

A pointer to an ESourceList to set. [out]

error :

A pointer to a GError to set on error

Returns :

TRUE if sources was set, otherwise FALSE.

Since 3.2


e_book_client_get_self ()

gboolean            e_book_client_get_self              (EContact **contact,
                                                         EBookClient **client,
                                                         GError **error);

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

contact :

an EContact pointer to set. [out]

client :

an EBookClient pointer to set. [out]

error :

a GError to set on failure

Returns :

TRUE if successful, otherwise FALSE.

Since 3.2


e_book_client_set_self ()

gboolean            e_book_client_set_self              (EBookClient *client,
                                                         EContact *contact,
                                                         GError **error);

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

client :

an EBookClient

contact :

an EContact

error :

a GError to set on failure

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_is_self ()

gboolean            e_book_client_is_self               (EContact *contact);

Check if contact is the user of the address book.

contact :

an EContact

Returns :

TRUE if contact is the user, FALSE otherwise.

Since 3.2


e_book_client_add_contact ()

void                e_book_client_add_contact           (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Adds contact to client. The call is finished by e_book_client_add_contact_finish() from the callback.

client :

an EBookClient

contact :

an EContact

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_add_contact_finish ()

gboolean            e_book_client_add_contact_finish    (EBookClient *client,
                                                         GAsyncResult *result,
                                                         gchar **added_uid,
                                                         GError **error);

Finishes previous call of e_book_client_add_contact() and sets added_uid to a UID of a newly added contact. This string should be freed with g_free().

Note: This is not modifying original EContact.

client :

an EBookClient

result :

a GAsyncResult

added_uid :

UID of a newly added contact; can be NULL. [out]

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_add_contact_sync ()

gboolean            e_book_client_add_contact_sync      (EBookClient *client,
                                                         EContact *contact,
                                                         gchar **added_uid,
                                                         GCancellable *cancellable,
                                                         GError **error);

Adds contact to client and sets added_uid to a UID of a newly added contact. This string should be freed with g_free().

Note: This is not modifying original contact, thus if it's needed, then use e_contact_set (contact, E_CONTACT_UID, new_uid).

client :

an EBookClient

contact :

an EContact

added_uid :

UID of a newly added contact; can be NULL. [out]

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_add_contacts ()

void                e_book_client_add_contacts          (EBookClient *client,
                                                         GSList *contacts,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Adds contacts to client. The call is finished by e_book_client_add_contacts_finish() from the callback.

client :

an EBookClient

contacts :

a GSList of EContact objects to add

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.4


e_book_client_add_contacts_finish ()

gboolean            e_book_client_add_contacts_finish   (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GSList **added_uids,
                                                         GError **error);

Finishes previous call of e_book_client_add_contacts() and sets added_uids to the UIDs of newly added contacts if successful. This GSList should be freed with e_client_util_free_string_slist().

If any of the contacts cannot be inserted, all of the insertions will be reverted and this method will return FALSE.

Note: This is not modifying original EContact objects.

client :

an EBookClient

result :

a GAsyncResult

added_uids :

UIDs of newly added contacts; can be NULL. [out]

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.4


e_book_client_add_contacts_sync ()

gboolean            e_book_client_add_contacts_sync     (EBookClient *client,
                                                         GSList *contacts,
                                                         GSList **added_uids,
                                                         GCancellable *cancellable,
                                                         GError **error);

Adds contacts to client and sets added_uids to the UIDs of newly added contacts if successful. This GSList should be freed with e_client_util_free_string_slist().

If any of the contacts cannot be inserted, all of the insertions will be reverted and this method will return FALSE.

Note: This is not modifying original contacts, thus if it's needed, then use e_contact_set (contact, E_CONTACT_UID, new_uid).

client :

an EBookClient

contacts :

a GSList of EContact objects to add

added_uids :

UIDs of newly added contacts; can be NULL. [out]

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.4


e_book_client_modify_contact ()

void                e_book_client_modify_contact        (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Applies the changes made to contact to the stored version in client. The call is finished by e_book_client_modify_contact_finish() from the callback.

client :

an EBookClient

contact :

an EContact

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_modify_contact_finish ()

gboolean            e_book_client_modify_contact_finish (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes previous call of e_book_client_modify_contact().

client :

an EBookClient

result :

a GAsyncResult

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_modify_contact_sync ()

gboolean            e_book_client_modify_contact_sync   (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GError **error);

Applies the changes made to contact to the stored version in client.

client :

an EBookClient

contact :

an EContact

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_modify_contacts ()

void                e_book_client_modify_contacts       (EBookClient *client,
                                                         GSList *contacts,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Applies the changes made to contacts to the stored versions in client. The call is finished by e_book_client_modify_contacts_finish() from the callback.

client :

an EBookClient

contacts :

a GSList of EContact objects

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.4


e_book_client_modify_contacts_finish ()

gboolean            e_book_client_modify_contacts_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes previous call of e_book_client_modify_contacts().

client :

an EBookClient

result :

a GAsyncResult

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.4


e_book_client_modify_contacts_sync ()

gboolean            e_book_client_modify_contacts_sync  (EBookClient *client,
                                                         GSList *contacts,
                                                         GCancellable *cancellable,
                                                         GError **error);

Applies the changes made to contacts to the stored versions in client.

client :

an EBookClient

contacts :

a GSList of EContact objects

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.4


e_book_client_remove_contact ()

void                e_book_client_remove_contact        (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Removes contact from the client. The call is finished by e_book_client_remove_contact_finish() from the callback.

client :

an EBookClient

contact :

an EContact

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_remove_contact_finish ()

gboolean            e_book_client_remove_contact_finish (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes previous call of e_book_client_remove_contact().

client :

an EBookClient

result :

a GAsyncResult

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_remove_contact_sync ()

gboolean            e_book_client_remove_contact_sync   (EBookClient *client,
                                                         EContact *contact,
                                                         GCancellable *cancellable,
                                                         GError **error);

Removes contact from the client.

client :

an EBookClient

contact :

an EContact

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_remove_contact_by_uid ()

void                e_book_client_remove_contact_by_uid (EBookClient *client,
                                                         const gchar *uid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Removes contact with uid from the client. The call is finished by e_book_client_remove_contact_by_uid_finish() from the callback.

client :

an EBookClient

uid :

a UID of a contact to remove

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_remove_contact_by_uid_finish ()

gboolean            e_book_client_remove_contact_by_uid_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes previous call of e_book_client_remove_contact_by_uid().

client :

an EBookClient

result :

a GAsyncResult

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_remove_contact_by_uid_sync ()

gboolean            e_book_client_remove_contact_by_uid_sync
                                                        (EBookClient *client,
                                                         const gchar *uid,
                                                         GCancellable *cancellable,
                                                         GError **error);

Removes contact with uid from the client.

client :

an EBookClient

uid :

a UID of a contact to remove

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_remove_contacts ()

void                e_book_client_remove_contacts       (EBookClient *client,
                                                         const GSList *uids,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Removes the contacts with uids from the list uids from client. This is always more efficient than calling e_book_client_remove_contact() if you have more than one uid to remove, as some backends can implement it as a batch request. The call is finished by e_book_client_remove_contacts_finish() from the callback.

client :

an EBookClient

uids :

a GSList of UIDs to remove. [element-type utf8]

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_remove_contacts_finish ()

gboolean            e_book_client_remove_contacts_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes previous call of e_book_client_remove_contacts().

client :

an EBookClient

result :

a GAsyncResult

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_remove_contacts_sync ()

gboolean            e_book_client_remove_contacts_sync  (EBookClient *client,
                                                         const GSList *uids,
                                                         GCancellable *cancellable,
                                                         GError **error);

Removes the contacts with uids from the list uids from client. This is always more efficient than calling e_book_client_remove_contact() if you have more than one uid to remove, as some backends can implement it as a batch request.

client :

an EBookClient

uids :

a GSList of UIDs to remove. [element-type utf8]

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_contact ()

void                e_book_client_get_contact           (EBookClient *client,
                                                         const gchar *uid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Receive EContact from the client for the gived uid. The call is finished by e_book_client_get_contact_finish() from the callback.

client :

an EBookClient

uid :

a unique string ID specifying the contact

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_get_contact_finish ()

gboolean            e_book_client_get_contact_finish    (EBookClient *client,
                                                         GAsyncResult *result,
                                                         EContact **contact,
                                                         GError **error);

Finishes previous call of e_book_client_get_contact(). If successful, then the contact is set to newly allocated EContact, which should be freed with g_object_unref().

client :

an EBookClient

result :

a GAsyncResult

contact :

an EContact for previously given uid. [out]

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_contact_sync ()

gboolean            e_book_client_get_contact_sync      (EBookClient *client,
                                                         const gchar *uid,
                                                         EContact **contact,
                                                         GCancellable *cancellable,
                                                         GError **error);

Receive EContact from the client for the gived uid. If successful, then the contact is set to newly allocated EContact, which should be freed with g_object_unref().

client :

an EBookClient

uid :

a unique string ID specifying the contact

contact :

an EContact for given uid. [out]

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_contacts ()

void                e_book_client_get_contacts          (EBookClient *client,
                                                         const gchar *sexp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Query client with sexp, receiving a list of contacts which matched. The call is finished by e_book_client_get_contacts_finish() from the callback.

Note: sexp can be obtained through EBookQuery, by converting it to a string with e_book_query_to_string().

client :

an EBookClient

sexp :

an S-expression representing the query

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_get_contacts_finish ()

gboolean            e_book_client_get_contacts_finish   (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GSList **contacts,
                                                         GError **error);

Finishes previous call of e_book_client_get_contacts(). If successful, then the contacts is set to newly allocated list of EContact-s, which should be freed with e_client_util_free_object_slist().

client :

an EBookClient

result :

a GAsyncResult

contacts :

a GSList of matched EContact-s. [element-type EContact][out]

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_contacts_sync ()

gboolean            e_book_client_get_contacts_sync     (EBookClient *client,
                                                         const gchar *sexp,
                                                         GSList **contacts,
                                                         GCancellable *cancellable,
                                                         GError **error);

Query client with sexp, receiving a list of contacts which matched. If successful, then the contacts is set to newly allocated GSList of EContact-s, which should be freed with e_client_util_free_object_slist().

Note: sexp can be obtained through EBookQuery, by converting it to a string with e_book_query_to_string().

client :

an EBookClient

sexp :

an S-expression representing the query

contacts :

a GSList of matched EContact-s. [element-type EContact][out]

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_contacts_uids ()

void                e_book_client_get_contacts_uids     (EBookClient *client,
                                                         const gchar *sexp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Query client with sexp, receiving a list of contacts UIDs which matched. The call is finished by e_book_client_get_contacts_uids_finish() from the callback.

Note: sexp can be obtained through EBookQuery, by converting it to a string with e_book_query_to_string().

client :

an EBookClient

sexp :

an S-expression representing the query

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_get_contacts_uids_finish ()

gboolean            e_book_client_get_contacts_uids_finish
                                                        (EBookClient *client,
                                                         GAsyncResult *result,
                                                         GSList **contacts_uids,
                                                         GError **error);

Finishes previous call of e_book_client_get_contacts_uids(). If successful, then the contacts_uids is set to newly allocated list of UID strings, which should be freed with e_client_util_free_string_slist().

client :

an EBookClient

result :

a GAsyncResult

contacts_uids :

a GSList of matched contacts UIDs stored as strings. [element-type utf8][out]

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_contacts_uids_sync ()

gboolean            e_book_client_get_contacts_uids_sync
                                                        (EBookClient *client,
                                                         const gchar *sexp,
                                                         GSList **contacts_uids,
                                                         GCancellable *cancellable,
                                                         GError **error);

Query client with sexp, receiving a list of contacts UIDs which matched. If successful, then the contacts_uids is set to newly allocated list of UID strings, which should be freed with e_client_util_free_string_slist().

Note: sexp can be obtained through EBookQuery, by converting it to a string with e_book_query_to_string().

client :

an EBookClient

sexp :

an S-expression representing the query

contacts_uids :

a GSList of matched contacts UIDs stored as strings. [element-type utf8][out]

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_view ()

void                e_book_client_get_view              (EBookClient *client,
                                                         const gchar *sexp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Query client with sexp, creating an EBookClientView. The call is finished by e_book_client_get_view_finish() from the callback.

Note: sexp can be obtained through EBookQuery, by converting it to a string with e_book_query_to_string().

client :

an EBookClient

sexp :

an S-expression representing the query

cancellable :

a GCancellable; can be NULL

callback :

callback to call when a result is ready

user_data :

user data for the callback

Since 3.2


e_book_client_get_view_finish ()

gboolean            e_book_client_get_view_finish       (EBookClient *client,
                                                         GAsyncResult *result,
                                                         EBookClientView **view,
                                                         GError **error);

Finishes previous call of e_book_client_get_view(). If successful, then the view is set to newly allocated EBookClientView, which should be freed with g_object_unref().

client :

an EBookClient

result :

a GAsyncResult

view :

an EBookClientView. [out]

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2


e_book_client_get_view_sync ()

gboolean            e_book_client_get_view_sync         (EBookClient *client,
                                                         const gchar *sexp,
                                                         EBookClientView **view,
                                                         GCancellable *cancellable,
                                                         GError **error);

Query client with sexp, creating an EBookClientView. If successful, then the view is set to newly allocated EBookClientView, which should be freed with g_object_unref().

Note: sexp can be obtained through EBookQuery, by converting it to a string with e_book_query_to_string().

client :

an EBookClient

sexp :

an S-expression representing the query

view :

(out) an EBookClientView

cancellable :

a GCancellable; can be NULL

error :

a GError to set an error, if any. [out]

Returns :

TRUE if successful, FALSE otherwise.

Since 3.2