EDataCal.CalBackendSync¶

Subclasses:: EDataCal.CalMetaBackend

Methods¶

Inherited:: EDataCal.CalBackend (73), EBackend.Backend (21), GObject.Object (37), ECal.TimezoneCache (3)
Structs:: GObject.ObjectClass (5)

	`add_timezone` (cal, cancellable, tzobject)
	`create_objects` (cal, cancellable, calobjs, opflags)
	`discard_alarm` (cal, cancellable, uid, rid, auid, opflags)
	`get_attachment_uris` (cal, cancellable, uid, rid, attachments)
	`get_free_busy` (cal, cancellable, users, start, end)
	`get_object` (cal, cancellable, uid, rid)
	`get_object_list` (cal, cancellable, sexp)
	`get_timezone` (cal, cancellable, tzid, tzobject)
	`modify_objects` (cal, cancellable, calobjs, mod, opflags)
	`open` (cal, cancellable)
	`receive_objects` (cal, cancellable, calobj, opflags)
	`refresh` (cal, cancellable)
	`remove_objects` (cal, cancellable, ids, mod, opflags)
	`send_objects` (cal, cancellable, calobj, opflags, users)

Virtual Methods¶

Inherited:: EDataCal.CalBackend (15), EBackend.Backend (3), GObject.Object (7), ECal.TimezoneCache (2)

	`do_add_timezone_sync` (cal, cancellable, tzobject)
	`do_discard_alarm_sync` (cal, cancellable, uid, rid, auid, opflags)
	`do_get_object_sync` (cal, cancellable, uid, rid, calobj)
	`do_get_timezone_sync` (cal, cancellable, tzid, tzobject)
	`do_open_sync` (cal, cancellable)
	`do_receive_objects_sync` (cal, cancellable, calobj, opflags)
	`do_refresh_sync` (cal, cancellable)

Properties¶

Inherited:: EDataCal.CalBackend (5), EBackend.Backend (5)

Signals¶

Inherited:: EDataCal.CalBackend (2), GObject.Object (1), ECal.TimezoneCache (1)

Fields¶

Inherited:: EDataCal.CalBackend (2), GObject.Object (1), ECal.TimezoneCache (1)

Name	Type	Access	Description
parent	`EDataCal.CalBackend`	r

Class Details¶

class EDataCal.CalBackendSync(**kwargs)¶

Bases:: EDataCal.CalBackend
Abstract:: No
Structure:: EDataCal.CalBackendSyncClass

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

add_timezone(cal, cancellable, tzobject)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
tzobject (str) – VTIMEZONE object to be added.

Raises:

GLib.Error

Calls the add_timezone_sync method on the given backend.

create_objects(cal, cancellable, calobjs, opflags)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
calobjs ([str]) – The objects to be added.
opflags (ECal.OperationFlags) – bit-or of ECal.OperationFlags

Raises:

GLib.Error

Returns:

uids:: Placeholder for server-generated UIDs.
new_components:: Placeholder for returned ECal.Component objects.

Return type:

(uids: [str], new_components: [ECal.Component])

Calls the create_objects_sync method on the given backend.

New in version 3.6.

discard_alarm(cal, cancellable, uid, rid, auid, opflags)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
uid (str) – Unique id of the calendar object.
rid (str) – Recurrence id of the calendar object.
auid (str) – Alarm ID to remove.
opflags (ECal.OperationFlags) – bit-or of ECal.OperationFlags

Raises:

GLib.Error

Calls the discard_alarm_sync method on the given backend.

get_attachment_uris(cal, cancellable, uid, rid, attachments)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
uid (str) – Unique id of the calendar object.
rid (str) – Recurrence id of the calendar object.
attachments ([str]) – Placeholder for list of returned attachment uris.

Raises:

GLib.Error

Calls the get_attachment_uris_sync method on the given backend.

New in version 3.2.

get_free_busy(cal, cancellable, users, start, end)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
users ([str]) – List of users to get F/B info from.
start (int) – Time range start.
end (int) – Time range end.

Raises:

GLib.Error

Returns:

Placeholder for F/B information.

Return type:

freebusyobjects: [str]

Calls the get_free_busy_sync method on the given backend.

get_object(cal, cancellable, uid, rid)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
uid (str) – UID of the object to get.
rid (str or None) – Recurrence ID of the specific instance to get, or None if getting the master object.

Raises:

GLib.Error

Returns:

Placeholder for returned object.

Return type:

calobj: str

Calls the get_object_sync method on the given backend.

get_object_list(cal, cancellable, sexp)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
sexp (str) – Search query.

Raises:

GLib.Error

Returns:

Placeholder for list of returned objects.

Return type:

calobjs: [str]

Calls the get_object_list_sync method on the given backend.

get_timezone(cal, cancellable, tzid, tzobject)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
tzid (str) – ID of the timezone to retrieve.
tzobject (str) – Placeholder for the returned timezone.

Raises:

GLib.Error

Calls the get_timezone_sync method on the given backend. This method is not mandatory on the backend, because here is used internal_get_timezone call to fetch timezone from it and that is transformed to a string. In other words, any object deriving from EDataCal.CalBackendSync can implement only internal_get_timezone and can skip implementation of get_timezone_sync completely.

modify_objects(cal, cancellable, calobjs, mod, opflags)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
calobjs ([str]) – Objects to be modified.
mod (ECal.ObjModType) – Type of modification to be done.
opflags (ECal.OperationFlags) – bit-or of ECal.OperationFlags

Raises:

GLib.Error

Returns:

old_components:: Placeholder for returning the old components as they were stored on the backend.
new_components:: Placeholder for returning the new components as they have been stored on the backend.

Return type:

(old_components: [ECal.Component], new_components: [ECal.Component])

Calls the modify_objects_sync method on the given backend.

New in version 3.6.

open(cal, cancellable)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation or just create it when it does not exist.

Raises:

GLib.Error

Calls the open_sync method on the given backend.

receive_objects(cal, cancellable, calobj, opflags)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
calobj (str) – iCalendar object to receive.
opflags (ECal.OperationFlags) – bit-or of ECal.OperationFlags

Raises:

GLib.Error

Calls the receive_objects_sync method on the given backend.

refresh(cal, cancellable)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation

Raises:

GLib.Error

Calls the refresh_sync method on the given backend.

New in version 2.30.

remove_objects(cal, cancellable, ids, mod, opflags)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
ids ([ECal.ComponentId]) – List of ECal.ComponentId objects identifying the objects to remove.
mod (ECal.ObjModType) – Type of removal.
opflags (ECal.OperationFlags) – bit-or of ECal.OperationFlags

Raises:

GLib.Error

Returns:

old_components:: Placeholder for returning the old components as they were stored on the backend.
new_components:: Placeholder for returning the new components as they have been stored on the backend (when removing individual instances). If removing whole objects, they will be set to None.

Return type:

(old_components: [ECal.Component], new_components: [ECal.Component])

Calls the remove_objects_sync method on the given backend.

New in version 3.6.

send_objects(cal, cancellable, calobj, opflags, users)¶

Parameters:

cal (EDataCal.DataCal) – An EDataCal.DataCal object.
cancellable (Gio.Cancellable or None) – a Gio.Cancellable for the operation
calobj (str) – The iCalendar object to send.
opflags (ECal.OperationFlags) – bit-or of ECal.OperationFlags
users ([str]) – List of users to send notifications to.

Raises:

GLib.Error

Returns:

Placeholder for the iCalendar object after being modified.

Return type:

modified_calobj: str

Calls the send_objects_sync method on the given backend.

do_add_timezone_sync(cal, cancellable, tzobject) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –
tzobject (str) –

Add specified timezone

do_discard_alarm_sync(cal, cancellable, uid, rid, auid, opflags) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –
uid (str) –
rid (str) –
auid (str) –
opflags (ECal.OperationFlags) –

Discard alarm

do_get_object_sync(cal, cancellable, uid, rid, calobj) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –
uid (str) –
rid (str) –
calobj (str) –

Get single object

do_get_timezone_sync(cal, cancellable, tzid, tzobject) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –
tzid (str) –
tzobject (str) –

Get specified timezone

do_open_sync(cal, cancellable) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –

Open the calendar

do_receive_objects_sync(cal, cancellable, calobj, opflags) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –
calobj (str) –
opflags (ECal.OperationFlags) –

Receive objects

do_refresh_sync(cal, cancellable) virtual¶

Parameters:

cal (EDataCal.DataCal) –
cancellable (Gio.Cancellable or None) –

Refresh the calendar