Namespace EBookContacts

Index

Enumerations

Interfaces

Variables

Const BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS

BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS: string

Provides comma-separated list of required fields by the book backend. All of these attributes should be set, otherwise the backend will reject saving the contact.

The e_contact_field_id() can be used to transform the field name into an #EContactField.

Const BOOK_BACKEND_PROPERTY_REVISION

BOOK_BACKEND_PROPERTY_REVISION: string

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.

Const BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS

BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS: string

Provides comma-separated list of supported fields by the book backend. Attributes other than those listed here can be discarded. This can be used to enable/show only supported elements in GUI.

The e_contact_field_id() can be used to transform the field name into an #EContactField.

Const EVC_ADR

EVC_ADR: string

Const EVC_BDAY

EVC_BDAY: string

Const EVC_CALURI

EVC_CALURI: string

Const EVC_CATEGORIES

EVC_CATEGORIES: string

Const EVC_CL_UID

EVC_CL_UID: string

Const EVC_CONTACT_LIST

EVC_CONTACT_LIST: string

Const EVC_EMAIL

EVC_EMAIL: string

Const EVC_ENCODING

EVC_ENCODING: string

Const EVC_FBURL

EVC_FBURL: string

Const EVC_FN

EVC_FN: string

Const EVC_GEO

EVC_GEO: string

Const EVC_ICSCALENDAR

EVC_ICSCALENDAR: string

Const EVC_KEY

EVC_KEY: string

Const EVC_LABEL

EVC_LABEL: string

Const EVC_LOGO

EVC_LOGO: string

Const EVC_MAILER

EVC_MAILER: string

Const EVC_N

EVC_N: string

Const EVC_NICKNAME

EVC_NICKNAME: string

Const EVC_NOTE

EVC_NOTE: string

Const EVC_ORG

EVC_ORG: string

Const EVC_PARENT_CL

EVC_PARENT_CL: string

Const EVC_PHOTO

EVC_PHOTO: string

Const EVC_PRODID

EVC_PRODID: string

Const EVC_QUOTEDPRINTABLE

EVC_QUOTEDPRINTABLE: string

Const EVC_REV

EVC_REV: string

Const EVC_ROLE

EVC_ROLE: string

Const EVC_TEL

EVC_TEL: string

Const EVC_TITLE

EVC_TITLE: string

Const EVC_TYPE

EVC_TYPE: string

Const EVC_UID

EVC_UID: string

Const EVC_URL

EVC_URL: string

Const EVC_VALUE

EVC_VALUE: string

Const EVC_VERSION

EVC_VERSION: string

Const EVC_X_AIM

EVC_X_AIM: string

Const EVC_X_ANNIVERSARY

EVC_X_ANNIVERSARY: string

Const EVC_X_ASSISTANT

EVC_X_ASSISTANT: string

Const EVC_X_BIRTHDAY

EVC_X_BIRTHDAY: string

Const EVC_X_BLOG_URL

EVC_X_BLOG_URL: string

Const EVC_X_BOOK_UID

EVC_X_BOOK_UID: string

Const EVC_X_CALLBACK

EVC_X_CALLBACK: string

Const EVC_X_COMPANY

EVC_X_COMPANY: string

Const EVC_X_DEST_CONTACT_UID

EVC_X_DEST_CONTACT_UID: string

Const EVC_X_DEST_EMAIL

EVC_X_DEST_EMAIL: string

Const EVC_X_DEST_EMAIL_NUM

EVC_X_DEST_EMAIL_NUM: string

Const EVC_X_DEST_HTML_MAIL

EVC_X_DEST_HTML_MAIL: string

Const EVC_X_DEST_NAME

EVC_X_DEST_NAME: string

Const EVC_X_DEST_SOURCE_UID

EVC_X_DEST_SOURCE_UID: string

Const EVC_X_E164

EVC_X_E164: string

Const EVC_X_FILE_AS

EVC_X_FILE_AS: string

Const EVC_X_GADUGADU

EVC_X_GADUGADU: string

Const EVC_X_GOOGLE_TALK

EVC_X_GOOGLE_TALK: string

Const EVC_X_GROUPWISE

EVC_X_GROUPWISE: string

