libedata-book-1.2

---

Description:

Content:

Namespaces:

• E

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.
• BookCacheCursor - An opaque cursor pointer
• BookCacheSearchData - This structure is used to represent contacts returned by the BookCache from various functions such as search.
• BookMetaBackend - Contains only private data that should be read and manipulated using the functions below.
• BookMetaBackendInfo
• BookSqlite - Contains only private data that should be read and manipulated using the functions below.
• DataBook
• DataBookCursor - An opaque handle for an addressbook cursor
• DataBookCursorCache - An opaque handle for the BookCache cursor instance.
• DataBookCursorSqlite - An opaque handle for the SQLite cursor instance.
• DataBookDirect
• DataBookFactory
• DataBookView
• DataBookViewWatcherCache - A structure used to handle "manual query" views for BookBackend descendants which use BookCache to store the contacts.
• DataBookViewWatcherMemory - A structure used as a default implementation to handle "manual query" views by the BookBackend.
• DataBookViewWatcherSqlite - A structure used to handle "manual query" views for BookBackend descendants which use BookSqlite to store the contacts.
• SubprocessBookFactory
• SystemLocaleWatcher - Contains only private data that should be read and manipulated using the functions below.
• bSqlCursor - An opaque cursor pointer

Structs:

• bSqlSearchData - This structure is used to represent contacts returned by the BookSqlite from various functions such as e_book_sqlitedb_search.

Enums:

• BookBackendSexpCompareKind - What compare function should be used when comparing two values.
• BookCacheCursorOrigin - Specifies the start position to in the list of traversed contacts in calls to cursor_step.
• BookCacheCursorStepFlags - Defines the behaviour of cursor_step.
• BookSqliteError - Defines the types of possible errors reported by the BookSqlite
• bSqlChangeType - Indicates the type of change which occurred in an bSqlChangeCallback
• bSqlCursorOrigin - Specifies the start position to in the list of traversed contacts in calls to e_book_sqlite_cursor_step.
• bSqlCursorStepFlags - Defines the behaviour of e_book_sqlite_cursor_step.
• bSqlLockType - Indicates the type of lock requested in @lock
• bSqlUnlockAction - Indicates what type of action to take while unlocking the sqlite with @unlock

Constants:

• public const string BOOK_SQL_IS_POPULATED_KEY
  This key can be used with get_key_value.
• public const string BOOK_SQL_SYNC_DATA_KEY
  This key can be used with get_key_value.
• public const string EDS_ADDRESS_BOOK_MODULES
  This environment variable configures where the address book factory loads its backend modules from.
• public const string EDS_SUBPROCESS_BOOK_PATH
  This environment variable configures where the address book factory subprocess is located in.
• public const string XIMIAN_VCARD

Delegates:

• public delegate void BookBackendCustomOpFunc (BookBackend book_backend, Cancellable? cancellable = null) throws Error
  A callback prototype being called in a dedicated thread, scheduled by schedule_custom_operation.
• public delegate bool BookBackendForeachViewFunc (BookBackend backend, DataBookView view)
  Callback function used by foreach_view.
• public delegate bool BookCacheSearchFunc (BookCache book_cache, string uid, string revision, string object, string extra, uint32 custom_flags, OfflineState offline_state)
  A callback called for each object row when using search_with_callback function.
• public delegate bool BookSqliteSelectFunc (BookSqlite ebsql, string[] column_names, string[] column_values)
  A callback called for each row of a SELECT statement executed with select function.
• public delegate int DataBookCursorCompareContactFunc (DataBookCursor cursor, Contact contact, out bool matches_sexp)
  Method type for compare_contact
• public delegate bool DataBookCursorGetPositionFunc (DataBookCursor cursor, out int total, out int position, Cancellable? cancellable = null) throws Error
  Method type for EDataBookCursorClass.get_position
• public delegate bool DataBookCursorLoadLocaleFunc (DataBookCursor cursor, out string locale) throws Error
  Method type for EDataBookCursorClass.load_locale
• public delegate bool DataBookCursorSetAlphabetIndexFunc (DataBookCursor cursor, int index, string locale) throws Error
  Method type for EDataBookCursorClass.set_alphabetic_index
• public delegate bool DataBookCursorSetSexpFunc (DataBookCursor cursor, string? sexp) throws Error
  Method type for EDataBookCursorClass.set_sexp
• public delegate int DataBookCursorStepFunc (DataBookCursor cursor, string? revision_guard, BookCursorStepFlags flags, BookCursorOrigin origin, int count, out SList<string>? results, Cancellable? cancellable = null) throws Error
  Method type for step
• public delegate void bSqlChangeCallback (bSqlChangeType change_type, string uid, string extra, string vcard)
  A function which may be called in response to a change in contact data.
• public delegate string bSqlVCardCallback (string uid, string extra)
  If this callback is passed to BookSqlite, then vcards are not stored in the SQLite and instead this callback is invoked to fetch the vcard.

Methods:

• public void book_cache_search_data_free (void* data)
  Frees the data structure, previously allocated with BookCacheSearchData or copy.
• public void book_meta_backend_info_free (void* ptr)
  Frees the ptr structure, previously allocated with BookMetaBackendInfo or copy.
• public bool ebsql_get_contact_extra_unlocked (BookSqlite ebsql, string uid, out string ret_extra) throws Error
  Fetches the extra data previously set for uid, either with set_contact_extra or when adding contacts, without locking internal mutex.
• public bool ebsql_get_contact_unlocked (BookSqlite ebsql, string uid, bool meta_contact, out Contact contact) throws Error
  Fetch the Contact specified by uid in ebsql without locking internal mutex.
• public bool ebsql_get_vcard_unlocked (BookSqlite ebsql, string uid, bool meta_contact, out string ret_vcard) throws Error
  Fetch a vcard string for uid in ebsql without locking internal mutex.