BookClient

---

Object Hierarchy:

Description:

Content:

Properties:

• public string locale { get; }
  The currently active locale for this addressbook.

Static methods:

• public static async BookClient connect (Source source, uint32 wait_for_connected_seconds, Cancellable? cancellable) throws Error
  Asynchronously creates a new BookClient for source.
• public static async BookClient connect_direct (Source source, uint32 wait_for_connected_seconds, Cancellable? cancellable) throws Error
  Like connect , except creates the book client for direct read access to the underlying addressbook.
• public static BookClient connect_direct_sync (SourceRegistry registry, Source source, uint32 wait_for_connected_seconds, Cancellable? cancellable = null) throws Error
  Like connect_sync, except creates the book client for direct read access to the underlying addressbook.
• public static BookClient connect_sync (Source source, uint32 wait_for_connected_seconds, Cancellable? cancellable = null) throws Error
  Creates a new BookClient for source .
• public static bool get_self (SourceRegistry registry, out Contact out_contact, out BookClient out_client) throws Error
  Get the Contact referring to the user of the address book and set it in out_contact and out_client.
• public static bool is_self (Contact contact)
  Check if contact is the user of the address book.

Creation methods:

• public BookClient (Source source) throws Error
  Creates a new BookClient corresponding to the given source.

Methods:

• public async bool add_contact (Contact contact, BookOperationFlags opflags, Cancellable? cancellable, out string out_added_uid) throws Error
  Adds contact to this.
• public bool add_contact_sync (Contact contact, BookOperationFlags opflags, out string out_added_uid, Cancellable? cancellable = null) throws Error
  Adds contact to this and sets out_added_uid to a UID of a newly added contact.
• public async bool add_contacts (SList<Contact> contacts, BookOperationFlags opflags, Cancellable? cancellable, out SList<string> out_added_uids) throws Error
  Adds contacts to this.
• public bool add_contacts_sync (SList<Contact> contacts, BookOperationFlags opflags, out SList<string> out_added_uids, Cancellable? cancellable = null) throws Error
  Adds contacts to this and sets out_added_uids to the UIDs of newly added contacts if successful.
• public async bool contains_email (string email_address, Cancellable? cancellable) throws Error
  Asynchronously checks whether contains an email_address.
• public bool contains_email_sync (string email_address, Cancellable? cancellable = null) throws Error
• public async bool get_contact (string uid, Cancellable? cancellable, out Contact out_contact) throws Error
  Receive Contact from the this for the given uid.
• public bool get_contact_sync (string uid, out Contact out_contact, Cancellable? cancellable = null) throws Error
  Receive Contact from the this for the gived uid.
• public async bool get_contacts (string sexp, Cancellable? cancellable, out SList<Contact> out_contacts) throws Error
  Query this with sexp, receiving a list of contacts which matched.
• public bool get_contacts_sync (string sexp, out SList<Contact> out_contacts, Cancellable? cancellable = null) throws Error
  Query this with sexp, receiving a list of contacts which matched.
• public async bool get_contacts_uids (string sexp, Cancellable? cancellable, out SList<string> out_contact_uids) throws Error
  Query this with sexp, receiving a list of contacts UIDs which matched.
• public bool get_contacts_uids_sync (string sexp, out SList<string> out_contact_uids, Cancellable? cancellable = null) throws Error
  Query this with sexp, receiving a list of contacts UIDs which matched.
• public async bool get_cursor (string sexp, ContactField sort_fields, BookCursorSortType sort_types, uint n_fields, Cancellable? cancellable, out BookClientCursor out_cursor) throws Error
  Create an BookClientCursor.
• public bool get_cursor_sync (string sexp, ContactField sort_fields, BookCursorSortType sort_types, uint n_fields, out BookClientCursor out_cursor, Cancellable? cancellable = null) throws Error
  Create an BookClientCursor.
• public unowned string get_locale ()
  Reports the locale in use for this.
• public VCardVersion get_prefer_vcard_version ()
  Gets a preferred vCard version by the this backend.
• public async bool get_view (string sexp, Cancellable? cancellable, out BookClientView out_view) throws Error
  Query this with sexp, creating an BookClientView.
• public bool get_view_sync (string sexp, out BookClientView out_view, Cancellable? cancellable = null) throws Error
  Query this with sexp, creating an BookClientView.
• public async bool modify_contact (Contact contact, BookOperationFlags opflags, Cancellable? cancellable) throws Error
  Applies the changes made to contact to the stored version in this.
• public bool modify_contact_sync (Contact contact, BookOperationFlags opflags, Cancellable? cancellable = null) throws Error
  Applies the changes made to contact to the stored version in this.
• public async bool modify_contacts (SList<Contact> contacts, BookOperationFlags opflags, Cancellable? cancellable) throws Error
  Applies the changes made to contacts to the stored versions in this.
• public bool modify_contacts_sync (SList<Contact> contacts, BookOperationFlags opflags, Cancellable? cancellable = null) throws Error
  Applies the changes made to contacts to the stored versions in this.
• public async bool remove_contact (Contact contact, BookOperationFlags opflags, Cancellable? cancellable) throws Error
  Removes contact from the this .
• public async bool remove_contact_by_uid (string uid, BookOperationFlags opflags, Cancellable? cancellable) throws Error
  Removes contact with uid from the this.
• public bool remove_contact_by_uid_sync (string uid, BookOperationFlags opflags, Cancellable? cancellable = null) throws Error
  Removes contact with uid from the this.
• public bool remove_contact_sync (Contact contact, BookOperationFlags opflags, Cancellable? cancellable = null) throws Error
  Removes contact from the this .
• public async bool remove_contacts (SList<string> uids, BookOperationFlags opflags, Cancellable? cancellable) throws Error
  Removes the contacts with uids from the list uids from this.
• public bool remove_contacts_sync (SList<string> uids, BookOperationFlags opflags, Cancellable? cancellable = null) throws Error
  Removes the contacts with uids from the list uids from this.
• public bool set_self (Contact contact) throws Error
  Specify that contact residing in this is the Contact that refers to the user of the address book.

Inherited Members: