EDataCal.DataCal¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (backend, connection, object_path)
	`get_connection` ()
	`get_object_path` ()
	`ref_backend` ()
	`report_backend_property_changed` (prop_name, prop_value)
	`report_error` (message)
	`report_free_busy_data` (freebusy)
	`respond_add_timezone` (opid, error)
	`respond_create_objects` (opid, error, uids, new_components)
	`respond_discard_alarm` (opid, error)
	`respond_get_attachment_uris` (opid, error, attachment_uris)
	`respond_get_free_busy` (opid, error, freebusy)
	`respond_get_object` (opid, error, object)
	`respond_get_object_list` (opid, error, objects)
	`respond_get_timezone` (opid, error, tzobject)
	`respond_modify_objects` (opid, error, old_components, new_components)
	`respond_open` (opid, error)
	`respond_receive_objects` (opid, error)
	`respond_refresh` (opid, error)
	`respond_remove_objects` (opid, error, ids, old_components, new_components)
	`respond_send_objects` (opid, error, users, calobj)

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.Initable (1)

Properties¶

Name	Type	Flags	Short Description
`backend`	`EDataCal.CalBackend`	r/w/co	The backend driving this connection
`connection`	`Gio.DBusConnection`	r/w/co	The `Gio.DBusConnection` on which to export the calendar interface
`object-path`	`str`	r/w/co	The object path at which to export the calendar interface

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class EDataCal.DataCal(**kwargs)¶

Bases:: GObject.Object, Gio.Initable
Abstract:: No
Structure:: EDataCal.DataCalClass

classmethod new(backend, connection, object_path)¶

Parameters:

backend (EDataCal.CalBackend) – an EDataCal.CalBackend
connection (Gio.DBusConnection) – a Gio.DBusConnection
object_path (str) – object path for the D-Bus interface

Raises:

GLib.Error

Returns:

an EDataCal.DataCal, or None on error

Return type:

EDataCal.DataCal or None

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

get_connection()¶

Returns:: the Gio.DBusConnection
Return type:: Gio.DBusConnection

Returns the Gio.DBusConnection on which the Calendar D-Bus interface is exported.

New in version 3.8.

get_object_path()¶

Returns:: the object path
Return type:: str

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

New in version 3.8.

ref_backend()¶

Returns:: an EDataCal.CalBackend
Return type:: EDataCal.CalBackend or None

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

The returned EDataCal.CalBackend is referenced for thread-safety and should be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.10.

report_backend_property_changed(prop_name, prop_value)¶

Parameters:

prop_name (str) – property name
prop_value (str) – new property value

Notifies client about certain property value change

New in version 3.2.

report_error(message)¶

Parameters:: message (str) – an error message to report

Emits an error message, thus the clients can be notified about it.

New in version 3.2.

report_free_busy_data(freebusy)¶

Parameters:: freebusy ([str]) – a GLib.SList of free/busy components encoded as string

Reports result of a free/busy query on the self.

New in version 3.2.

respond_add_timezone(opid, error)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.

Notifies listeners of the completion of the add_timezone method call.

New in version 3.2.

respond_create_objects(opid, error, uids, new_components)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
uids ([str]) – UIDs of the objects created.
new_components ([ECal.Component]) – The newly created ECal.Component objects.

Notifies listeners of the completion of the create_objects method call.

New in version 3.6.

respond_discard_alarm(opid, error)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.

Notifies listeners of the completion of the discard_alarm method call.

New in version 3.2.

respond_get_attachment_uris(opid, error, attachment_uris)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
attachment_uris ([str]) – List of retrieved attachment uri’s.

Notifies listeners of the completion of the get_attachment_uris method call.

New in version 3.2.

respond_get_free_busy(opid, error, freebusy)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
freebusy ([str]) – a GLib.SList of iCalendar strings with all gathered free/busy components.

Notifies listeners of the completion of the get_free_busy method call. To pass actual free/busy objects to the client asynchronously use EDataCal.DataCal.report_free_busy_data(), but the freebusy should contain all the objects being used in EDataCal.DataCal.report_free_busy_data().

New in version 3.2.

respond_get_object(opid, error, object)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
object (str) – The object retrieved as an iCalendar string.

Notifies listeners of the completion of the get_object method call.

New in version 3.2.

respond_get_object_list(opid, error, objects)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
objects ([str]) – List of retrieved objects.

Notifies listeners of the completion of the get_object_list method call.

New in version 3.2.

respond_get_timezone(opid, error, tzobject)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
tzobject (str) – The requested timezone as an iCalendar string.

Notifies listeners of the completion of the get_timezone method call.

New in version 3.2.

respond_modify_objects(opid, error, old_components, new_components)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
old_components ([ECal.Component]) – The old ECal.Component(s).
new_components ([ECal.Component]) – The new ECal.Component(s).

Notifies listeners of the completion of the modify_objects method call.

New in version 3.6.

respond_open(opid, error)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.

Notifies listeners of the completion of the open method call.

New in version 3.2.

respond_receive_objects(opid, error)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.

Notifies listeners of the completion of the receive_objects method call.

New in version 3.2.

respond_refresh(opid, error)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – 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_objects(opid, error, ids, old_components, new_components)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
ids ([ECal.ComponentId]) – IDs of the removed objects.
old_components ([ECal.Component]) – The old ECal.Component(s).
new_components ([ECal.Component]) – The new ECal.Component(s). They will not be None only when removing instances of recurring appointments.

Notifies listeners of the completion of the remove_objects method call.

New in version 3.6.

respond_send_objects(opid, error, users, calobj)¶

Parameters:

opid (int) – associated operation id
error (GLib.Error or None) – Operation error, if any, automatically freed if passed it.
users ([str]) – List of users.
calobj (str) – An iCalendar string representing the object sent.

Notifies listeners of the completion of the send_objects method call.

New in version 3.2.

Property Details¶

EDataCal.DataCal.props.backend¶

Name:: backend
Type:: EDataCal.CalBackend
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The backend driving this connection

EDataCal.DataCal.props.connection¶

Name:: connection
Type:: Gio.DBusConnection
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gio.DBusConnection on which to export the calendar interface

EDataCal.DataCal.props.object_path¶

Name:: object-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The object path at which to export the calendar interface