Const EVC_X_ICQ

EVC_X_ICQ: string

Const EVC_X_JABBER

EVC_X_JABBER: string

Const EVC_X_LIST

EVC_X_LIST: string

Const EVC_X_LIST_NAME

EVC_X_LIST_NAME: string

Const EVC_X_LIST_SHOW_ADDRESSES

EVC_X_LIST_SHOW_ADDRESSES: string

Const EVC_X_MANAGER

EVC_X_MANAGER: string

Const EVC_X_MATRIX

EVC_X_MATRIX: string

Const EVC_X_MSN

EVC_X_MSN: string

Const EVC_X_RADIO

EVC_X_RADIO: string

Const EVC_X_SIP

EVC_X_SIP: string

Const EVC_X_SKYPE

EVC_X_SKYPE: string

Const EVC_X_SPOUSE

EVC_X_SPOUSE: string

Const EVC_X_TELEX

EVC_X_TELEX: string

Const EVC_X_TTYTDD

EVC_X_TTYTDD: string

Const EVC_X_TWITTER

EVC_X_TWITTER: string

Twitter name(s).

Const EVC_X_VIDEO_URL

EVC_X_VIDEO_URL: string

Const EVC_X_WANTS_HTML

EVC_X_WANTS_HTML: string

Const EVC_X_YAHOO

EVC_X_YAHOO: string

Const SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP

SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP: string

Pass this extension name to e_source_get_extension() to access #ESourceBackendSummarySetup. This is also used as a group name in key files.

Const VCARD_21_VALID_PARAMETERS

VCARD_21_VALID_PARAMETERS: string

FIXME: Document me!

Const VCARD_21_VALID_PROPERTIES

VCARD_21_VALID_PROPERTIES: string

FIXME: Document me!

Functions

address_western_parse

address_western_parse(in_address: string): AddressWestern | null

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:723
Parses a string representing a mailing address into a structure of type #EAddressWestern.

Parameters
- in_address: string
  
  a string representing a mailing address
Returns AddressWestern | null

book_client_error_create

book_client_error_create(code: BookClientError, custom_msg: string): GLib.Error

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:724
Parameters
- code: BookClientError
- custom_msg: string
Returns GLib.Error

book_client_error_quark

book_client_error_quark(): Quark

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:725
Returns Quark

book_client_error_to_string

book_client_error_to_string(code: BookClientError): string

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:730
Get localized human readable description of the given error code.

Parameters
- code: BookClientError
  
  an #EBookClientError code
Returns string

book_query_and

book_query_and(nqs: number, qs: BookQuery, unref: boolean): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:737
Create a new #EBookQuery which is the logical AND of the queries in #qs.

Parameters
- nqs: number
  
  the number of queries to AND
- qs: BookQuery
  
  pointer to an array of #EBookQuery items
- unref: boolean
  
  if %TRUE, the new query takes ownership of the existing queries
Returns BookQuery

book_query_any_field_contains

book_query_any_field_contains(value: string): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:742
Creates a new #EBookQuery which tests if any field contains value.

Parameters
- value: string
  
  a value
Returns BookQuery

book_query_field_exists

book_query_field_exists(field: ContactField): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:747
Creates a new #EBookQuery which tests if the field field exists.

Parameters
- field: ContactField
  
  an #EContactField
Returns BookQuery

book_query_field_test

book_query_field_test(field: ContactField, test: BookQueryTest, value: string): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:754
Creates a new #EBookQuery which tests field for value using the test test.

Parameters
- field: ContactField
  
  an #EContactField to test
- test: BookQueryTest
  
  the test to apply
- value: string
  
  the value to test for
Returns BookQuery

book_query_from_string

book_query_from_string(query_string: string): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:759
Parse query_string and return a new #EBookQuery representing it.

Parameters
- query_string: string
  
  the query
Returns BookQuery

book_query_or

book_query_or(nqs: number, qs: BookQuery, unref: boolean): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:766
Creates a new #EBookQuery which is the logical OR of the queries in #qs.

Parameters
- nqs: number
  
  the number of queries to OR
- qs: BookQuery
  
  pointer to an array of #EBookQuery items
