Enums

Details

class EBookContacts.BookChangeType(value)

Bases: GLib.Enum

The type of change in an EBookContacts.BookChange

Deprecated since version 3.2.

ADDED = 0

A vCard was added

DELETED = 1

A vCard was deleted

MODIFIED = 2

A vCard was modified

class EBookContacts.BookClientError(value)

Bases: GLib.Enum

Error codes returned by #EBookClient APIs, if an EDataServer.ClientError was not available.

New in version 3.2.

NO_SUCH_BOOK = 0

Requested book did not exist

CONTACT_NOT_FOUND = 1

Contact referred to was not found

CONTACT_ID_ALREADY_EXISTS = 2

Tried to add a contact which already exists

NO_SUCH_SOURCE = 3

Referred EDataServer.Source does not exist

NO_SPACE = 4

Out of disk space

class EBookContacts.BookCursorOrigin(value)

Bases: GObject.GEnum

Specifies the start position to in the list of traversed contacts in calls to e_book_client_cursor_step().

When an #EBookClientCursor is created, the current position implied by EBookContacts.BookCursorOrigin.CURRENT is the same as EBookContacts.BookCursorOrigin.BEGIN.

New in version 3.12.

CURRENT = 0

The current cursor position

BEGIN = 1

The beginning of the cursor results.

END = 2

The ending of the cursor results.

class EBookContacts.BookCursorSortType(value)

Bases: GObject.GEnum

Specifies the sort order of an ordered query

New in version 3.12.

ASCENDING = 0

Sort results in ascending order

DESCENDING = 1

Sort results in descending order

class EBookContacts.BookIndexType(value)

Bases: GObject.GEnum

The type of index defined by e_source_backend_summary_setup_set_indexed_fields()

PREFIX = 0

An index suitable for searching contacts with a prefix pattern

SUFFIX = 1

An index suitable for searching contacts with a suffix pattern

PHONE = 2

An index suitable for searching contacts for phone numbers.

Phone numbers must be convertible into FQTN according to E.164 to be stored in this index. The number “+9999999” for instance won’t be stored because the country calling code “+999” currently is not assigned.

SORT_KEY = 3

Indicates that a given EBookContacts.ContactField should be usable as a sort key.

class EBookContacts.BookQueryTest(value)

Bases: GLib.Enum

The kind of test a query created by EBookContacts.BookQuery.field_test() shall perform.

See also: EBookContacts.PhoneNumber.compare_strings().

IS = 0

look for exact match of the supplied test value

CONTAINS = 1

check if a field contains the test value

BEGINS_WITH = 2

check if a field starts with the test value

ENDS_WITH = 3

check if a field ends with the test value

EQUALS_PHONE_NUMBER = 4

check if a field matches with a value tested using EBookContacts.PhoneNumber.compare_strings(), the match must be of strenth EBookContacts.PhoneNumberMatch.EXACT for this query to return any matches.

EQUALS_NATIONAL_PHONE_NUMBER = 5

check if a field matches with a value tested using EBookContacts.PhoneNumber.compare_strings(), the match must be at least of strength EBookContacts.PhoneNumberMatch.NATIONAL for this query to return any matches.

EQUALS_SHORT_PHONE_NUMBER = 6

check if a field matches with a value tested using EBookContacts.PhoneNumber.compare_strings(), the match must be at least of strength EBookContacts.PhoneNumberMatch.SHORT for this query to return any matches.

REGEX_NORMAL = 7

A regular expression query against contact data normalized with EDataServer.util_utf8_normalize(), the normalized data is lower case with any accents removed.

REGEX_RAW = 8

A regular expression query against raw contact data, this is usually slower than a EBookContacts.BookQueryTest.REGEX_NORMAL as it implies that EBookContacts.VCard(s) must be parsed in order to get the raw data for comparison.

LAST = 9

End marker for the EBookContacts.BookQueryTest enumeration, not a valid query test.

class EBookContacts.BookViewStatus(value)

Bases: GLib.Enum

Status messages used in notifications in the deprecated #EBookView class

Deprecated since version 3.2: Use #EBookClientView instead.

STATUS_OK = 0

Ok

STATUS_TIME_LIMIT_EXCEEDED = 1

Time limit exceeded

STATUS_SIZE_LIMIT_EXCEEDED = 2

Size limit exceeded

ERROR_INVALID_QUERY = 3

Invalid search expression

ERROR_QUERY_REFUSED = 4

Search expression refused

ERROR_OTHER_ERROR = 5

Another error occurred

class EBookContacts.ContactField(value)

Bases: GLib.Enum

FIELD_FIRST = 1
UID = 1
EMAIL_3 = 10
IM_JABBER = 100
IM_YAHOO = 101
IM_MSN = 102
IM_ICQ = 103
WANTS_HTML = 104
IS_LIST = 105
LIST_SHOW_ADDRESSES = 106
BIRTH_DATE = 107
ANNIVERSARY = 108
X509_CERT = 109
EMAIL_4 = 11
LAST_EMAIL_ID = 11
PGP_CERT = 110
IM_GADUGADU_HOME_1 = 111
IM_GADUGADU_HOME_2 = 112
IM_GADUGADU_HOME_3 = 113
IM_GADUGADU_WORK_1 = 114
IM_GADUGADU_WORK_2 = 115
IM_GADUGADU_WORK_3 = 116
IM_GADUGADU = 117
GEO = 118
TEL = 119
MAILER = 12
IM_SKYPE_HOME_1 = 120
IM_SKYPE_HOME_2 = 121
IM_SKYPE_HOME_3 = 122
IM_SKYPE_WORK_1 = 123
IM_SKYPE_WORK_2 = 124
IM_SKYPE_WORK_3 = 125
IM_SKYPE = 126
SIP = 127
IM_GOOGLE_TALK_HOME_1 = 128
IM_GOOGLE_TALK_HOME_2 = 129
ADDRESS_LABEL_HOME = 13
FIRST_LABEL_ID = 13
IM_GOOGLE_TALK_HOME_3 = 130
IM_GOOGLE_TALK_WORK_1 = 131
IM_GOOGLE_TALK_WORK_2 = 132
IM_GOOGLE_TALK_WORK_3 = 133
IM_GOOGLE_TALK = 134
IM_TWITTER = 135
FIELD_LAST = 136
ADDRESS_LABEL_WORK = 14
ADDRESS_LABEL_OTHER = 15
LAST_LABEL_ID = 15
FIRST_PHONE_ID = 16
PHONE_ASSISTANT = 16
PHONE_BUSINESS = 17
PHONE_BUSINESS_2 = 18
PHONE_BUSINESS_FAX = 19
FILE_AS = 2
PHONE_CALLBACK = 20
PHONE_CAR = 21
PHONE_COMPANY = 22
PHONE_HOME = 23
PHONE_HOME_2 = 24
PHONE_HOME_FAX = 25
PHONE_ISDN = 26
PHONE_MOBILE = 27
PHONE_OTHER = 28
PHONE_OTHER_FAX = 29
BOOK_UID = 3
PHONE_PAGER = 30
PHONE_PRIMARY = 31
PHONE_RADIO = 32
PHONE_TELEX = 33
LAST_PHONE_ID = 34
PHONE_TTYTDD = 34
ORG = 35
ORG_UNIT = 36
OFFICE = 37
TITLE = 38
ROLE = 39
FULL_NAME = 4
MANAGER = 40
ASSISTANT = 41
HOMEPAGE_URL = 42
BLOG_URL = 43
CATEGORIES = 44
CALENDAR_URI = 45
FREEBUSY_URL = 46
ICS_CALENDAR = 47
VIDEO_URL = 48
SPOUSE = 49
GIVEN_NAME = 5
NOTE = 50
IM_AIM_HOME_1 = 51
IM_AIM_HOME_2 = 52
IM_AIM_HOME_3 = 53
IM_AIM_WORK_1 = 54
IM_AIM_WORK_2 = 55
IM_AIM_WORK_3 = 56
IM_GROUPWISE_HOME_1 = 57
IM_GROUPWISE_HOME_2 = 58
IM_GROUPWISE_HOME_3 = 59
FAMILY_NAME = 6
IM_GROUPWISE_WORK_1 = 60
IM_GROUPWISE_WORK_2 = 61
IM_GROUPWISE_WORK_3 = 62
IM_JABBER_HOME_1 = 63
IM_JABBER_HOME_2 = 64
IM_JABBER_HOME_3 = 65
IM_JABBER_WORK_1 = 66
IM_JABBER_WORK_2 = 67
IM_JABBER_WORK_3 = 68
IM_YAHOO_HOME_1 = 69
NICKNAME = 7
IM_YAHOO_HOME_2 = 70
IM_YAHOO_HOME_3 = 71
IM_YAHOO_WORK_1 = 72
IM_YAHOO_WORK_2 = 73
IM_YAHOO_WORK_3 = 74
IM_MSN_HOME_1 = 75
IM_MSN_HOME_2 = 76
IM_MSN_HOME_3 = 77
IM_MSN_WORK_1 = 78
IM_MSN_WORK_2 = 79
EMAIL_1 = 8
FIRST_EMAIL_ID = 8
IM_MSN_WORK_3 = 80
IM_ICQ_HOME_1 = 81
IM_ICQ_HOME_2 = 82
IM_ICQ_HOME_3 = 83
IM_ICQ_WORK_1 = 84
IM_ICQ_WORK_2 = 85
IM_ICQ_WORK_3 = 86
REV = 87
LAST_SIMPLE_STRING = 88
NAME_OR_ORG = 88
ADDRESS = 89
EMAIL_2 = 9
ADDRESS_HOME = 90
FIRST_ADDRESS_ID = 90
ADDRESS_WORK = 91
ADDRESS_OTHER = 92
LAST_ADDRESS_ID = 92
CATEGORY_LIST = 93
PHOTO = 94
NAME = 96
EMAIL = 97
IM_AIM = 98
IM_GROUPWISE = 99
class EBookContacts.ContactPhotoType(value)

