Enums

Details

class EDataBook.BookCacheCursorOrigin(value)

Bases: GLib.Enum

Specifies the start position to in the list of traversed contacts in calls to EDataBook.BookCache.cursor_step().

When an EDataBook.BookCacheCursor is created, the current position implied by EDataBook.BookCacheCursorOrigin.CURRENT is the same as EDataBook.BookCacheCursorOrigin.BEGIN.

New in version 3.26.

CURRENT = 0

The current cursor position.

BEGIN = 1

The beginning of the cursor results.

END = 2

The end of the cursor results.

class EDataBook.BookSqliteError(value)

Bases: GLib.Enum

Defines the types of possible errors reported by the EDataBook.BookSqlite

ENGINE = 0

An error was reported from the SQLite engine

CONSTRAINT = 1

The error occurred due to an explicit constraint, this will happen when attempting to add two contacts with the same UID.

CONTACT_NOT_FOUND = 2

A contact was not found by UID (this is different from a query that returns no results, which is not an error).

INVALID_QUERY = 3

A query was invalid. This can happen if the search expression could not be parsed or if a phone number query contained non-phonenumber input.

UNSUPPORTED_QUERY = 4

A query was not supported

UNSUPPORTED_FIELD = 5

An unsupported EBookContacts.ContactField was specified in the summary

END_OF_LIST = 6

An attempt was made to fetch results past the end of a contact list

LOAD = 7

An error occured while loading or creating the database

class EDataBook.bSqlChangeType(value)

Bases: GLib.Enum

Indicates the type of change which occurred in a EDataBook.bSqlChangeCallback

New in version 3.12.

CONTACT_ADDED = 0

Contact was modified as a result of it’s addition to the addressbook

LOCALE_CHANGED = 1

Contact was modified as a result of a locale change

LAST = 2

A symbolic end marker for this enumeration, will not be passed in callbacks.

class EDataBook.bSqlCursorOrigin(value)

Bases: GLib.Enum

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

When an EDataBook.bSqlCursor is created, the current position implied by EDataBook.bSqlCursorOrigin.CURRENT is the same as EDataBook.bSqlCursorOrigin.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 EDataBook.bSqlLockType(value)

Bases: GLib.Enum

Indicates the type of lock requested in EDataBook.BookSqlite.lock()

READ = 0

Obtain a lock for reading

WRITE = 1

Obtain a lock for writing

class EDataBook.bSqlUnlockAction(value)

Bases: GLib.Enum

Indicates what type of action to take while unlocking the sqlite with EDataBook.BookSqlite.unlock()

In the case that some addressbook modification failed while holding an EDataBook.bSqlLockType.WRITE lock, then the EDataBook.BookSqlite must be unlocked with EDataBook.bSqlUnlockAction.ROLLBACK.

NONE = 0

Just unlock, this is appropriate for locks which were obtained with EDataBook.bSqlLockType.READ

COMMIT = 1

Commit any modifications which were made while the lock was held

ROLLBACK = 2

Rollback any modifications which were made while the lock was held