E

---

Description:

Content:

Classes:

• AddressWestern - Western address structure.
• BookClientViewSortFields - This is a structure describing sort settings in the view.
• BookIndices - This is a structure describing indices of the contacts in the view.
• BookIndicesUpdater - An abstract object to handle EBookIndices changes.
• BookQuery
• Contact
• ContactAddress
• ContactAttrList
• ContactCert
• ContactDate
• ContactGeo
• ContactName
• ContactPhoto
• NameWestern
• PhoneNumber - This opaque type describes a parsed phone number.
• SourceBackendSummarySetup - Contains only private data that should be read and manipulated using the functions below.
• VCard
• VCardAttribute
• VCardAttributeParam

Structs:

• BookChange - This is a part of the deprecated EBook API.

Enums:

• BookChangeType - The type of change in an BookChange
• BookClientViewFlags - Flags that control the behaviour of an EBookClientView.
• BookCursorOrigin - Specifies the start position to in the list of traversed contacts in calls to e_book_client_cursor_step.
• BookCursorSortType - Specifies the sort order of an ordered query
• BookCursorStepFlags - Defines the behaviour of e_book_client_cursor_step.
• BookIndexType - The type of index defined by e_source_backend_summary_setup_set_indexed_fields
• BookOperationFlags - Book operation flags, to specify behavior in certain situations.
• BookQueryTest - The kind of test a query created by book_query_field_test shall perform.
• BookViewStatus - Status messages used in notifications in the deprecated EBookView class
• ContactField
• ContactPhotoType
• PhoneNumberCountrySource - The origin of a parsed EPhoneNumber's country calling code.
• PhoneNumberFormat - The supported formatting rules for phone numbers.
• PhoneNumberMatch
• VCardFormat

Error domains:

• BookClientError - Error codes returned by EBookClient APIs, if an ClientError was not available.
• PhoneNumberError - Numeric description of a phone number related error.

Constants:

• public const string BOOK_BACKEND_PROPERTY_CATEGORIES
  Provides comma-separated list of all known categories used by the contacts stored in the book backend.
• public const string BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS
  Provides comma-separated list of required fields by the book backend.
• public const string 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.
• public const string BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS
  Provides comma-separated list of supported fields by the book backend.
• public const string EVC_ADR
• public const string EVC_BDAY
• public const string EVC_CALURI
• public const string EVC_CATEGORIES
• public const string EVC_CL_UID
• public const string EVC_CONTACT_LIST
• public const string EVC_EMAIL
• public const string EVC_ENCODING
• public const string EVC_FBURL
• public const string EVC_FN
• public const string EVC_GEO
• public const string EVC_ICSCALENDAR
• public const string EVC_KEY
• public const string EVC_LABEL
• public const string EVC_LOGO
• public const string EVC_MAILER
• public const string EVC_N
• public const string EVC_NICKNAME
• public const string EVC_NOTE
• public const string EVC_ORG
• public const string EVC_PARENT_CL
• public const string EVC_PHOTO
• public const string EVC_PRODID
• public const string EVC_QUOTEDPRINTABLE
• public const string EVC_REV
• public const string EVC_ROLE
• public const string EVC_TEL
• public const string EVC_TITLE
• public const string EVC_TYPE
• public const string EVC_UID
• public const string EVC_URL
• public const string EVC_VALUE
• public const string EVC_VERSION
• public const string EVC_X_AIM
• public const string EVC_X_ANNIVERSARY
• public const string EVC_X_ASSISTANT
• public const string EVC_X_BIRTHDAY
• public const string EVC_X_BLOG_URL
• public const string EVC_X_BOOK_UID
• public const string EVC_X_CALLBACK
• public const string EVC_X_COMPANY
• public const string EVC_X_DEST_CONTACT_UID
• public const string EVC_X_DEST_EMAIL
• public const string EVC_X_DEST_EMAIL_NUM
• public const string EVC_X_DEST_HTML_MAIL
• public const string EVC_X_DEST_NAME
• public const string EVC_X_DEST_SOURCE_UID
• public const string EVC_X_E164
• public const string EVC_X_FILE_AS
• public const string EVC_X_GADUGADU
• public const string EVC_X_GOOGLE_TALK
• public const string EVC_X_GROUPWISE
• public const string EVC_X_ICQ
• public const string EVC_X_JABBER
• public const string EVC_X_LIST
• public const string EVC_X_LIST_NAME
• public const string EVC_X_LIST_SHOW_ADDRESSES
• public const string EVC_X_MANAGER
• public const string EVC_X_MATRIX
• public const string EVC_X_MSN
• public const string EVC_X_RADIO
• public const string EVC_X_SIP
• public const string EVC_X_SKYPE
• public const string EVC_X_SPOUSE
• public const string EVC_X_TELEX
• public const string EVC_X_TTYTDD
• public const string EVC_X_TWITTER
  Twitter name(s).
