Top | ![]() |
![]() |
![]() |
![]() |
#define | E_BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS |
#define | E_BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS |
#define | E_BOOK_BACKEND_PROPERTY_REVISION |
#define | E_BOOK_CLIENT_ERROR |
enum | EBookClientError |
enum | EBookViewStatus |
enum | EBookChangeType |
EBookChange |
const gchar *
e_book_client_error_to_string (EBookClientError code
);
Get localized human readable description of the given error code.
Since: 3.2
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 |
[nullable] |
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
GError * e_book_client_error_create_fmt (EBookClientError code
,const gchar *format
,...
);
Similar as e_book_client_error_create()
, only here, instead of custom_msg,
is used a printf()
format to create a custom message for the error.
code |
||
format |
message format, or |
[nullable] |
... |
arguments for the format |
a newly allocated GError, which should be
freed with g_error_free()
, when no longer needed.
The GError has set the custom message, or the default message for
code
, when format
is NULL
.
[transfer full]
Since: 3.34
EConflictResolution
e_book_util_operation_flags_to_conflict_resolution
(guint32 flags
);
Decodes the EConflictResolution from the bit-or of EBookOperationFlags.
Since: 3.34
void e_book_util_foreach_address (const gchar *email_address
,GHRFunc func
,gpointer user_data
);
Parses the email_address
and calls func
for each found address.
The first parameter of the func
is the name, the second parameter
of the func
is the email, the third parameters of the func
is
the user_data
. The func
returns TRUE
, to continue processing.
email_address |
one or more email addresses as string |
|
func |
a function to call for each email. |
[scope call] |
user_data (closure func) |
user data passed to |
Since: 3.44
#define E_BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS "required-fields"
Provides comma-separated list of required fields by the book backend. All of these attributes should be set, otherwise the backend will reject saving the contact.
The e_contact_field_id()
can be used to transform the field name
into an EContactField.
Since: 3.2
#define E_BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS "supported-fields"
Provides comma-separated list of supported fields by the book backend. Attributes other than those listed here can be discarded. This can be used to enable/show only supported elements in GUI.
The e_contact_field_id()
can be used to transform the field name
into an EContactField.
Since: 3.2
#define E_BOOK_BACKEND_PROPERTY_REVISION "revision"
The current overall revision string, this can be used as a quick check to see if data has changed at all since the last time the addressbook revision was observed.
Since: 3.4
#define E_BOOK_CLIENT_ERROR e_book_client_error_quark ()
Error domain for EBookClient errors
Since: 3.2
Error codes returned by EBookClient APIs, if an EClientError was not available.
Requested book did not exist |
||
Contact referred to was not found |
||
Tried to add a contact which already exists |
||
Referred ESource does not exist |
||
Out of disk space |
Since: 3.2
EBookViewStatus
has been deprecated since version 3.2 and should not be used in newly-written code.
Use EBookClientView instead.
Status messages used in notifications in the deprecated EBookView class
EBookChangeType
has been deprecated since version 3.2 and should not be used in newly-written code.
The type of change in an EBookChange
typedef struct { EBookChangeType change_type; EContact *contact; } EBookChange;
EBookChange
has been deprecated since version 3.2 and should not be used in newly-written code.
This is a part of the deprecated EBook API.
EBookChangeType |
The EBookChangeType |
|
EContact * |
The EContact which changed |