Top | ![]() |
![]() |
![]() |
![]() |
|
e_data_book_view_new () |
struct _EBookBackend * | e_data_book_view_get_backend () |
|
e_data_book_view_get_connection () |
const |
e_data_book_view_get_object_path () |
EBookBackendSExp * | e_data_book_view_get_sexp () |
EBookClientViewFlags | e_data_book_view_get_flags () |
|
e_data_book_view_notify_update () |
|
e_data_book_view_notify_update_vcard () |
|
e_data_book_view_notify_update_prefiltered_vcard () |
|
e_data_book_view_notify_remove () |
|
e_data_book_view_notify_complete () |
|
e_data_book_view_notify_progress () |
|
e_data_book_view_get_fields_of_interest () |
This class communicates with
Addressbook backends can automatically own a number of views requested by the client, this API can be used by the backend to issue notifications which will be delivered to the EBookClientView
EDataBookView * e_data_book_view_new (struct _EBookBackend *backend
,EBookBackendSExp *sexp
,,
GDBusConnection *connectionconst
,gchar *object_path);
GError **error
Creates a new connection
at object_path
. If an error occurs while exporting,
the function sets error
and returns NULL
backend |
an EBookBackend |
|
sexp |
||
connection |
a |
|
object_path |
an object path for the view |
|
error |
return location for a |
struct _EBookBackend *
e_data_book_view_get_backend (EDataBookView *view
);
Gets the backend that view
is querying.
GDBusConnection * e_data_book_view_get_connection ();
EDataBookView *view
Returns the
Since: 3.8
constgchar * e_data_book_view_get_object_path ();
EDataBookView *view
Returns the object path at which the AddressBookView D-Bus interface is exported.
Since: 3.8
EBookBackendSExp *
e_data_book_view_get_sexp (EDataBookView *view
);
Gets the s-expression used for matching contacts to view
.
Since: 3.8
EBookClientViewFlags
e_data_book_view_get_flags (EDataBookView *view
);
Gets the EBookClientViewFlags that control the behaviour of view
.
Since: 3.4
void e_data_book_view_notify_update (,
EDataBookView *viewconst
);EContact *contact
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
.
void e_data_book_view_notify_update_vcard (,
EDataBookView *viewconst
,gchar *idconst
);gchar *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.
void e_data_book_view_notify_update_prefiltered_vcard (,
EDataBookView *viewconst
,gchar *idconst
);gchar *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.
The important difference between this method and
e_data_book_view_notify_update()
and
e_data_book_view_notify_update_vcard()
is
that it doesn't match the contact against the book view query to see if it
should be included, it assumes that this has been done and the contact is
known to exist in the view.
void e_data_book_view_notify_remove (,
EDataBookView *viewconst
);gchar *id
Notify listeners that a contact specified by id
was removed from view
.
void e_data_book_view_notify_complete (,
EDataBookView *viewconst
);GError *error
Notifies listeners that all pending updates on view
have been sent. The listener's information should now be
in sync with the backend's.
void e_data_book_view_notify_progress (,
EDataBookView *view,
guint percentconst
);gchar *message
Provides listeners with a human-readable text describing the current backend operation. This can be used for progress reporting.
view |
an |
|
percent |
percent done; use -1 when not available |
|
message |
a text message |
Since: 3.2
GHashTable * e_data_book_view_get_fields_of_interest ();
EDataBookView *view
Hash table of field names which the listener is interested in.
Backends can return fully populated objects, but the listener advertised
that it will use only these. Returns NULL
Note: The data pointer in the hash table has no special meaning, it's only GINT_TO_POINTER(1) for easier checking. Also, field names are compared case insensitively.