struct EBookClientView

struct EBookClientView;

Contains only private data the should be read and manipulated using the functions below.

Since 3.2

e_book_client_view_ref_client ()

struct _EBookClient * e_book_client_view_ref_client     (EBookClientView *client_view);

Returns the "client" associated with client_view.

The returned EBookClient is referenced for thread-safety. Unreference the EBookClient with g_object_unref() when finished with it.

Since 3.10

e_book_client_view_get_connection ()

GDBusConnection *   e_book_client_view_get_connection   (EBookClientView *client_view);

Returns the GDBusConnection used to create the D-Bus proxy.

Since 3.8

e_book_client_view_get_object_path ()

const gchar *       e_book_client_view_get_object_path  (EBookClientView *client_view);

Returns the object path used to create the D-Bus proxy.

Since 3.8

e_book_client_view_is_running ()

gboolean            e_book_client_view_is_running       (EBookClientView *client_view);

e_book_client_view_set_fields_of_interest ()

void                e_book_client_view_set_fields_of_interest
                                                        (EBookClientView *client_view,
                                                         const GSList *fields_of_interest,
                                                         GError **error);

Client can instruct server to which fields it is interested in only, thus the server can return less data over the wire. The server can still return complete objects, this is just a hint to it that the listed fields will be used only. The UID field is returned always. Initial views has no fields of interest and using NULL for fields_of_interest will unset any previous changes.

Some backends can use summary information of its cache to create artifical objects, which will omit stored object parsing. If this cannot be done then it will simply return object as is stored in the cache.

e_book_client_view_start ()

void                e_book_client_view_start            (EBookClientView *client_view,
                                                         GError **error);

Tells client_view to start processing events.

e_book_client_view_stop ()

void                e_book_client_view_stop             (EBookClientView *client_view,
                                                         GError **error);

Tells client_view to stop processing events.

e_book_client_view_set_flags ()

void                e_book_client_view_set_flags        (EBookClientView *client_view,
                                                         EBookClientViewFlags flags,
                                                         GError **error);

Sets the flags which control the behaviour of client_view.

Since 3.4

e_book_client_view_get_client ()

struct _EBookClient * e_book_client_view_get_client     (EBookClientView *client_view);

Returns the "client" associated with client_view.

The "client" property

  "client"                   EBookClient*          : Read / Write / Construct Only

The EBookClient for the view.

The "connection" property

  "connection"               GDBusConnection*      : Read / Write / Construct Only

The GDBusConnection used to create the D-Bus proxy.

The "direct-backend" property

  "direct-backend"           EBookBackend*         : Write / Construct Only

The EBookBackend to fetch contact data from, if direct read access is enabled.

The "object-path" property

  "object-path"              gchar*                : Read / Write / Construct Only

The object path used to create the D-Bus proxy.

Default value: NULL

The "complete" signal

void                user_function                      (EBookClientView *ebookclientview,
                                                        GError          *arg1,
                                                        gpointer         user_data)            : Run Last

The "objects-added" signal

void                user_function                      (EBookClientView *ebookclientview,
                                                        gpointer         arg1,
                                                        gpointer         user_data)            : Run Last

The "objects-modified" signal

void                user_function                      (EBookClientView *ebookclientview,
                                                        gpointer         arg1,
                                                        gpointer         user_data)            : Run Last

The "objects-removed" signal

void                user_function                      (EBookClientView *ebookclientview,
                                                        gpointer         arg1,
                                                        gpointer         user_data)            : Run Last

The "progress" signal

void                user_function                      (EBookClientView *ebookclientview,
                                                        guint            arg1,
                                                        gchar           *arg2,
                                                        gpointer         user_data)            : Run Last