EDataBook

EDataBook — Server side D-Bus layer to communicate with addressbooks

Functions

Object Hierarchy

    GObject
    ╰── EDataBook

Includes

#include <libedata-book/libedata-book.h>

Description

This class communicates with EBookClients over the bus and accesses an EBookBackend to satisfy client requests.

Functions

e_data_book_new ()

EDataBook *
e_data_book_new (struct _EBookBackend *backend,
                 GDBusConnection *connection,
                 const gchar *object_path,
                 GError **error);

Creates a new EDataBook and exports the AddressBook D-Bus interface on connection at object_path . The EDataBook handles incoming remote method invocations and forwards them to the backend . If the AddressBook interface fails to export, the function sets error and returns NULL.

Parameters

backend

an EBookBackend.

[type EBookBackend]

connection

a GDBusConnection

 

object_path

object path for the D-Bus interface

 

error

return location for a GError, or NULL

 

Returns

an EDataBook, or NULL on error


e_data_book_ref_backend ()

struct _EBookBackend *
e_data_book_ref_backend (EDataBook *book);

Returns the EBookBackend to which incoming remote method invocations are being forwarded.

The returned EBookBackend is referenced for thread-safety and should be unreferenced with g_object_unref() when finished with it.

Parameters

book

an EDataBook

 

Returns

an EBookBackend.

[transfer full][type EBookBackend]

Since: 3.10


e_data_book_get_connection ()

GDBusConnection *
e_data_book_get_connection (EDataBook *book);

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

Parameters

book

an EDataBook

 

Returns

the GDBusConnection.

[transfer none]

Since: 3.8


e_data_book_get_object_path ()

const gchar *
e_data_book_get_object_path (EDataBook *book);

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

Parameters

book

an EDataBook

 

Returns

the object path

Since: 3.8


e_data_book_set_locale ()

gboolean
e_data_book_set_locale (EDataBook *book,
                        const gchar *locale,
                        GCancellable *cancellable,
                        GError **error);

Set's the locale for this addressbook, this can result in renormalization of locale sensitive data.

Parameters

book

an EDataBook

 

locale

the new locale to set for this book

 

cancellable

a GCancellable

 

error

a location to store any error which might occur

 

Returns

TRUE on success, otherwise FALSE is returned and error is set appropriately.

Since: 3.12


e_data_book_respond_open ()

void
e_data_book_respond_open (EDataBook *book,
                          guint32 opid,
                          GError *error);

Notifies listeners of the completion of the open method call.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

e_data_book_respond_refresh ()

void
e_data_book_respond_refresh (EDataBook *book,
                             guint32 opid,
                             GError *error);

Notifies listeners of the completion of the refresh method call.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

Since: 3.2


e_data_book_respond_create_contacts ()

void
e_data_book_respond_create_contacts (EDataBook *book,
                                     guint32 opid,
                                     GError *error,
                                     const GSList *contacts);

Finishes a call to create a list contacts.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

contacts

A list of created EContact(s), empty on error.

[element-type EContact]

Since: 3.4


e_data_book_respond_modify_contacts ()

void
e_data_book_respond_modify_contacts (EDataBook *book,
                                     guint32 opid,
                                     GError *error,
                                     const GSList *contacts);

Finishes a call to modify a list of contacts.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

contacts

A list of modified EContact(s), empty on error.

[element-type EContact]

Since: 3.4


e_data_book_respond_remove_contacts ()

void
e_data_book_respond_remove_contacts (EDataBook *book,
                                     guint32 opid,
                                     GError *error,
                                     const GSList *ids);

Finishes a call to remove a list of contacts.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

ids

A list of removed contact UID-s, empty on error.

[element-type utf8]

Since: 3.4


e_data_book_respond_get_contact ()

void
e_data_book_respond_get_contact (EDataBook *book,
                                 guint32 opid,
                                 GError *error,
                                 const EContact *contact);

Notifies listeners of the completion of the get_contact method call. Only one of error and contact can be set.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it.

[nullable][transfer full]

contact

the found EContact, or NULL, if it could not be found.

[nullable]

e_data_book_respond_get_contact_list ()

void
e_data_book_respond_get_contact_list (EDataBook *book,
                                      guint32 opid,
                                      GError *error,
                                      const GSList *contacts);

Finishes a call to get list of EContact, which satisfy certain criteria.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

contacts

A list of EContact, empty on error.

[element-type EContact]

Since: 3.2


e_data_book_respond_get_contact_list_uids ()

void
e_data_book_respond_get_contact_list_uids
                               (EDataBook *book,
                                guint32 opid,
                                GError *error,
                                const GSList *uids);

Finishes a call to get list of UIDs which satisfy certain criteria.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

uids

A list of picked UIDs, empty on error.

[element-type utf8]

Since: 3.2


e_data_book_respond_contains_email ()

void
e_data_book_respond_contains_email (EDataBook *book,
                                    guint32 opid,
                                    GError *error,
                                    gboolean found);

Finishes a call to check whether contains an email address.

Parameters

book

An EDataBook

 

opid

An operation ID

 

error

Operation error, if any, automatically freed if passed it

 

found

TRUE, when found the email in the address book

 

Since: 3.44


e_data_book_report_error ()

void
e_data_book_report_error (EDataBook *book,
                          const gchar *message);

Notifies the clients about an error, which happened out of any client-initiate operation.

Parameters

book

An EDataBook

 

message

An error message

 

Since: 3.2


e_data_book_report_backend_property_changed ()

void
e_data_book_report_backend_property_changed
                               (EDataBook *book,
                                const gchar *prop_name,
                                const gchar *prop_value);

Notifies the clients about a property change.

Parameters

book

An EDataBook

 

prop_name

Property name which changed

 

prop_value

The new property value.

[nullable]

Since: 3.2


e_data_book_string_slist_to_comma_string ()

gchar *
e_data_book_string_slist_to_comma_string
                               (const GSList *strings);

Takes a list of strings and converts it to a comma-separated string of values; free returned pointer with g_free()

Parameters

strings

a list of gchar *.

[element-type utf8]

Returns

comma-separated newly allocated text of strings

Since: 3.2