EDataBook.BookBackendClass

Fields

Name

Type

Access

Description

closed

object

r

A signal notifying that the backend was closed

impl_configure_direct

object

r

For addressbook backends which support Direct Read Access, configure a backend instantiated on the client side for Direct Read Access, using data reported from the server via the get_direct_book method.

impl_contains_email

object

r

Checkes whether the backend contains an email address

impl_create_contacts

object

r

Add and store the passed vcards

impl_create_cursor

object

r

Create an EDataBook.DataBookCursor

impl_delete_cursor

object

r

Delete an EDataBook.DataBookCursor previously created by this backend

impl_dup_locale

object

r

Return the currently set locale setting (must be a string duplicate, for thread safety).

impl_dup_view_contacts

object

r

returns contacts in the given range of the sorted “manual query” view; default implementation tracks view’s connect and returns the contacts accordingly.

impl_dup_view_indices

object

r

retrieve indexes into an alphabet for contacts in the “manual query” view; default implementation returns value set by EDataBook.BookBackend.set_view_indices().

impl_get_backend_property

object

r

Fetch a property value by name from the backend

impl_get_contact

object

r

Fetch a contact by UID

impl_get_contact_list

object

r

Fetch a list of contacts based on a search expression

impl_get_contact_list_uids

object

r

Fetch a list of contact UIDs based on a search expression

impl_get_direct_book

object

r

For addressbook backends which support Direct Read Access, report some information on how to access the addressbook persistance directly

impl_get_view_n_total

object

r

retrieve how many contacts a “manual query” view has; default implementation returns value set by EDataBook.BookBackend.set_view_n_total().

impl_modify_contacts

object

r

Modify the existing contacts using the passed vcards

impl_notify_update

object

r

Notify changes which might have occured for a given contact

impl_open

object

r

Open the backend

impl_refresh

object

r

Refresh the backend

impl_remove_contacts

object

r

Remove the contacts specified by the passed UIDs

impl_set_locale

object

r

Store & remember the passed locale setting

impl_set_view_sort_fields

object

r

sets sort fields for “manual query” views; default implementation saves the values into internal structures, which can be read back with EDataBook.BookBackend.dup_view_sort_fields().

impl_start_view

object

r

Start up the specified view

impl_stop_view

object

r

Stop the specified view

parent_class

EBackend.BackendClass

r

reserved_padding

[object]

r

shutdown

object

r

A signal notifying that the backend is being shut down

use_serial_dispatch_queue

bool

r

Whether a serial dispatch queue should be used for this backend or not. The default is True.

Methods

None

Details

class EDataBook.BookBackendClass

Class structure for the EDataBook.BookBackend class.

These virtual methods must be implemented when writing an addressbook backend.