- unref: boolean
  
  if %TRUE, the new query takes ownership of the existing queries
Returns BookQuery

book_query_vcard_field_exists

book_query_vcard_field_exists(field: string): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:772
Creates a new #EBookQuery which tests if the field field exists. field should be a vCard field name, such as #EVC_FN or #EVC_X_MSN.

Parameters
- field: string
  
  a field name
Returns BookQuery

book_query_vcard_field_test

book_query_vcard_field_test(field: string, test: BookQueryTest, value: string): BookQuery

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:779
Creates a new #EBookQuery which tests field for value using the test test.

Parameters
- field: string
  
  a EVCard field name to test
- test: BookQueryTest
  
  the test to apply
- value: string
  
  the value to test for
Returns BookQuery

book_util_conflict_resolution_to_operation_flags

book_util_conflict_resolution_to_operation_flags(conflict_resolution: ConflictResolution): number

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:785
Encodes the #EConflictResolution into the bit-or of #EBookOperationFlags. The returned value can be bit-or-ed with other #EBookOperationFlags values.

Parameters
- conflict_resolution: ConflictResolution
  
  an #EConflictResolution
Returns number

book_util_foreach_address

book_util_foreach_address(email_address: string, func: HRFunc): void

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:794
Parses the email_address and calls func for each found address. The first parameter of the func is the name, the second parameter of the func is the email, the third parameters of the func is the user_data. The func returns %TRUE, to continue processing.

Parameters
- email_address: string
  
  one or more email addresses as string
- func: HRFunc
  
  a function to call for each email user_data (closure func): user data passed to func
Returns void

book_util_operation_flags_to_conflict_resolution

book_util_operation_flags_to_conflict_resolution(flags: number): ConflictResolution

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:799
Decodes the #EConflictResolution from the bit-or of #EBookOperationFlags.

Parameters
- flags: number
  
  bit-or of #EBookOperationFlags
Returns ConflictResolution

contact_attr_list_copy

contact_attr_list_copy(list: string[]): string[]

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:806
Copies a list of allocated strings, specifically for the #EContactAttrList boxed type used for multi valued contact fields.

Parameters
- list: string[]
  
  A #GList of strings
Returns string[]

contact_attr_list_free

contact_attr_list_free(list: string[]): void

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:813
Frees a list of allocated strings, specifically for the #EContactAttrList boxed type used for multi valued contact fields.

Parameters
- list: string[]
  
  A #GList of strings
Returns void

contact_date_from_string

contact_date_from_string(str: string): ContactDate

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:818
Creates a new #EContactDate based on str.

Parameters
- str: string
  
  a date string in the format YYYY-MM-DD or YYYYMMDD
Returns ContactDate

contact_name_from_string

contact_name_from_string(name_str: string): ContactName

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:823
Creates a new #EContactName based on the parsed name_str.

Parameters
- name_str: string
  
  a string representing a contact's full name
Returns ContactName

name_western_parse

name_western_parse(full_name: string): NameWestern

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:829
Parses full_name and returns an #ENameWestern struct filled with the component parts of the name.

Parameters
- full_name: string
  
  A string containing a western name.
Returns NameWestern

phone_number_compare_strings

phone_number_compare_strings(first_number: string, second_number: string): PhoneNumberMatch

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:835
Compares two phone numbers.

Parameters
- first_number: string
  
  the first EPhoneNumber to compare
- second_number: string
  
  the second EPhoneNumber to compare
Returns PhoneNumberMatch

phone_number_compare_strings_with_region

phone_number_compare_strings_with_region(first_number: string, second_number: string, region_code: string): PhoneNumberMatch

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:842
Compares two phone numbers within the context of region_code.

Parameters
- first_number: string
  
  the first EPhoneNumber to compare
- second_number: string
  
  the second EPhoneNumber to compare
- region_code: string
  
  a two-letter country code, or %NULL
Returns PhoneNumberMatch

phone_number_error_quark

phone_number_error_quark(): Quark

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:843
Returns Quark

phone_number_from_string

phone_number_from_string(phone_number: string, region_code: string): PhoneNumber

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:859
Parses the string passed in phone_number. Note that no validation is performed whether the recognized phone number is valid for a particular region.

