EDataBook.DataBook¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w/co |
The backend driving this connection |
||
r/w/co |
The |
||
r/w/co |
The object path at which to export the address book interface |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class EDataBook.DataBook(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod new(backend, connection, object_path)¶
- Parameters:
backend (
EDataBook.BookBackend
) – anEDataBook.BookBackend
connection (
Gio.DBusConnection
) – aGio.DBusConnection
object_path (
str
) – object path for the D-Bus interface
- Raises:
- Returns:
an
EDataBook.DataBook
, orNone
on error- Return type:
Creates a new
EDataBook.DataBook
and exports the AddressBook D-Bus interface on connection at object_path. TheEDataBook.DataBook
handles incoming remote method invocations and forwards them to the backend. If the AddressBook interface fails to export, the function sets error and returnsNone
.
- classmethod string_slist_to_comma_string(strings)¶
- Parameters:
- Returns:
comma-separated newly allocated text of strings
- Return type:
Takes a list of strings and converts it to a comma-separated string of values; free returned pointer with
GLib.free
()New in version 3.2.
- get_connection()¶
- Returns:
- Return type:
Returns the
Gio.DBusConnection
on which the AddressBook D-Bus interface is exported.New in version 3.8.
- get_object_path()¶
- Returns:
the object path
- Return type:
Returns the object path at which the AddressBook D-Bus interface is exported.
New in version 3.8.
- ref_backend()¶
- Returns:
- Return type:
Returns the
EDataBook.BookBackend
to which incoming remote method invocations are being forwarded.The returned
EDataBook.BookBackend
is referenced for thread-safety and should be unreferenced withGObject.Object.unref
() when finished with it.New in version 3.10.
- report_backend_property_changed(prop_name, prop_value)¶
- Parameters:
Notifies the clients about a property change.
New in version 3.2.
- report_error(message)¶
- Parameters:
message (
str
) – An error message
Notifies the clients about an error, which happened out of any client-initiate operation.
New in version 3.2.
- respond_contains_email(opid, error, found)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed itfound (
bool
) –True
, when found the email in the address book
Finishes a call to check whether contains an email address.
New in version 3.44.
- respond_create_contacts(opid, error, contacts)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed itcontacts ([
EBookContacts.Contact
]) – A list of createdEBookContacts.Contact
(s), empty on error
Finishes a call to create a list contacts.
New in version 3.4.
- respond_get_contact(opid, error, contact)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
orNone
) – Operation error, if any, automatically freed if passed itcontact (
EBookContacts.Contact
orNone
) – the foundEBookContacts.Contact
, orNone
, if it could not be found
Notifies listeners of the completion of the get_contact method call. Only one of error and contact can be set.
- respond_get_contact_list(opid, error, contacts)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed itcontacts ([
EBookContacts.Contact
]) – A list ofEBookContacts.Contact
, empty on error
Finishes a call to get list of
EBookContacts.Contact
, which satisfy certain criteria.New in version 3.2.
- respond_get_contact_list_uids(opid, error, uids)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed ituids ([
str
]) – A list of picked UIDs, empty on error
Finishes a call to get list of UIDs which satisfy certain criteria.
New in version 3.2.
- respond_modify_contacts(opid, error, contacts)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed itcontacts ([
EBookContacts.Contact
]) – A list of modifiedEBookContacts.Contact
(s), empty on error
Finishes a call to modify a list of contacts.
New in version 3.4.
- respond_open(opid, error)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed it
Notifies listeners of the completion of the open method call.
- respond_refresh(opid, error)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed it
Notifies listeners of the completion of the refresh method call.
New in version 3.2.
- respond_remove_contacts(opid, error, ids)¶
- Parameters:
opid (
int
) – An operation IDerror (
GLib.Error
) – Operation error, if any, automatically freed if passed itids ([
str
]) – A list of removed contact UID-s, empty on error
Finishes a call to remove a list of contacts.
New in version 3.4.
- set_locale(locale, cancellable)¶
- Parameters:
locale (
str
) – the new locale to set for this bookcancellable (
Gio.Cancellable
orNone
) – aGio.Cancellable
- Raises:
- Returns:
True
on success, otherwiseFalse
is returned and error is set appropriately.- Return type:
Set’s the locale for this addressbook, this can result in renormalization of locale sensitive data.
New in version 3.12.
Property Details¶
- EDataBook.DataBook.props.backend¶
- Name:
backend
- Type:
- Default Value:
- Flags:
The backend driving this connection
- EDataBook.DataBook.props.connection¶
- Name:
connection
- Type:
- Default Value:
- Flags:
The
Gio.DBusConnection
on which to export the address book interface