![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Address Book Backend (libedata-book) | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
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 (EBookBackend *backend
,ESource *source
); EBookBackend * e_data_book_get_backend (EDataBook *book
); ESource * e_data_book_get_source (EDataBook *book
); guint e_data_book_register_gdbus_object (EDataBook *cal
,GDBusConnection *connection
,const gchar *object_path
,GError **error
); void e_data_book_respond_open (EDataBook *book
,guint32 opid
,GError *error
); void e_data_book_respond_remove (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_set_backend_property (EDataBook *book
,guint32 opid
,GError *error
); void e_data_book_respond_create (EDataBook *book
,guint32 opid
,GError *error
,const EContact *contact
); void e_data_book_respond_remove_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *ids
); void e_data_book_respond_modify (EDataBook *book
,guint32 opid
,GError *error
,const EContact *contact
); 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_readonly (EDataBook *book
,gboolean readonly
); void e_data_book_report_online (EDataBook *book
,gboolean is_online
); void e_data_book_report_auth_required (EDataBook *book
,const ECredentials *credentials
); void e_data_book_report_opened (EDataBook *book
,const GError *error
); gchar * e_data_book_string_slist_to_comma_string (const GSList *strings
);
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
guint e_data_book_register_gdbus_object (EDataBook *cal
,GDBusConnection *connection
,const gchar *object_path
,GError **error
);
Registers GDBus object of this EDataBook.
Since 2.32
void e_data_book_respond_open (EDataBook *book
,guint32 opid
,GError *error
);
void e_data_book_respond_remove (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
);
void e_data_book_respond_set_backend_property (EDataBook *book
,guint32 opid
,GError *error
);
void e_data_book_respond_create (EDataBook *book
,guint32 opid
,GError *error
,const EContact *contact
);
void e_data_book_respond_remove_contacts (EDataBook *book
,guint32 opid
,GError *error
,const GSList *ids
);
void e_data_book_respond_modify (EDataBook *book
,guint32 opid
,GError *error
,const EContact *contact
);
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_readonly (EDataBook *book
,gboolean readonly
);
void e_data_book_report_auth_required (EDataBook *book
,const ECredentials *credentials
);