The two-letter country code passed in region_code only is used if the phone_number is not written in international format. The application's default region as returned by e_phone_number_get_default_region() is used if region_code is %NULL.

If the number is guaranteed to start with a '+' followed by the country calling code, then "ZZ" can be passed for region_code.

Parameters
- phone_number: string
  
  the phone number to parse
- region_code: string
  
  a two-letter country code, or %NULL
Returns PhoneNumber

phone_number_get_country_code_for_region

phone_number_get_country_code_for_region(region_code: string): number

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:868
Retrieves the preferred country calling code for region_code, e.g. 358 for "fi" or 1 for "en_USUTF-8".

If %NULL is passed for region_code the default region as returned by e_phone_number_get_default_region() is used.

Parameters
- region_code: string
  
  a two-letter country code, a locale name, or %NULL
Returns number

phone_number_get_default_region

phone_number_get_default_region(): string

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:879
Retrieves the current two-letter country code that's used by default for parsing phone numbers in e_phone_number_from_string(). It can be useful to store this number before parsing a bigger number of phone numbers.

The result of this functions depends on the current setup of the %LC_ADDRESS category: If that category provides a reasonable value for %_NL_ADDRESS_COUNTRY_AB2 this value is returned. Otherwise the locale name configured for %LC_ADDRESS is parsed.

Returns string

phone_number_is_supported

phone_number_is_supported(): boolean

- Defined in @types/Gjs/EBookContacts-1.2.d.ts:886
Checks if phone number support is available. It is recommended to call this function before using any of the phone-utils functions to ensure that the required functionality is available, and to pick alternative mechanisms if needed.

Returns boolean

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS

Const BOOK_BACKEND_PROPERTY_REVISION

Const BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS

Const EVC_ADR

Const EVC_BDAY

Const EVC_CALURI

Const EVC_CATEGORIES

Const EVC_CL_UID

Const EVC_CONTACT_LIST

Const EVC_EMAIL

Const EVC_ENCODING

Const EVC_FBURL

Const EVC_FN

Const EVC_GEO

Const EVC_ICSCALENDAR

Const EVC_KEY

Const EVC_LABEL

Const EVC_LOGO

Const EVC_MAILER

Const EVC_N

Const EVC_NICKNAME

Const EVC_NOTE

Const EVC_ORG

Const EVC_PARENT_CL

Const EVC_PHOTO

Const EVC_PRODID

Const EVC_QUOTEDPRINTABLE

Const EVC_REV

Const EVC_ROLE

Const EVC_TEL

Const EVC_TITLE

Const EVC_TYPE

Const EVC_UID

Const EVC_URL

Const EVC_VALUE

Const EVC_VERSION

Const EVC_X_AIM

Const EVC_X_ANNIVERSARY

Const EVC_X_ASSISTANT

Const EVC_X_BIRTHDAY

Const EVC_X_BLOG_URL

Const EVC_X_BOOK_UID

Const EVC_X_CALLBACK

Const EVC_X_COMPANY

Const EVC_X_DEST_CONTACT_UID

Const EVC_X_DEST_EMAIL

Const EVC_X_DEST_EMAIL_NUM

Const EVC_X_DEST_HTML_MAIL

Const EVC_X_DEST_NAME

Const EVC_X_DEST_SOURCE_UID

Const EVC_X_E164

Const EVC_X_FILE_AS

Const EVC_X_GADUGADU

Const EVC_X_GOOGLE_TALK

Const EVC_X_GROUPWISE

Const EVC_X_ICQ

Const EVC_X_JABBER

Const EVC_X_LIST

Const EVC_X_LIST_NAME

Const EVC_X_LIST_SHOW_ADDRESSES

Const EVC_X_MANAGER

Const EVC_X_MATRIX

Const EVC_X_MSN

Const EVC_X_RADIO

Const EVC_X_SIP

Const EVC_X_SKYPE

Const EVC_X_SPOUSE

Const EVC_X_TELEX

Const EVC_X_TTYTDD

Const EVC_X_TWITTER

Const EVC_X_VIDEO_URL

Const EVC_X_WANTS_HTML

Const EVC_X_YAHOO