| Evolution-Data-Server Manual: Address Book Client (libebook) | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS #define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS struct EBookClient; EClient * e_book_client_connect_sync (ESource *source,GCancellable *cancellable,GError **error); void e_book_client_connect (ESource *source,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); EClient * e_book_client_connect_finish (GAsyncResult *result,GError **error); EClient * e_book_client_connect_direct_sync (ESourceRegistry *registry,ESource *source,GCancellable *cancellable,GError **error); gboolean e_book_client_get_self (ESourceRegistry *registry,EContact **out_contact,EBookClient **out_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 **out_added_uid,GError **error); gboolean e_book_client_add_contact_sync (EBookClient *client,EContact *contact,gchar **out_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 **out_added_uids,GError **error); gboolean e_book_client_add_contacts_sync (EBookClient *client,GSList *contacts,GSList **out_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 **out_contact,GError **error); gboolean e_book_client_get_contact_sync (EBookClient *client,const gchar *uid,EContact **out_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 **out_contacts,GError **error); gboolean e_book_client_get_contacts_sync (EBookClient *client,const gchar *sexp,GSList **out_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 **out_contact_uids,GError **error); gboolean e_book_client_get_contacts_uids_sync (EBookClient *client,const gchar *sexp,GSList **out_contact_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 **out_view,GError **error); gboolean e_book_client_get_view_sync (EBookClient *client,const gchar *sexp,EBookClientView **out_view,GCancellable *cancellable,GError **error); #define BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS EBookClient * e_book_client_new (ESource *source,GError **error);
#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS "required-fields"
FIXME: Document me.
Since 3.2
#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS "supported-fields"
FIXME: Document me.
Since 3.2
struct EBookClient;
Contains only private data that should be read and manipulated using the functions below.
Since 3.2
EClient * e_book_client_connect_sync (ESource *source,GCancellable *cancellable,GError **error);
Creates a new EBookClient for source. If an error occurs, the function
will set error and return FALSE.
Unlike with e_book_client_new(), there is no need to call
e_client_open_sync() after obtaining the EBookClient.
For error handling convenience, any error message returned by this
function will have a descriptive prefix that includes the display
name of source.
|
an ESource |
|
optional GCancellable object, or NULL. [allow-none]
|
|
return location for a GError, or NULL
|
Returns : |
a new EBookClient, or NULL. [transfer full][type EBookClient]
|
Since 3.8
void e_book_client_connect (ESource *source,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously creates a new EBookClient for source.
Unlike with e_book_client_new(), there is no need to call e_client_open()
after obtaining the EBookClient.
When the operation is finished, callback will be called. You can then
call e_book_client_connect_finish() to get the result of the operation.
|
an ESource |
|
optional GCancellable object, or NULL. [allow-none]
|
|
a GAsyncReadyCallback to call when the request is satisfied. [scope async] |
|
data to pass to the callback function. [closure] |
Since 3.8
EClient * e_book_client_connect_finish (GAsyncResult *result,GError **error);
Finishes the operation started with e_book_client_connect(). If an
error occurs in connecting to the D-Bus service, the function sets
error and returns NULL.
For error handling convenience, any error message returned by this
function will have a descriptive prefix that includes the display
name of the ESource passed to e_book_client_connect().
|
a GAsyncResult |
|
return location for a GError, or NULL
|
Returns : |
a new EBookClient, or NULL. [transfer full][type EBookClient]
|
Since 3.8
EClient * e_book_client_connect_direct_sync (ESourceRegistry *registry,ESource *source,GCancellable *cancellable,GError **error);
Like e_book_client_connect_sync(), except creates the book client for
direct read access to the underlying addressbook.
|
an ESourceRegistry |
|
an ESource |
|
optional GCancellable object, or NULL. [allow-none]
|
|
return location for a GError, or NULL
|
Returns : |
a new but unopened EBookClient. [transfer full][type EBookClient] |
Since 3.8
gboolean e_book_client_get_self (ESourceRegistry *registry,EContact **out_contact,EBookClient **out_client,GError **error);
Get the EContact referring to the user of the address book
and set it in out_contact and out_client.
|
an ESourceRegistry |
|
an EContact pointer to set. [out] |
|
an EBookClient pointer to set. [out] |
|
a GError to set on failure |
Returns : |
TRUE if successful, otherwise FALSE. |
Since 3.2
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.
|
an EBookClient |
|
an EContact |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_is_self (EContact *contact);
Check if contact is the user of the address book.
|
an EContact |
Returns : |
TRUE if contact is the user, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
an EContact |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_add_contact_finish (EBookClient *client,GAsyncResult *result,gchar **out_added_uid,GError **error);
Finishes previous call of e_book_client_add_contact() and
sets out_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.
|
an EBookClient |
|
a GAsyncResult |
|
UID of a newly added contact; can be NULL. [out]
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_add_contact_sync (EBookClient *client,EContact *contact,gchar **out_added_uid,GCancellable *cancellable,GError **error);
Adds contact to client and
sets out_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).
|
an EBookClient |
|
an EContact |
|
UID of a newly added contact; can be NULL. [out]
|
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a GSList of EContact objects to add. [element-type EContact] |
|
a GCancellable; can be NULL. [allow-none]
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.4
gboolean e_book_client_add_contacts_finish (EBookClient *client,GAsyncResult *result,GSList **out_added_uids,GError **error);
Finishes previous call of e_book_client_add_contacts() and
sets out_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.
|
an EBookClient |
|
a GAsyncResult |
|
UIDs of
newly added contacts; can be NULL. [out][element-type utf8][allow-none]
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.4
gboolean e_book_client_add_contacts_sync (EBookClient *client,GSList *contacts,GSList **out_added_uids,GCancellable *cancellable,GError **error);
Adds contacts to client and
sets out_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).
|
an EBookClient |
|
a GSList of EContact objects to add. [element-type EContact] |
|
UIDs of newly
added contacts; can be NULL. [out][element-type utf8][allow-none]
|
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.4
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.
|
an EBookClient |
|
an EContact |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_modify_contact_finish (EBookClient *client,GAsyncResult *result,GError **error);
Finishes previous call of e_book_client_modify_contact().
|
an EBookClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
an EContact |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a GSList of EContact objects. [element-type EContact] |
|
a GCancellable; can be NULL. [allow-none]
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.4
gboolean e_book_client_modify_contacts_finish (EBookClient *client,GAsyncResult *result,GError **error);
Finishes previous call of e_book_client_modify_contacts().
|
an EBookClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.4
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.
|
an EBookClient |
|
a GSList of EContact objects. [element-type EContact] |
|
a GCancellable; can be NULL. [allow-none]
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.4
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.
|
an EBookClient |
|
an EContact |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_remove_contact_finish (EBookClient *client,GAsyncResult *result,GError **error);
Finishes previous call of e_book_client_remove_contact().
|
an EBookClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_remove_contact_sync (EBookClient *client,EContact *contact,GCancellable *cancellable,GError **error);
Removes contact from the client.
|
an EBookClient |
|
an EContact |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a UID of a contact to remove |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
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().
|
an EBookClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a UID of a contact to remove |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a GSList of UIDs to remove. [element-type utf8] |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_remove_contacts_finish (EBookClient *client,GAsyncResult *result,GError **error);
Finishes previous call of e_book_client_remove_contacts().
|
an EBookClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a GSList of UIDs to remove. [element-type utf8] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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.
|
an EBookClient |
|
a unique string ID specifying the contact |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_get_contact_finish (EBookClient *client,GAsyncResult *result,EContact **out_contact,GError **error);
Finishes previous call of e_book_client_get_contact().
If successful, then the out_contact is set to newly allocated
EContact, which should be freed with g_object_unref().
|
an EBookClient |
|
a GAsyncResult |
|
an EContact for previously given uid. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_get_contact_sync (EBookClient *client,const gchar *uid,EContact **out_contact,GCancellable *cancellable,GError **error);
Receive EContact from the client for the gived uid.
If successful, then the out_contact is set to newly allocated
EContact, which should be freed with g_object_unref().
|
an EBookClient |
|
a unique string ID specifying the contact |
|
an EContact for given uid. [out]
|
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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().
|
an EBookClient |
|
an S-expression representing the query |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_get_contacts_finish (EBookClient *client,GAsyncResult *result,GSList **out_contacts,GError **error);
Finishes previous call of e_book_client_get_contacts().
If successful, then the out_contacts is set to newly allocated list of
EContact-s, which should be freed with e_client_util_free_object_slist().
|
an EBookClient |
|
a GAsyncResult |
|
a GSList of matched EContact-s. [element-type EContact][out][transfer full] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_get_contacts_sync (EBookClient *client,const gchar *sexp,GSList **out_contacts,GCancellable *cancellable,GError **error);
Query client with sexp, receiving a list of contacts which matched.
If successful, then the out_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().
|
an EBookClient |
|
an S-expression representing the query |
|
a GSList of matched EContact-s. [element-type EContact][out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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().
|
an EBookClient |
|
an S-expression representing the query |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_get_contacts_uids_finish (EBookClient *client,GAsyncResult *result,GSList **out_contact_uids,GError **error);
Finishes previous call of e_book_client_get_contacts_uids().
If successful, then the out_contact_uids is set to newly allocated list
of UID strings, which should be freed with e_client_util_free_string_slist().
|
an EBookClient |
|
a GAsyncResult |
|
a GSList of matched contact UIDs stored as strings. [element-type utf8][out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_get_contacts_uids_sync (EBookClient *client,const gchar *sexp,GSList **out_contact_uids,GCancellable *cancellable,GError **error);
Query client with sexp, receiving a list of contacts UIDs which matched.
If successful, then the out_contact_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().
|
an EBookClient |
|
an S-expression representing the query |
|
a GSList of matched contacts UIDs stored as strings. [element-type utf8][out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
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().
|
an EBookClient |
|
an S-expression representing the query |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_book_client_get_view_finish (EBookClient *client,GAsyncResult *result,EBookClientView **out_view,GError **error);
Finishes previous call of e_book_client_get_view().
If successful, then the out_view is set to newly allocated
EBookClientView, which should be freed with g_object_unref().
|
an EBookClient |
|
a GAsyncResult |
|
an EBookClientView. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_book_client_get_view_sync (EBookClient *client,const gchar *sexp,EBookClientView **out_view,GCancellable *cancellable,GError **error);
Query client with sexp, creating an EBookClientView.
If successful, then the out_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().
|
an EBookClient |
|
an S-expression representing the query |
|
(out) an EBookClientView |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
#define BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS "supported-auth-methods"
BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS has been deprecated since version 3.8 and should not be used in newly-written code. The property is no longer supported.
Since 3.2
EBookClient * e_book_client_new (ESource *source,GError **error);
e_book_client_new has been deprecated since version 3.8 and should not be used in newly-written code. It covertly makes synchronous D-Bus calls, with no
way to cancel. Use e_book_client_connect() instead,
which combines e_book_client_new() and e_client_open()
into one step.
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().
|
An ESource pointer |
|
A GError pointer |
Returns : |
a new but unopened EBookClient. |
Since 3.2