Bases: GLib.Enum

INLINED = 0
URI = 1
class EBookContacts.PhoneNumberCountrySource(value)

Bases: GLib.Enum

The origin of a parsed EBookContacts.PhoneNumber’s country calling code.

New in version 3.8.

FQTN = 1

the EBookContacts.PhoneNumber was build from a fully qualified telephone number that contained a valid country calling code

DEFAULT = 20

the parsed phone didn’t start with a (recognizable) country calling code, the code was chosen by checking the current locale settings

IDD = 5

the parsed phone number started with the current locale’s international call prefix, followed by a valid country calling code

class EBookContacts.PhoneNumberError(value)

Bases: GLib.Enum

Numeric description of a phone number related error.

New in version 3.8.

NOT_IMPLEMENTED = 0

the library was built without phone number support

UNKNOWN = 1

the phone number parser reported a yet unknown error code.

NOT_A_NUMBER = 2

the supplied text is not a phone number.

INVALID_COUNTRY_CODE = 3

the supplied phone number has an invalid country calling code.

TOO_SHORT_AFTER_IDD = 4

the remaining text after the country calling code is to short for a phone number.

TOO_SHORT = 5

the text is too short for a phone number.

TOO_LONG = 6

the text is too long for a phone number.

class EBookContacts.PhoneNumberFormat(value)

Bases: GLib.Enum

The supported formatting rules for phone numbers.

New in version 3.8.

E164 = 0

format according E.164: “+493055667788”.

INTERNATIONAL = 1

a formatted phone number always starting with the country calling code: “+49 30 55667788”.

NATIONAL = 2

a formatted phone number in national scope, that is without country calling code: “(030) 55667788”.

RFC3966 = 3

a tel: URL according to RFC 3966: “tel:+49-30-55667788”.

class EBookContacts.PhoneNumberMatch(value)

Bases: GLib.Enum

The strength of a phone number match.

Some examples of phone number matches

Let’s consider the phone number “+1-221-5423789”, then comparing with “+1.221.542.3789” we have get EBookContacts.PhoneNumberMatch.EXACT because country code, region code and local number are matching. Comparing with “2215423789” will result in EBookContacts.PhoneNumberMatch.NATIONAL because the country calling code is missing, but the national portion is matching. Finally comparing with “5423789” gives EBookContacts.PhoneNumberMatch.SHORT. For more detail have a look at the following table:

+1-617-5423789 +1-221-5423789 221-5423789 5423789

+1-617-5423789 exact none none short

+1-221-5423789 none exact national short

221-5423789 none national national short

5423789 short short short short

New in version 3.8.

NONE = 0

The phone numbers did not match.

EXACT = 1

The phone numbers matched exactly. Two phone number strings are an exact match if the country code, national phone number, presence of a leading zero for Italian numbers and any extension present are the same.

NATIONAL = 1024

The national phone number matched. Two phone number strings match at this strength if either or both has no region specified, and the national phone number and extensions are the same.

SHORT = 2048

The weakest sort of match. Two phone numbers match at this strength if either or both has no region specified, or the region specified is the same, and one national phone number could be a shorter version of the other number. This includes the case where one has an extension specified, and the other does not.

class EBookContacts.VCardFormat(value)

Bases: GLib.Enum

21 = 0
_21 = 0
30 = 1
_30 = 1