![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Address Book Backend (libedata-book) | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
struct EDataBook; #define E_DATA_BOOK_ERROR GError * e_data_book_create_error (EDataBookStatus status
,const gchar *custom_msg
); GError * e_data_book_create_error_fmt (EDataBookStatus status
,const gchar *custom_msg_fmt
,...
); const gchar * e_data_book_status_to_string (EDataBookStatus status
); #define e_return_data_book_error_if_fail (expr, _code) #define e_return_data_book_error_val_if_fail(expr, _code) EDataBook * e_data_book_new (struct _EBookBackend *backend
,GDBusConnection *connection
,const gchar *object_path
,GError **error
); struct _EBookBackend * e_data_book_get_backend (EDataBook *book
); GDBusConnection * e_data_book_get_connection (EDataBook *book
); const gchar * e_data_book_get_object_path (EDataBook *book
); void e_data_book_respond_open (EDataBook *book
,guint32 opid
,GError *error
); void e_data_book_respond_refresh (EDataBook *book
,guint32 opid
,GError *error
); void e_data_book_respond_get_backend_property (EDataBook *book
,guint32 opid
,GError *error
,const gchar *prop_value
); void e_data_book_respond_create_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *contacts
); void e_data_book_respond_remove_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *ids
); void e_data_book_respond_modify_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *contacts
); void e_data_book_respond_get_contact (EDataBook *book
,guint32 opid
,GError *error
,const gchar *vcard
); void e_data_book_respond_get_contact_list (EDataBook *book
,guint32 opid
,GError *error
,const GSList *cards
); void e_data_book_respond_get_contact_list_uids (EDataBook *book
,guint32 opid
,GError *error
,const GSList *uids
); void e_data_book_report_error (EDataBook *book
,const gchar *message
); void e_data_book_report_backend_property_changed (EDataBook *book
,const gchar *prop_name
,const gchar *prop_value
); gchar * e_data_book_string_slist_to_comma_string (const GSList *strings
); void e_data_book_respond_set_backend_property (EDataBook *book
,guint32 opid
,GError *error
); void e_data_book_report_opened (EDataBook *book
,const GError *error
); void e_data_book_report_readonly (EDataBook *book
,gboolean readonly
); void e_data_book_report_online (EDataBook *book
,gboolean is_online
);
"backend" EBookBackend* : Read / Write / Construct Only "connection" GDBusConnection* : Read / Write / Construct Only "object-path" gchar* : Read / Write / Construct Only
GError * e_data_book_create_error (EDataBookStatus status
,const gchar *custom_msg
);
|
EDataBookStatus code |
|
Custom message to use for the error. When NULL,
then uses a default message based on the status code. |
Returns : |
NULL, when the status is E_DATA_BOOK_STATUS_SUCCESS,
or a newly allocated GError, which should be freed
with g_error_free() call. |
Since 2.32
GError * e_data_book_create_error_fmt (EDataBookStatus status
,const gchar *custom_msg_fmt
,...
);
Similar as e_data_book_create_error()
, only here, instead of custom_msg,
is used a printf()
format to create a custom_msg for the error.
Since 2.32
const gchar * e_data_book_status_to_string (EDataBookStatus status
);
Since 2.32
#define e_return_data_book_error_val_if_fail(expr, _code)
Same as e_return_data_book_error_if_fail()
, only returns FALSE on a failure
Since 3.2
EDataBook * e_data_book_new (struct _EBookBackend *backend
,GDBusConnection *connection
,const gchar *object_path
,GError **error
);
Creates a new EDataBook and exports the AddressBook D-Bus interface
on connection
at object_path
. The EDataBook handles incoming remote
method invocations and forwards them to the backend
. If the AddressBook
interface fails to export, the function sets error
and returns NULL
.
|
an EBookBackend |
|
a GDBusConnection |
|
object path for the D-Bus interface |
|
return location for a GError, or NULL
|
Returns : |
an EDataBook, or NULL on error |
struct _EBookBackend * e_data_book_get_backend (EDataBook *book
);
Returns the EBookBackend to which incoming remote method invocations are being forwarded.
|
an EDataBook |
Returns : |
the EBookBackend |
GDBusConnection * e_data_book_get_connection (EDataBook *book
);
Returns the GDBusConnection on which the AddressBook D-Bus interface is exported.
|
an EDataBook |
Returns : |
the GDBusConnection |
Since 3.8
const gchar * e_data_book_get_object_path (EDataBook *book
);
Returns the object path at which the AddressBook D-Bus interface is exported.
|
an EDataBook |
Returns : |
the object path |
Since 3.8
void e_data_book_respond_open (EDataBook *book
,guint32 opid
,GError *error
);
void e_data_book_respond_refresh (EDataBook *book
,guint32 opid
,GError *error
);
Notifies listeners of the completion of the refresh method call.
|
An addressbook client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
void e_data_book_respond_get_backend_property (EDataBook *book
,guint32 opid
,GError *error
,const gchar *prop_value
);
FIXME: Document me.
Since 3.2
void e_data_book_respond_create_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *contacts
);
FIXME: Document me!
Since 3.4
void e_data_book_respond_remove_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *ids
);
void e_data_book_respond_modify_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *contacts
);
FIXME: Document me!
Since 3.4
void e_data_book_respond_get_contact (EDataBook *book
,guint32 opid
,GError *error
,const gchar *vcard
);
void e_data_book_respond_get_contact_list (EDataBook *book
,guint32 opid
,GError *error
,const GSList *cards
);
void e_data_book_respond_get_contact_list_uids (EDataBook *book
,guint32 opid
,GError *error
,const GSList *uids
);
FIXME: Document me.
Since 3.2
void e_data_book_report_error (EDataBook *book
,const gchar *message
);
FIXME: Document me.
Since 3.2
void e_data_book_report_backend_property_changed (EDataBook *book
,const gchar *prop_name
,const gchar *prop_value
);
FIXME: Document me.
Since 3.2
gchar * e_data_book_string_slist_to_comma_string
(const GSList *strings
);
Takes a list of strings and converts it to a comma-separated string of
values; free returned pointer with g_free()
Since 3.2
void e_data_book_respond_set_backend_property (EDataBook *book
,guint32 opid
,GError *error
);
e_data_book_respond_set_backend_property
has been deprecated since version 3.8 and should not be used in newly-written code. This function no longer does anything.
FIXME: Document me.
Since 3.2
void e_data_book_report_opened (EDataBook *book
,const GError *error
);
e_data_book_report_opened
has been deprecated since version 3.8 and should not be used in newly-written code. This function no longer does anything.
Reports to associated client that opening phase of the book is finished. error being NULL means successfully, otherwise reports an error which happened during opening phase. By opening phase is meant a process including successfull authentication to the server/storage.
Since 3.2
void e_data_book_report_readonly (EDataBook *book
,gboolean readonly
);
e_data_book_report_readonly
has been deprecated since version 3.8 and should not be used in newly-written code. Use e_book_backend_set_writable()
instead.
FIXME: Document me.
Since 3.2
void e_data_book_report_online (EDataBook *book
,gboolean is_online
);
e_data_book_report_online
has been deprecated since version 3.8 and should not be used in newly-written code. Use e_backend_set_online()
instead.
FIXME: Document me.
Since 3.2
"backend"
property"backend" EBookBackend* : Read / Write / Construct Only
The backend driving this connection.
"connection"
property "connection" GDBusConnection* : Read / Write / Construct Only
The GDBusConnection on which to export the address book interface.