BookSqlite

---

Object Hierarchy:

Description:

Content:

Static methods:

• public static Quark error_quark ()
• public static void search_data_free (bSqlSearchData data)
  Frees an bSqlSearchData

Creation methods:

• public BookSqlite (string path, Source? source, Cancellable? cancellable = null) throws Error
  Creates a new BookSqlite with the default summary configuration.
• public BookSqlite.full (string path, Source? source, SourceBackendSummarySetup? setup, bSqlVCardCallback? vcard_callback, owned bSqlChangeCallback? change_callback, Cancellable? cancellable = null) throws Error
  Opens or creates a new addressbook at path.

Methods:

• public bool @lock (bSqlLockType lock_type, Cancellable? cancellable = null) throws Error
  Obtains an exclusive lock on this and starts a transaction.
• public bool @unlock (bSqlUnlockAction action) throws Error
  Releases an exclusive on this and finishes a transaction previously started with e_book_sqlite_lock_updates.
• public bool add_contact (Contact contact, string extra, bool replace, Cancellable? cancellable = null) throws Error
• public bool add_contacts (SList<Contact> contacts, SList<string>? extra, bool replace, Cancellable? cancellable = null) throws Error
  Adds or replaces contacts in this.
• public bool count_query (string? sexp, out uint out_n_total, Cancellable? cancellable = null) throws Error
  Counts how many contacts satisfy the sexp.
• public bool dup_query_contacts (string? sexp, ContactField sort_field, BookCursorSortType sort_type, uint n_offset, uint n_limit, owned GenericArray<unowned Contact> out_contacts, Cancellable? cancellable = null) throws Error
  Queries the this for the contacts in the given range and order.
• public bool dup_query_field (ContactField summary_field, string? sexp, ContactField sort_field, BookCursorSortType sort_type, uint n_offset, uint n_limit, owned GenericArray<unowned string> out_uids, owned GenericArray<unowned string> out_values, Cancellable? cancellable = null) throws Error
  Queries the this for a summary_field value for contacts in the given range and order.
• public bool dup_summary_field (ContactField summary_field, string uid, out string out_value, Cancellable? cancellable = null) throws Error
  Queries the this for a summary_field value for contact with UID uid.
• public bool exec (string sql_stmt, Cancellable? cancellable = null) throws Error
  Executes an SQLite statement.
• public bool get_contact (string uid, bool meta_contact, out Contact ret_contact) throws Error
  Fetch the Contact specified by uid in this.
• public bool get_contact_extra (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.
• public bool get_key_value (string key, out string value) throws Error
  Fetches the value for key and stores it in value
• public bool get_key_value_int (string key, out int value) throws Error
  A convenience function to fetch the value of key as an integer.
• public bool get_locale (out string locale_out) throws Error
  Fetches the current locale setting for the address-book.
• public bool get_vcard (string uid, bool meta_contact, out string ret_vcard) throws Error
  Fetch a vcard string for uid in this.
• public bool has_contact (string uid, out bool exists) throws Error
  Checks if a contact bearing the UID indicated by uid is stored in this.
• public Collator ref_collator ()
  References the currently active Collator for this, use unref when finished using the returned collator.
• public Source? ref_source ()
  References the Source to which this is paired, use unref when finished using the source.
• public bool remove_contact (string uid, Cancellable? cancellable = null) throws Error
  Removes the contact indicated by uid from this.
• public bool remove_contacts (SList<string> uids, Cancellable? cancellable = null) throws Error
  Removes the contacts indicated by uids from this.
• public bool search (string? sexp, bool meta_contacts, out SList<bSqlSearchData?> ret_list, Cancellable? cancellable = null) throws Error
  Searches this for contacts matching the search expression indicated by sexp.
• public bool search_uids (string? sexp, out SList<string> ret_list, Cancellable? cancellable = null) throws Error
  Similar to e_book_sqlitedb_search, but fetches only a list of contact UIDs.
• public bool select (string sql_stmt, BookSqliteSelectFunc func, Cancellable? cancellable = null) throws Error
  Executes a SELECT statement sql_stmt and calls func for each row of the result.
• public bool set_contact_extra (string uid, string? extra) throws Error
  Sets or replaces the extra data associated with uid.
• public bool set_key_value (string key, string value) throws Error
  Sets the value for key to be value
• public bool set_key_value_int (string key, int value) throws Error
  A convenience function to set the value of key as an integer.
• public bool set_locale (string lc_collate, Cancellable? cancellable = null) throws Error
  Relocalizes any locale specific data in the specified new lc_collate locale.

Signals:

• public virtual signal bool before_insert_contact (void* db, Contact contact, string extra, bool replace, Object cancellable)
• public virtual signal bool before_remove_contact (void* db, string contact_uid, Cancellable? cancellable = null)

Inherited Members: