EDataBook – 1.2
Description: Reference for EDataBook-1.2

### Namespace

# EDataBook – 1.2

Backend library for Evolution Data Server address books

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

#### Build

C headers | `libedata-book/libedata-book.h`
pkg-config files | `libedata-book-1.2`

#### Dependencies

GObject—2.0 | The base type system library
| Browse documentation
EDataServer—1.2 | Utility library for Evolution Data Server
| Browse documentation
EBookContacts—1.2 | Client library for Evolution Data Server contacts and vCard structures
| Browse documentation

#### Additional documentation

- Classes Hierarchy

#### Classes

BookBackend | Contains only private data that should be read and manipulated using the functions below.
BookBackendFactory | Contains only private data that should be read and manipulated using the functions below.
BookBackendSExp |
BookBackendSync | Contains only private data that should be read and manipulated using the functions below.
BookCache | Contains only private data that should be read and manipulated using the functions below. since: 3.26
BookMetaBackend | Contains only private data that should be read and manipulated using the functions below. since: 3.26
BookSqlite | Contains only private data that should be read and manipulated using the functions below. since: 3.12
DataBook |
DataBookCursor | An opaque handle for an addressbook cursor. since: 3.12
DataBookCursorCache | An opaque handle for the `EBookCache` cursor instance. since: 3.26
DataBookCursorSqlite | An opaque handle for the SQLite cursor instance. since: 3.12
DataBookDirect |
DataBookFactory |
DataBookView |
DataBookViewWatcherCache | A structure used to handle “manual query” views for `EBookBackend` descendants which use `EBookCache` to store the contacts. since: 3.50
DataBookViewWatcherMemory | A structure used as a default implementation to handle “manual query” views by the `EBookBackend`. since: 3.50
DataBookViewWatcherSqlite | A structure used to handle “manual query” views for `EBookBackend` descendants which use `EBookSqlite` to store the contacts. since: 3.50
SubprocessBookFactory |
SystemLocaleWatcher | Contains only private data that should be read and manipulated using the functions below.

#### Structs

BookCacheCursor | An opaque cursor pointer. since: 3.26
BookCacheSearchData | This structure is used to represent contacts returned by the `EBookCache` from various functions such as e_book_cache_search(). since: 3.26
BookMetaBackendInfo |
bSqlCursor | An opaque cursor pointer. since: 3.12
bSqlSearchData | This structure is used to represent contacts returned by the `EBookSqlite` from various functions such as e_book_sqlitedb_search(). since: 3.12

#### Enumerations

BookBackendSexpCompareKind | What compare function should be used when comparing two values. since: 3.50
BookCacheCursorOrigin | Specifies the start position to in the list of traversed contacts in calls to e_book_cache_cursor_step(). since: 3.26
BookSqliteError | Defines the types of possible errors reported by the `EBookSqlite`.
bSqlChangeType | Indicates the type of change which occurred in an `EbSqlChangeCallback`. since: 3.12
bSqlCursorOrigin | Specifies the start position to in the list of traversed contacts in calls to e_book_sqlite_cursor_step(). since: 3.12
bSqlLockType | Indicates the type of lock requested in e_book_sqlite_lock().
bSqlUnlockAction | Indicates what type of action to take while unlocking the sqlite with e_book_sqlite_unlock().

#### Bitfields

BookCacheCursorStepFlags | Defines the behaviour of e_book_cache_cursor_step(). since: 3.26
bSqlCursorStepFlags | Defines the behaviour of e_book_sqlite_cursor_step(). since: 3.12

#### Callbacks

BookBackendCustomOpFunc | A callback prototype being called in a dedicated thread, scheduled by e_book_backend_schedule_custom_operation(). since: 3.26
BookBackendForeachViewFunc | Callback function used by e_book_backend_foreach_view(). since: 3.34
BookCacheSearchFunc | A callback called for each object row when using `e_book_cache_search_with_callback()` function. since: 3.26
BookSqliteSelectFunc | A callback called for each row of a SELECT statement executed with `e_book_sqlite_select()` function. since: 3.48
bSqlChangeCallback | A function which may be called in response to a change in contact data. since: 3.12
bSqlVCardCallback | If this callback is passed to e_book_sqlite_new(), then vcards are not stored in the SQLite and instead this callback is invoked to fetch the vcard. since: 3.12
DataBookCursorCompareContactFunc | Method type for `EDataBookCursorClass`.compare_contact(). since: 3.12
DataBookCursorGetPositionFunc | Method type for `EDataBookCursorClass`.get_position(). since: 3.12
DataBookCursorLoadLocaleFunc | Method type for `EDataBookCursorClass`.load_locale(). since: 3.12
DataBookCursorSetAlphabetIndexFunc | Method type for `EDataBookCursorClass`.set_alphabetic_index(). since: 3.12
DataBookCursorSetSexpFunc | Method type for `EDataBookCursorClass`.set_sexp(). since: 3.12
DataBookCursorStepFunc | Method type for `EDataBookCursorClass`.step(). since: 3.12

#### Functions

ebsql_get_contact_extra_unlocked | Fetches the extra data previously set for `uid`, either with `e_book_sqlite_set_contact_extra()` or when adding contacts, without locking internal mutex. since: 3.16
ebsql_get_contact_unlocked | Fetch the `EContact` specified by `uid` in `ebsql` without locking internal mutex. since: 3.16
ebsql_get_vcard_unlocked | Fetch a vcard string for `uid` in `ebsql` without locking internal mutex. since: 3.16

#### Function Macros

BOOK_BACKEND_CACHE |
BOOK_BACKEND_CACHE_CLASS |
BOOK_BACKEND_SEXP |
BOOK_BACKEND_SEXP_CLASS |
BOOK_BACKEND_SQLITEDB |
BOOK_BACKEND_SQLITEDB_CLASS |
BOOK_BACKEND_SUMMARY |
BOOK_BACKEND_SUMMARY_CLASS |

#### Constants

BOOK_SQL_IS_POPULATED_KEY | This key can be used with e_book_sqlite_get_key_value().
BOOK_SQL_SYNC_DATA_KEY | This key can be used with e_book_sqlite_get_key_value().
EDS_ADDRESS_BOOK_MODULES | This environment variable configures where the address book factory loads its backend modules from.
EDS_SUBPROCESS_BOOK_PATH | This environment variable configures where the address book factory subprocess is located in.
XIMIAN_VCARD |