• public const string EVC_X_VIDEO_URL
• public const string EVC_X_WANTS_HTML
• public const string EVC_X_YAHOO
• public const string SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP
  Pass this extension name to get_extension to access SourceBackendSummarySetup.
• public const string VCARD_21_VALID_PARAMETERS
  FIXME: Document me!
• public const string VCARD_21_VALID_PROPERTIES
  FIXME: Document me!

Functions:

• public AddressWestern? address_western_parse (string? in_address)
  Parses a string representing a mailing address into a structure of type AddressWestern.
• public bool book_indices_get_ascending_sort (BookIndicesUpdater self)
  Returns whether the self considers contacts stored in the ascending order.
• public void book_indices_set_ascending_sort (BookIndicesUpdater self, bool ascending_sort)
  Sets whether the contacts are sorted in an ascending order; if not, then they are sorted in the descending order.
• public BookQuery book_query_and (int nqs, BookQuery qs, bool unref)
  Create a new BookQuery which is the logical AND of the queries in qss.
• public BookQuery book_query_any_field_contains (string value)
  Creates a new BookQuery which tests if any field contains value.
• public BookQuery book_query_field_exists (ContactField field)
  Creates a new BookQuery which tests if the field field exists.
• public BookQuery book_query_field_test (ContactField field, BookQueryTest test, string value)
  Creates a new BookQuery which tests field for value using the test test.
• public BookQuery book_query_from_string (string query_string)
  Parse query_string and return a new BookQuery representing it.
• public BookQuery book_query_or (int nqs, BookQuery qs, bool unref)
  Creates a new BookQuery which is the logical OR of the queries in qss.
• public BookQuery book_query_vcard_field_exists (string field)
  Creates a new BookQuery which tests if the field field exists.
• public BookQuery book_query_vcard_field_test (string field, BookQueryTest test, string value)
  Creates a new BookQuery which tests field for value using the test test.
• public uint32 book_util_conflict_resolution_to_operation_flags (ConflictResolution conflict_resolution)
  Encodes the ConflictResolution into the bit-or of BookOperationFlags.
• public void book_util_diff_categories (Contact? old_contact, Contact? new_contact, out HashTable<unowned string,int> out_added, out HashTable<unowned string,int> out_removed)
  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.
• public void book_util_foreach_address (string email_address, HRFunc func)
  Parses the email_address and calls func for each found address.
• public ConflictResolution book_util_operation_flags_to_conflict_resolution (uint32 flags)
  Decodes the ConflictResolution from the bit-or of BookOperationFlags.
• public List<string> contact_attr_list_copy (List<string> list)
  Copies a list of allocated strings, specifically for the ContactAttrList boxed type used for multi valued contact fields.
• public void contact_attr_list_free (List<string> list)
  Frees a list of allocated strings, specifically for the ContactAttrList boxed type used for multi valued contact fields.
• public ContactDate contact_date_from_string (string str)
  Creates a new ContactDate based on str.
• public ContactName contact_name_from_string (string name_str)
  Creates a new ContactName based on the parsed name_str.
• public NameWestern name_western_parse (string full_name)
  Parses full_name and returns an NameWestern struct filled with the component parts of the name.
• public PhoneNumberMatch phone_number_compare_strings (string first_number, string second_number) throws Error
  Compares two phone numbers.
• public PhoneNumberMatch phone_number_compare_strings_with_region (string first_number, string second_number, string? region_code) throws Error
  Compares two phone numbers within the context of region_code.
• public PhoneNumber phone_number_from_string (string phone_number, string? region_code) throws Error
  Parses the string passed in phone_number.
• public int phone_number_get_country_code_for_region (string? region_code) throws Error
  Retrieves the preferred country calling code for region_code, e.g. 358 for "fi" or 1 for "en_USUTF-8".
• public string phone_number_get_default_region () throws Error
  Retrieves the current two-letter country code that's used by default for parsing phone numbers in phone_number_from_string.
• public bool phone_number_is_supported ()
  Checks if phone number support is available.