Evolution-Data-Server Manual: Address Book Client (libebook) | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
Synopsis
struct EBook; EBook * e_book_new (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_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_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 (ESourceRegistry *registry
,EContact **contact
,EBook **book
,GError **error
); gboolean e_book_set_self (EBook *book
,EContact *contact
,GError **error
); gboolean e_book_is_self (EContact *contact
); #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_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_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
);
Description
The old asynchronous API was deprecated since 3.0 and is replaced with their an equivalent version which has a detailed GError structure in the asynchronous callback, instead of a status code only.
As an example, e_book_async_open()
is replaced by e_book_open_async()
.
Details
struct EBook
struct EBook;
Warning
EBook
is deprecated and should not be used in newly-written code.
e_book_new ()
EBook * e_book_new (ESource *source
,GError **error
);
Warning
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()
.
e_book_remove ()
gboolean e_book_remove (EBook *book
,GError **error
);
Warning
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!
|
an EBook |
|
a GError to set on failure |
Returns : |
TRUE on success, FALSE on failure. |
e_book_open ()
gboolean e_book_open (EBook *book
,gboolean only_if_exists
,GError **error
);
Warning
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.
|
an EBook |
|
if TRUE , fail if this book doesn't already exist,
otherwise create it first |
|
a GError to set on failure |
Returns : |
TRUE if the book was successfully opened, FALSE otherwise. |
e_book_get_supported_fields ()
gboolean e_book_get_supported_fields (EBook *book
,GList **fields
,GError **error
);
Warning
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.
|
an EBook |
|
a GList of fields to set on success. [out][transfer full][element-type utf8] |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise |
e_book_get_supported_auth_methods ()
gboolean e_book_get_supported_auth_methods (EBook *book
,GList **auth_methods
,GError **error
);
Warning
e_book_get_supported_auth_methods
has been deprecated since version 3.2 and should not be used in newly-written code. The property is no longer supported.
Queries book
for the list of authentication methods it supports.
The list will contain pointers to allocated strings, and both the
GList and the strings must be freed by the caller.
|
an EBook |
|
a GList of auth methods to set on success. [out][transfer full][element-type utf8] |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise |
e_book_get_required_fields ()
gboolean e_book_get_required_fields (EBook *book
,GList **fields
,GError **error
);
Warning
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.
|
an EBook |
|
a GList of fields to set on success. [out][transfer full][element-type utf8] |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise. |
e_book_get_source ()
ESource * e_book_get_source (EBook *book
);
Warning
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] |
e_book_is_online ()
gboolean e_book_is_online (EBook *book
);
Warning
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.
|
an EBook |
Returns : |
TRUE if this book is connected, otherwise FALSE . |
e_book_is_opened ()
gboolean e_book_is_opened (EBook *book
);
Warning
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.
|
and EBook |
Returns : |
TRUE if this book has been opened, otherwise FALSE . |
e_book_get_contact ()
gboolean e_book_get_contact (EBook *book
,const gchar *id
,EContact **contact
,GError **error
);
Warning
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
.
e_book_remove_contact ()
gboolean e_book_remove_contact (EBook *book
,const gchar *id
,GError **error
);
Warning
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
.
|
an EBook |
|
a string |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise |
e_book_remove_contacts ()
gboolean e_book_remove_contacts (EBook *book
,GList *ids
,GError **error
);
Warning
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.
|
an EBook |
|
an GList of const gchar *id's. [element-type utf8] |
|
a GError to set on failure |
Returns : |
TRUE if successful, FALSE otherwise |
e_book_add_contact ()
gboolean e_book_add_contact (EBook *book
,EContact *contact
,GError **error
);
Warning
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
.
e_book_commit_contact ()
gboolean e_book_commit_contact (EBook *book
,EContact *contact
,GError **error
);
Warning
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
.
e_book_get_book_view ()
gboolean e_book_get_book_view (EBook *book
,EBookQuery *query
,GList *requested_fields
,gint max_results
,EBookView **book_view
,GError **error
);
Warning
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 |
e_book_get_contacts ()
gboolean e_book_get_contacts (EBook *book
,EBookQuery *query
,GList **contacts
,GError **error
);
Warning
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.
|
an EBook |
|
an EBookQuery |
|
a GList pointer, will be set to the list of contacts. [element-type utf8] |
|
a GError to set on failure |
Returns : |
TRUE on success, FALSE otherwise |
e_book_get_changes ()
gboolean e_book_get_changes (EBook *book
,const gchar *changeid
,GList **changes
,GError **error
);
Warning
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.
|
an EBook |
|
the change ID |
|
return location for a GList of EBookChange items. [out][transfer full] |
|
a GError to set on failure. |
Returns : |
TRUE on success, FALSE otherwise |
e_book_free_change_list ()
void e_book_free_change_list (GList *change_list
);
Warning
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] |
e_book_get_static_capabilities ()
const gchar * e_book_get_static_capabilities (EBook *book
,GError **error
);
Warning
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.
|
an EBook |
|
an GError to set on failure |
Returns : |
The capabilities list |
e_book_check_static_capability ()
gboolean e_book_check_static_capability (EBook *book
,const gchar *cap
);
Warning
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
.
|
an EBook |
|
A capability string |
Returns : |
TRUE if the backend supports cap , FALSE otherwise. |
e_book_is_writable ()
gboolean e_book_is_writable (EBook *book
);
Warning
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.
|
an EBook |
Returns : |
TRUE if this book is writable, otherwise FALSE . |
e_book_cancel ()
gboolean e_book_cancel (EBook *book
,GError **error
);
Warning
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.
|
an EBook |
|
a GError to set on failure |
Returns : |
TRUE on success, FALSE otherwise |
e_book_cancel_async_op ()
gboolean e_book_cancel_async_op (EBook *book
,GError **error
);
Warning
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.
|
an EBook |
|
return location for a GError, or NULL
|
Since 2.24
e_book_get_self ()
gboolean e_book_get_self (ESourceRegistry *registry
,EContact **contact
,EBook **book
,GError **error
);
Warning
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
.
|
an ESourceRegistry |
|
an EContact pointer to set. [out] |
|
an EBook pointer to set. [out] |
|
a GError to set on failure |
Returns : |
TRUE if successful, otherwise FALSE . |
e_book_set_self ()
gboolean e_book_set_self (EBook *book
,EContact *contact
,GError **error
);
Warning
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.
e_book_is_self ()
gboolean e_book_is_self (EContact *contact
);
Warning
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.
|
an EContact |
Returns : |
TRUE if contact is the user, FALSE otherwise. |
e_return_error_if_fail()
#define e_return_error_if_fail(expr,error_code)
FIXME Document me!
|
the expression to check |
|
the error code to set if expr fails |
Since 2.30
e_return_async_error_if_fail()
#define e_return_async_error_if_fail(expr, error)
|
the expression to check |
|
a GError |
Since 2.32
e_return_ex_async_error_val_if_fail()
#define e_return_ex_async_error_val_if_fail(expr, error)
|
the expression to check |
|
a GError |
Since 2.32
EBookAsyncCallback ()
void (*EBookAsyncCallback) (EBook *book
,const GError *error
,gpointer closure
);
Warning
EBookAsyncCallback
is deprecated and should not be used in newly-written code.
|
an EBook |
|
a GError or NULL
|
|
the callback closure |
Since 2.32
EBookOpenProgressCallback ()
void (*EBookOpenProgressCallback) (EBook *book
,const gchar *status_message
,gshort percent
,gpointer closure
);
Warning
EBookOpenProgressCallback
is deprecated and should not be used in newly-written code.
|
an EBook |
|
a status message |
|
percent complete (0 - 100) |
|
the callback closure |
Since 2.32
EBookIdAsyncCallback ()
void (*EBookIdAsyncCallback) (EBook *book
,const GError *error
,const gchar *id
,gpointer closure
);
Warning
EBookIdAsyncCallback
is deprecated and should not be used in newly-written code.
|
an EBook |
|
a GError or NULL
|
|
a contact ID |
|
the callback closure |
Since 2.32
EBookContactAsyncCallback ()
void (*EBookContactAsyncCallback) (EBook *book
,const GError *error
,EContact *contact
,gpointer closure
);
Warning
EBookContactAsyncCallback
is deprecated and should not be used in newly-written code.
|
an EBook |
|
a GError or NULL
|
|
an EContact or NULL
|
|
the callback closure |
Since 2.32
EBookListAsyncCallback ()
void (*EBookListAsyncCallback) (EBook *book
,const GError *error
,GList *list
,gpointer closure
);
Warning
EBookListAsyncCallback
is deprecated and should not be used in newly-written code.
|
an EBook |
|
a GError or NULL
|
|
a GList of results |
|
the callback closure |
Since 2.32
EBookBookViewAsyncCallback ()
void (*EBookBookViewAsyncCallback) (EBook *book
,const GError *error
,EBookView *book_view
,gpointer closure
);
Warning
EBookBookViewAsyncCallback
is deprecated and should not be used in newly-written code.
Since 2.32
EBookEListAsyncCallback ()
void (*EBookEListAsyncCallback) (EBook *book
,const GError *error
,EList *list
,gpointer closure
);
Warning
EBookEListAsyncCallback
is deprecated and should not be used in newly-written code.
Since 2.32
EBookCallback ()
void (*EBookCallback) (EBook *book
,EBookStatus status
,gpointer closure
);
Warning
EBookCallback
is deprecated and should not be used in newly-written code.
EBookIdCallback ()
void (*EBookIdCallback) (EBook *book
,EBookStatus status
,const gchar *id
,gpointer closure
);
Warning
EBookIdCallback
is deprecated and should not be used in newly-written code.
EBookEListCallback ()
void (*EBookEListCallback) (EBook *book
,EBookStatus status
,EList *list
,gpointer closure
);
Warning
EBookEListCallback
is deprecated and should not be used in newly-written code.
EBookListCallback ()
void (*EBookListCallback) (EBook *book
,EBookStatus status
,GList *list
,gpointer closure
);
Warning
EBookListCallback
is deprecated and should not be used in newly-written code.
EBookContactCallback ()
void (*EBookContactCallback) (EBook *book
,EBookStatus status
,EContact *contact
,gpointer closure
);
Warning
EBookContactCallback
is deprecated and should not be used in newly-written code.
EBookBookViewCallback ()
void (*EBookBookViewCallback) (EBook *book
,EBookStatus status
,EBookView *book_view
,gpointer closure
);
Warning
EBookBookViewCallback
is deprecated and should not be used in newly-written code.
e_book_open_async ()
gboolean e_book_open_async (EBook *book
,gboolean only_if_exists
,EBookAsyncCallback open_response
,gpointer closure
);
Warning
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
e_book_remove_async ()
gboolean e_book_remove_async (EBook *book
,EBookAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_get_supported_fields_async ()
gboolean e_book_get_supported_fields_async (EBook *book
,EBookEListAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_get_supported_auth_methods_async ()
gboolean e_book_get_supported_auth_methods_async (EBook *book
,EBookEListAsyncCallback cb
,gpointer closure
);
Warning
e_book_get_supported_auth_methods_async
has been deprecated since version 3.2 and should not be used in newly-written code. The property is no longer supported.
Queries book
for the list of authentication methods it supports.
This function does not block.
|
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
e_book_get_contact_async ()
gboolean e_book_get_contact_async (EBook *book
,const gchar *id
,EBookContactAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_get_contacts_async ()
gboolean e_book_get_contacts_async (EBook *book
,EBookQuery *query
,EBookListAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_remove_contact_async ()
gboolean e_book_remove_contact_async (EBook *book
,EContact *contact
,EBookAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_remove_contact_by_id_async ()
gboolean e_book_remove_contact_by_id_async (EBook *book
,const gchar *id
,EBookAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_remove_contacts_async ()
gboolean e_book_remove_contacts_async (EBook *book
,GList *ids
,EBookAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_add_contact_async ()
gboolean e_book_add_contact_async (EBook *book
,EContact *contact
,EBookIdAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_commit_contact_async ()
gboolean e_book_commit_contact_async (EBook *book
,EContact *contact
,EBookAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_get_book_view_async ()
gboolean e_book_get_book_view_async (EBook *book
,EBookQuery *query
,GList *requested_fields
,gint max_results
,EBookBookViewAsyncCallback cb
,gpointer closure
);
Warning
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 async] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise |
Since 2.32
e_book_get_changes_async ()
gboolean e_book_get_changes_async (EBook *book
,const gchar *changeid
,EBookListAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_get_required_fields_async ()
gboolean e_book_get_required_fields_async (EBook *book
,EBookEListAsyncCallback cb
,gpointer closure
);
Warning
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
e_book_async_open ()
gboolean e_book_async_open (EBook *book
,gboolean only_if_exists
,EBookCallback open_response
,gpointer closure
);
Warning
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.
|
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][closure closure] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise. |
e_book_async_remove ()
gboolean e_book_async_remove (EBook *book
,EBookCallback cb
,gpointer closure
);
Warning
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!
|
an EBook |
|
a function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise. |
e_book_async_get_supported_fields ()
gboolean e_book_async_get_supported_fields (EBook *book
,EBookEListCallback cb
,gpointer closure
);
Warning
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.
|
an EBook |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise. |
e_book_async_get_supported_auth_methods ()
gboolean e_book_async_get_supported_auth_methods (EBook *book
,EBookEListCallback cb
,gpointer closure
);
Warning
e_book_async_get_supported_auth_methods
has been deprecated since version 3.0 and should not be used in newly-written code. The property is no longer supported.
Queries book
for the list of authentication methods it supports.
This function does not block.
|
an EBook |
|
function to call when the operation finishes. [scope async] |
|
data to pass to callback function |
Returns : |
TRUE if successful, FALSE otherwise. |
e_book_async_get_contact ()
gboolean e_book_async_get_contact (EBook *book
,const gchar *id
,EBookContactCallback cb
,gpointer closure
);
Warning
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
.
|
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 |
e_book_async_get_contacts ()
gboolean e_book_async_get_contacts (EBook *book
,EBookQuery *query
,EBookListCallback cb
,gpointer closure
);
Warning
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 |
e_book_async_remove_contact ()
gboolean e_book_async_remove_contact (EBook *book
,EContact *contact
,EBookCallback cb
,gpointer closure
);
Warning
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
.
e_book_async_remove_contact_by_id ()
gboolean e_book_async_remove_contact_by_id (EBook *book
,const gchar *id
,EBookCallback cb
,gpointer closure
);
Warning
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
.
|
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 |
e_book_async_remove_contacts ()
gboolean e_book_async_remove_contacts (EBook *book
,GList *ids
,EBookCallback cb
,gpointer closure
);
Warning
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.
|
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 |
e_book_async_add_contact ()
gboolean e_book_async_add_contact (EBook *book
,EContact *contact
,EBookIdCallback cb
,gpointer closure
);
Warning
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.
e_book_async_commit_contact ()
gboolean e_book_async_commit_contact (EBook *book
,EContact *contact
,EBookCallback cb
,gpointer closure
);
Warning
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.
e_book_async_get_book_view ()
gboolean e_book_async_get_book_view (EBook *book
,EBookQuery *query
,GList *requested_fields
,gint max_results
,EBookBookViewCallback cb
,gpointer closure
);
Warning
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 async] |
|
data to pass to callback function |
Returns : |
FALSE if successful, TRUE otherwise |
e_book_async_get_changes ()
gboolean e_book_async_get_changes (EBook *book
,const gchar *changeid
,EBookListCallback cb
,gpointer closure
);
Warning
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.
|
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 |
e_book_async_get_required_fields ()
gboolean e_book_async_get_required_fields (EBook *book
,EBookEListCallback cb
,gpointer closure
);
Warning
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.
|
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. |
Property Details
The "source"
property
"source" ESource* : Read / Write / Construct Only
The data source for this EBook.