EDataBook.DataBookView
Description: Reference for EDataBook.DataBookView

### Class

# EDataBookDataBookView

#### Description

    class EDataBook.DataBookView : GObject.Object
      implements Gio.Initable {
      EDataBookViewPrivate* priv
    }

No description available.

#### Hierarchy

#### Ancestors

- GObject

#### Implements

- GInitable

#### Constructors

###### e_data_book_view_new

Creates a new `EDataBookView` and exports its D-Bus interface on `connection` at `object_path`. If an error occurs while exporting, the function sets `error` and returns `NULL`.

#### Instance methods

###### e_data_book_view_claim_contact_uid

Tells the `self`, that it contains a contact with UID `uid`. This is useful for “manual query” view, which do not do initial notifications. It helps to not send “objects-added” signal for contacts, which are already part of the `self`, because for them the “objects-modified” should be emitted instead.

since: 3.50

###### e_data_book_view_dup_contacts

Reads `range_length` contacts from index `range_start`. When there are asked more than `e_data_book_view_get_n_total()` contacts only those up to the total number of contacts are read.

since: 3.50

###### e_data_book_view_dup_indices

Returns a list of `EBookIndices` holding indices of the contacts in the view. These are received from the first sort field set by e_data_book_view_set_sort_fields(). The last item of the returned array is the one with chr member being `NULL`.

since: 3.50

###### e_data_book_view_get_connection

Returns the `GDBusConnection` on which the AddressBookView D-Bus interface is exported.

since: 3.8

###### e_data_book_view_get_fields_of_interest

No description available.

###### e_data_book_view_get_flags

Gets the `EBookClientViewFlags` that control the behaviour of `view`.

since: 3.4

###### e_data_book_view_get_force_initial_notifications

Returns whether the `view` should do initial notifications even when the flags do not contain `E_BOOK_CLIENT_VIEW_FLAGS_NOTIFY_INITIAL`. The default is `FALSE`.

since: 3.50

###### e_data_book_view_get_id

Returns an identifier of the `self`. It does not change for the whole life time of the `self`.

since: 3.50

###### e_data_book_view_get_n_total

Returns how many contacts are available in the view.

since: 3.50

###### e_data_book_view_get_object_path

Returns the object path at which the AddressBookView D-Bus interface is exported.

since: 3.8

###### e_data_book_view_get_sexp

Gets the s-expression used for matching contacts to `view`.

since: 3.8

###### e_data_book_view_is_completed

No description available.

since: 3.34

###### e_data_book_view_notify_complete

Notifies listeners that all pending updates on `view` have been sent. The listener’s information should now be in sync with the backend’s.

###### e_data_book_view_notify_content_changed

Notifies the client side that the content of the `self` changed, which it should use to refresh the view data.

since: 3.50

###### e_data_book_view_notify_progress

Provides listeners with a human-readable text describing the current backend operation. This can be used for progress reporting.

since: 3.2

###### e_data_book_view_notify_remove

Notify listeners that a contact specified by `id` was removed from `view`.

###### e_data_book_view_notify_update

Notify listeners that `contact` has changed. This can trigger an add, change or removal event depending on whether the change causes the contact to start matching, no longer match, or stay matching the query specified by `view`.

###### e_data_book_view_notify_update_prefiltered_vcard

Notify listeners that `vcard` has changed. This can trigger an add, change or removal event depending on whether the change causes the contact to start matching, no longer match, or stay matching the query specified by `view`. This method should be preferred over `e_data_book_view_notify_update()` when the native representation of a contact is a vCard.

###### e_data_book_view_notify_update_vcard

Notify listeners that `vcard` has changed. This can trigger an add, change or removal event depending on whether the change causes the contact to start matching, no longer match, or stay matching the query specified by `view`. This method should be preferred over `e_data_book_view_notify_update()` when the native representation of a contact is a vCard.

###### e_data_book_view_ref_backend

Refs the backend that `view` is querying. Unref the returned backend, if not `NULL`, with g_object_unref(), when no longer needed.

since: 3.34

###### e_data_book_view_set_force_initial_notifications

Sets whether the `view` should do initial notifications even when the flags do not contain `E_BOOK_CLIENT_VIEW_FLAGS_NOTIFY_INITIAL`.

since: 3.50

###### e_data_book_view_set_indices

Sets indices used by the `self`. The array is terminated by an item with chr member being `NULL`. See `e_data_book_view_dup_indices()` for more information.

since: 3.50

###### e_data_book_view_set_n_total

Sets how many contacts are available in the view.

since: 3.50

###### e_data_book_view_set_sort_fields

Sets `fields` to sort the view by. The default is to sort by the file-as field. The contacts are always sorted in ascending order. Not every field can be used for sorting, the default available fields are `E_CONTACT_FILE_AS`, `E_CONTACT_GIVEN_NAME` and `E_CONTACT_FAMILY_NAME`.

since: 3.50

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GInitable (1)

###### g_initable_init

Initializes the object implementing the interface.

#### Properties

###### EDataBook.DataBookView:backend

The backend being monitored.

###### EDataBook.DataBookView:connection

The `GDBusConnection` on which to export the view interface.

###### EDataBook.DataBookView:indices

List of `EBookIndices` holding indices of the contacts in the view.

###### EDataBook.DataBookView:n-total

How many contacts are available in the view.

###### EDataBook.DataBookView:object-path

The object path at which to export the view interface.

###### EDataBook.DataBookView:sexp

The query expression for this view.

#### Signals

###### EDataBook.DataBookView::objects-added

Emitted when new objects are added into the `view`.

since: 3.50

###### EDataBook.DataBookView::objects-modified

Emitted when the objects in the `view` are modified.

since: 3.50

###### EDataBook.DataBookView::objects-removed

Emitted when the objects are removed from the `view`.

since: 3.50

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct EDataBookDataBookViewClass {
      GObjectClass parent;

    }

No description available.

###### Class members

`parent: GObjectClass`

  No description available.