EBookContacts – 1.2
Description: Reference for EBookContacts-1.2

### Namespace

# EBookContacts – 1.2

Client library for Evolution Data Server contacts and vCard structures

Version | 3.60.2
Authors | Evolution Data Server Development Team
License | LGPL-2.0-only
Website |
Source | https://gitlab.gnome.org/GNOME/evolution-data-server/

#### Build

C headers | `libebook-contacts/libebook-contacts.h`
pkg-config files | `libebook-contacts-1.2`

#### Dependencies

GObject—2.0 | The base type system library
| Browse documentation
EDataServer—1.2 | Utility library for Evolution Data Server
| Browse documentation

#### Additional documentation

- Classes Hierarchy

#### Classes

BookIndicesUpdater | An abstract object to handle EBookIndices changes. since: 3.50
Contact |
SourceBackendSummarySetup | Contains only private data that should be read and manipulated using the functions below. since: 3.8
VCard |

#### Structs

AddressWestern | Western address structure.
BookChange | This is a part of the deprecated `EBook` API. deprecated: 3.2
BookClientViewSortFields | This is a structure describing sort settings in the view. See `e_book_client_view_set_sort_fields_sync()` for more information. since: 3.50
BookIndices | This is a structure describing indices of the contacts in the view. See `e_book_client_view_dup_indices()` for more information. since: 3.50
BookQuery |
ContactAddress |
ContactCert |
ContactDate |
ContactDateTime |
ContactGender |
ContactGeo | since: 1.12
ContactName |
ContactPhoto |
NameWestern |
PhoneNumber | This opaque type describes a parsed phone number. It can be copied using e_phone_number_copy(). To release it call e_phone_number_free(). since: 3.8
VCardAttribute |
VCardAttributeParam |

#### Enumerations

BookChangeType | The type of change in an `EBookChange`. deprecated: 3.2
BookCursorOrigin | Specifies the start position to in the list of traversed contacts in calls to e_book_client_cursor_step(). since: 3.12
BookCursorSortType | Specifies the sort order of an ordered query. since: 3.12
BookIndexType | The type of index defined by e_source_backend_summary_setup_set_indexed_fields().
BookQueryTest | The kind of test a query created by `e_book_query_field_test()` shall perform.
BookViewStatus | Status messages used in notifications in the deprecated `EBookView` class. deprecated: 3.2
ContactField |
ContactGenderSex |
ContactPhotoType |
PhoneNumberCountrySource | The origin of a parsed EPhoneNumber’s country calling code. since: 3.8
PhoneNumberFormat | The supported formatting rules for phone numbers. since: 3.8
PhoneNumberMatch | The strength of a phone number match. since: 3.8
VCardVersion | Declares vCard version. since: 3.60

#### Bitfields

BookClientViewFlags | Flags that control the behaviour of an `EBookClientView`. since: 3.4
BookCursorStepFlags | Defines the behaviour of e_book_client_cursor_step(). since: 3.12
BookOperationFlags | 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. since: 3.34
ContactDateTimeFlags | Flags to export the `EContactDateTime` to string. The default behavior is to export only the set parts of the structure. With the `E_CONTACT_DATE_TIME_FLAG_DATE_TIME` the exported text will always contain the time delimiter. The import uses the `E_CONTACT_DATE_TIME_FLAG_TIME` to distinguish whether the time delimiter is expected or not. since: 3.60
VCardForeachFlags | Behavior flags for the e_vcard_foreach(). since: 3.60

#### Error Domains

BookClientError | Error codes returned by `EBookClient` APIs, if an `EClientError` was not available. since: 3.2
PhoneNumberError | Numeric description of a phone number related error. since: 3.8

#### Callbacks

VCardForeachFunc | A callback prototype for `e_vcard_foreach()` and e_vcard_foreach_remove(). since: 3.60

#### Functions

book_client_error_create | since: 3.2
book_client_error_create_fmt | 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. since: 3.34
book_client_error_quark |
book_client_error_to_string | Get localized human readable description of the given error code. since: 3.2
book_util_conflict_resolution_to_operation_flags | Encodes the `EConflictResolution` into the bit-or of `EBookOperationFlags`. The returned value can be bit-or-ed with other `EBookOperationFlags` values. since: 3.34
book_util_diff_categories | Compares list of categories on the `old_contact` with the list of categories on the `new_contact` and fills `out_added` categories and `out_removed` categories accordingly, as if the `old_contact` is replaced with the `new_contact`. When either of the contacts is `NULL`, it’s considered as having no categories set. Rather than returning empty `GHashTable`, the return argument is set to `NULL` when there are no added/removed categories. since: 3.48
book_util_foreach_address | 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. since: 3.44
book_util_operation_flags_to_conflict_resolution | Decodes the `EConflictResolution` from the bit-or of `EBookOperationFlags`. since: 3.34
contact_attr_list_copy | Copies a list of allocated strings, specifically for the `EContactAttrList` boxed type used for multi valued contact fields. since: 3.8
contact_attr_list_free | Frees a list of allocated strings, specifically for the `EContactAttrList` boxed type used for multi valued contact fields. since: 3.8

