|  |  |  | Evolution-Data-Server Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | ||||
#define E_BOOK_CLIENT_ERROR enum EBookClientViewFlags; enum EBookClientError; enum EDataBookStatus; enum EBookViewStatus; enum EBookChangeType; EBookChange; enum EBookIndexType; enum EBookCursorSortType; enum EBookCursorOrigin; enum EBookCursorStepFlags; GQuark e_book_client_error_quark (void); const gchar * e_book_client_error_to_string (EBookClientError code); GError * e_book_client_error_create (EBookClientError code,const gchar *custom_msg);
#define E_BOOK_CLIENT_ERROR e_book_client_error_quark ()
Error domain for EBookClient errors
Since 3.2
typedef enum {
	E_BOOK_CLIENT_VIEW_FLAGS_NONE = 0,
	E_BOOK_CLIENT_VIEW_FLAGS_NOTIFY_INITIAL = (1 << 0),
} EBookClientViewFlags;
Flags that control the behaviour of an EBookClientView.
| Symbolic value for no flags | |
| If this flag is set then all contacts matching the view's query will
  be sent as notifications when starting the view, otherwise only future
  changes will be reported.  The default for a EBookClientView is TRUE. | 
Since 3.4
typedef enum {
	E_BOOK_CLIENT_ERROR_NO_SUCH_BOOK,
	E_BOOK_CLIENT_ERROR_CONTACT_NOT_FOUND,
	E_BOOK_CLIENT_ERROR_CONTACT_ID_ALREADY_EXISTS,
	E_BOOK_CLIENT_ERROR_NO_SUCH_SOURCE,
	E_BOOK_CLIENT_ERROR_NO_SPACE
} EBookClientError;
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
typedef enum {
	E_DATA_BOOK_STATUS_SUCCESS,
	E_DATA_BOOK_STATUS_BUSY,
	E_DATA_BOOK_STATUS_REPOSITORY_OFFLINE,
	E_DATA_BOOK_STATUS_PERMISSION_DENIED,
	E_DATA_BOOK_STATUS_CONTACT_NOT_FOUND,
	E_DATA_BOOK_STATUS_CONTACTID_ALREADY_EXISTS,
	E_DATA_BOOK_STATUS_AUTHENTICATION_FAILED,
	E_DATA_BOOK_STATUS_AUTHENTICATION_REQUIRED,
	E_DATA_BOOK_STATUS_UNSUPPORTED_FIELD,
	E_DATA_BOOK_STATUS_UNSUPPORTED_AUTHENTICATION_METHOD,
	E_DATA_BOOK_STATUS_TLS_NOT_AVAILABLE,
	E_DATA_BOOK_STATUS_NO_SUCH_BOOK,
	E_DATA_BOOK_STATUS_BOOK_REMOVED,
	E_DATA_BOOK_STATUS_OFFLINE_UNAVAILABLE,
	E_DATA_BOOK_STATUS_SEARCH_SIZE_LIMIT_EXCEEDED,
	E_DATA_BOOK_STATUS_SEARCH_TIME_LIMIT_EXCEEDED,
	E_DATA_BOOK_STATUS_INVALID_QUERY,
	E_DATA_BOOK_STATUS_QUERY_REFUSED,
	E_DATA_BOOK_STATUS_COULD_NOT_CANCEL,
	E_DATA_BOOK_STATUS_OTHER_ERROR,
	E_DATA_BOOK_STATUS_INVALID_SERVER_VERSION,
	E_DATA_BOOK_STATUS_NO_SPACE,
	E_DATA_BOOK_STATUS_INVALID_ARG,
	E_DATA_BOOK_STATUS_NOT_SUPPORTED,
	E_DATA_BOOK_STATUS_NOT_OPENED,
	E_DATA_BOOK_STATUS_OUT_OF_SYNC
} EDataBookStatus;
Error codes for the E_DATA_BOOK_ERROR domain, these are used in the backend.
| No error | |
| Backend was busy | |
| Offsite repository was not online | |
| Permission denied | |
| Contact referred to was not found | |
| Tried to add a contact which already exists | |
| Authentication failure | |
| Authentication required for this operation | |
| An unsupported EContactField was specified for a given operation | |
| The authentication method is unsupported | |
| TLS was not available | |
| Book did not exist | |
| Book was removed | |
| XXX Document me | |
| Exceeded limit of seach size | |
| Exceeded time limit for seach | |
| Given search espression is invalid | |
| Given search espression was refused | |
| Unable to cancel an operation | |
| An other error occurred | |
| Invalid server version | |
| Disk space insufficient | |
| Invalid argument | |
| Unsupported operation | |
| Tried to access a book which is not yet open | |
| Out of sync state | 
Since 3.6
typedef enum {
	E_BOOK_VIEW_STATUS_OK,
	E_BOOK_VIEW_STATUS_TIME_LIMIT_EXCEEDED,
	E_BOOK_VIEW_STATUS_SIZE_LIMIT_EXCEEDED,
	E_BOOK_VIEW_ERROR_INVALID_QUERY,
	E_BOOK_VIEW_ERROR_QUERY_REFUSED,
	E_BOOK_VIEW_ERROR_OTHER_ERROR
} EBookViewStatus;
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
| Ok | |
| Time limit exceeded | |
| Size limit exceeded | |
| Invalid search expression | |
| Search expression refused | |
| Another error occurred | 
typedef enum {
	E_BOOK_CHANGE_CARD_ADDED,
	E_BOOK_CHANGE_CARD_DELETED,
	E_BOOK_CHANGE_CARD_MODIFIED
} EBookChangeType;
EBookChangeType is deprecated and should not be used in newly-written code. 3.2
The type of change in an EBookChange
typedef struct {
	EBookChangeType  change_type;
	EContact        *contact;
} EBookChange;
EBookChange is deprecated and should not be used in newly-written code. 3.2
This is a part of the deprecated EBook API.
| EBookChangeType  | The EBookChangeType | 
| EContact * | The EContact which changed | 
typedef enum {
	E_BOOK_INDEX_PREFIX = 0,
	E_BOOK_INDEX_SUFFIX,
	E_BOOK_INDEX_PHONE,
	E_BOOK_INDEX_SORT_KEY
} EBookIndexType;
The type of index defined by e_source_backend_summary_setup_set_indexed_fields()
| An index suitable for searching contacts with a prefix pattern | |
| An index suitable for searching contacts with a suffix pattern | |
| An index suitable for searching contacts for phone numbers. NotePhone numbers must be convertible into FQTN according to E.164 to be stored in this index. The number "+9999999" for instance won't be stored because the country calling code "+999" currently is not assigned. | |
| Indicates that a given EContactField should be usable as a sort key. | 
typedef enum {
	E_BOOK_CURSOR_SORT_ASCENDING = 0,
	E_BOOK_CURSOR_SORT_DESCENDING
} EBookCursorSortType;
Specifies the sort order of an ordered query
| Sort results in ascending order | |
| Sort results in descending order | 
Since 3.12
typedef enum {
	E_BOOK_CURSOR_ORIGIN_CURRENT,
	E_BOOK_CURSOR_ORIGIN_BEGIN,
	E_BOOK_CURSOR_ORIGIN_END
} EBookCursorOrigin;
Specifies the start position to in the list of traversed contacts
in calls to e_book_client_cursor_step().
When an EBookClientCursor is created, the current position implied by E_BOOK_CURSOR_ORIGIN_CURRENT
is the same as E_BOOK_CURSOR_ORIGIN_BEGIN.
| The current cursor position | |
| The beginning of the cursor results. | |
| The ending of the cursor results. | 
Since 3.12
typedef enum {
	E_BOOK_CURSOR_STEP_MOVE = (1 << 0),
	E_BOOK_CURSOR_STEP_FETCH = (1 << 1)
} EBookCursorStepFlags;
Defines the behaviour of e_book_client_cursor_step().
| The cursor position should be modified while stepping | |
| Traversed contacts should be listed and returned while stepping. | 
Since 3.12
const gchar *       e_book_client_error_to_string       (EBookClientError code);
FIXME: Document me.
| 
 | an EBookClientError code | 
Since 3.2
GError * e_book_client_error_create (EBookClientError code,const gchar *custom_msg);
e_book_client_error_create has been deprecated since version 3.8 and should not be used in newly-written code. Just use the GError API directly.
| 
 | an EBookClientError code to create | 
| 
 | custom message to use for the error; can be NULL | 
| Returns : | a new GError containing an E_BOOK_CLIENT_ERROR of the given code. If thecustom_msgis NULL, then the error message is
the one returned frome_book_client_error_to_string()for thecode,
otherwise the given message is used.
Returned pointer should be freed withg_error_free(). | 
Since 3.2