e-book-contacts-enums

e-book-contacts-enums

Types and Values

Description

Functions

Types and Values

enum EBookClientViewFlags

Flags that control the behaviour of an EBookClientView.

Members

E_BOOK_CLIENT_VIEW_FLAGS_NONE

Symbolic value for no flags

 

E_BOOK_CLIENT_VIEW_FLAGS_NOTIFY_INITIAL

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


enum EBookIndexType

The type of index defined by e_source_backend_summary_setup_set_indexed_fields()

Members

E_BOOK_INDEX_PREFIX

An index suitable for searching contacts with a prefix pattern

 

E_BOOK_INDEX_SUFFIX

An index suitable for searching contacts with a suffix pattern

 

E_BOOK_INDEX_PHONE

An index suitable for searching contacts for phone numbers.

Phone 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.

 

E_BOOK_INDEX_SORT_KEY

Indicates that a given EContactField should be usable as a sort key.

 

enum EBookCursorSortType

Specifies the sort order of an ordered query

Members

E_BOOK_CURSOR_SORT_ASCENDING

Sort results in ascending order

 

E_BOOK_CURSOR_SORT_DESCENDING

Sort results in descending order

 

Since: 3.12


enum 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.

Members

E_BOOK_CURSOR_ORIGIN_CURRENT

The current cursor position

 

E_BOOK_CURSOR_ORIGIN_BEGIN

The beginning of the cursor results.

 

E_BOOK_CURSOR_ORIGIN_END

The ending of the cursor results.

 

Since: 3.12


enum EBookCursorStepFlags

Defines the behaviour of e_book_client_cursor_step().

Members

E_BOOK_CURSOR_STEP_MOVE

The cursor position should be modified while stepping

 

E_BOOK_CURSOR_STEP_FETCH

Traversed contacts should be listed and returned while stepping.

 

Since: 3.12


enum EBookOperationFlags

Book operation flags, to specify behavior in certain situations. The conflict resolution mode flags cannot be combined together, where the E_BOOK_OPERATION_FLAG_CONFLICT_KEEP_LOCAL is the default behavior (and it is used when no other conflict resolution flag is set). The flags can be ignored when the operation or the backend don't support it.

Members

E_BOOK_OPERATION_FLAG_NONE

no operation flags defined

 

E_BOOK_OPERATION_FLAG_CONFLICT_FAIL

conflict resolution mode, to fail and do not do any changes, when a conflict is detected

 

E_BOOK_OPERATION_FLAG_CONFLICT_USE_NEWER

conflict resolution mode, to use newer of the local and the server side data, when a conflict is detected

 

E_BOOK_OPERATION_FLAG_CONFLICT_KEEP_SERVER

conflict resolution mode, to use the server data (and local changed), when a conflict is detected

 

E_BOOK_OPERATION_FLAG_CONFLICT_KEEP_LOCAL

conflict resolution mode, to use local data (and always overwrite server data), when a conflict is detected

 

E_BOOK_OPERATION_FLAG_CONFLICT_WRITE_COPY

conflict resolution mode, to create a copy of the data, when a conflict is detected

 

Since: 3.34