#### Function Macros

VCARD |
VCARD_CLASS |
VCARD_X_EVOLUTION_PREFIX |

#### Constants

BOOK_BACKEND_PROPERTY_CATEGORIES | Provides comma-separated list of all known categories used by the contacts stored in the book backend.
BOOK_BACKEND_PROPERTY_PREFER_VCARD_VERSION | A book backend string property name containing a vCard version the backend prefers. Common values are “3.0” and “4.0”. It is only what the backend prefers for the exchange, it can receive other vCard versions too, the same as it can return vCard data in a different version (like when the server has stored vCards in multiple versions, then they are not converted by the backend.
BOOK_BACKEND_PROPERTY_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.
BOOK_BACKEND_PROPERTY_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.
BOOK_BACKEND_PROPERTY_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.
EVC_ADR |
EVC_ALTID |
EVC_ANNIVERSARY |
EVC_BDAY |
EVC_BIRTHPLACE |
EVC_CALADRURI |
EVC_CALSCALE |
EVC_CALURI |
EVC_CATEGORIES |
EVC_CL_UID |
EVC_CLIENTPIDMAP |
EVC_CONTACT_LIST |
EVC_CONTACT_URI |
EVC_CREATED |
EVC_DEATHDATE |
EVC_DEATHPLACE |
EVC_EMAIL |
EVC_ENCODING |
EVC_EXPERTISE |
EVC_FBURL |
EVC_FN |
EVC_GENDER |
EVC_GEO |
EVC_GRAMGENDER |
EVC_HOBBY |
EVC_ICSCALENDAR |
EVC_IMPP |
EVC_INTEREST |
EVC_JSPROP |
EVC_KEY |
EVC_KIND |
EVC_LABEL |
EVC_LANG |
EVC_LANGUAGE |
EVC_LOGO |
EVC_MAILER |
EVC_MEDIATYPE |
EVC_MEMBER |
EVC_N |
EVC_NICKNAME |
EVC_NOTE |
EVC_ORG |
EVC_ORG_DIRECTORY |
EVC_PARENT_CL |
EVC_PHOTO |
EVC_PID |
EVC_PREF |
EVC_PRODID |
EVC_PRONOUNS |
EVC_QUOTEDPRINTABLE |
EVC_RELATED |
EVC_REV |
EVC_ROLE |
EVC_SOCIALPROFILE |
EVC_SORT_AS |
EVC_SOUND |
EVC_SOURCE |
EVC_TEL |
EVC_TITLE |
EVC_TYPE |
EVC_TZ |
EVC_UID |
EVC_URL |
EVC_VALUE |
EVC_VERSION |
EVC_X_AIM |
EVC_X_ANNIVERSARY |
EVC_X_ASSISTANT |
EVC_X_BIRTHDAY |
EVC_X_BLOG_URL |
EVC_X_BOOK_UID |
EVC_X_CALLBACK |
EVC_X_COMPANY |
EVC_X_DEST_CONTACT_UID |
EVC_X_DEST_EMAIL |
EVC_X_DEST_EMAIL_NUM |
EVC_X_DEST_HTML_MAIL |
EVC_X_DEST_NAME |
EVC_X_DEST_SOURCE_UID |
EVC_X_E164 |
EVC_X_FILE_AS |
EVC_X_GADUGADU |
EVC_X_GOOGLE_TALK |
EVC_X_GROUPWISE |
EVC_X_ICQ |
EVC_X_JABBER |
EVC_X_LIST |
EVC_X_LIST_NAME |
EVC_X_LIST_SHOW_ADDRESSES |
EVC_X_MANAGER |
EVC_X_MATRIX |
EVC_X_MSN |
EVC_X_RADIO |
EVC_X_SIP |
EVC_X_SKYPE |
EVC_X_SOCIALPROFILE |
EVC_X_SPOUSE |
EVC_X_TELEX |
EVC_X_TTYTDD |
EVC_X_TWITTER | Twitter name(s).
EVC_X_VIDEO_URL |
EVC_X_WANTS_HTML |
EVC_X_YAHOO |
EVC_XML |
SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP | Pass this extension name to `e_source_get_extension()` to access `ESourceBackendSummarySetup`. This is also used as a group name in key files.