Top | ![]() |
![]() |
![]() |
![]() |
ECalBackendSyncECalBackendSync — A convenience subclass of ECalBackend |
|
e_cal_backend_sync_open () |
|
e_cal_backend_sync_refresh () |
|
e_cal_backend_sync_get_object () |
|
e_cal_backend_sync_get_object_list () |
|
e_cal_backend_sync_get_free_busy () |
|
e_cal_backend_sync_create_objects () |
|
e_cal_backend_sync_modify_objects () |
|
e_cal_backend_sync_remove_objects () |
|
e_cal_backend_sync_receive_objects () |
|
e_cal_backend_sync_send_objects () |
|
e_cal_backend_sync_get_attachment_uris () |
|
e_cal_backend_sync_discard_alarm () |
|
e_cal_backend_sync_get_timezone () |
|
e_cal_backend_sync_add_timezone () |
This class can be subclassed in place of the ECalBackend abstract backend for easier implementation of calendar backends.
void e_cal_backend_sync_open (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellable,
gboolean only_if_exists);
GError **error
Calls the open_sync method on the given backend.
void e_cal_backend_sync_refresh (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellable);
GError **error
Calls the refresh_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
error |
Out parameter for a |
Since: 2.30
void e_cal_backend_sync_get_object (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *uidconst
,gchar *rid,
gchar **calobj);
GError **error
Calls the get_object_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
uid |
UID of the object to get. |
|
rid |
Recurrence ID of the specific instance to get, or NULL if getting the master object. |
|
calobj |
Placeholder for returned object. |
|
error |
Out parameter for a |
void e_cal_backend_sync_get_object_list (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *sexp,
GSList **calobjs);
GError **error
Calls the get_object_list_sync method on the given backend.
void e_cal_backend_sync_get_free_busy (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,GSList *users,
time_t start,
time_t end,
GSList **freebusyobjects);
GError **error
Calls the get_free_busy_sync method on the given backend.
void e_cal_backend_sync_create_objects (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,GSList *calobjs,
GSList **uids,
GSList **new_components);
GError **error
Calls the create_objects_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
calobjs |
The objects to be added. |
|
uids |
Placeholder for server-generated UIDs. |
|
new_components |
Placeholder for returned |
[out][transfer full] |
error |
Out parameter for a |
Since: 3.6
void e_cal_backend_sync_modify_objects (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,GSList *calobjsECalObjModType mod
,,
GSList **old_components,
GSList **new_components);
GError **error
Calls the modify_objects_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
calobjs |
Objects to be modified. |
|
mod |
Type of modification to be done. |
|
old_components |
Placeholder for returning the old components as they were stored on the backend. |
[out][transfer full] |
new_components |
Placeholder for returning the new components as they have been stored on the backend. |
[out][transfer full] |
error |
Out parameter for a |
Since: 3.6
void e_cal_backend_sync_remove_objects (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,GSList *idsECalObjModType mod
,,
GSList **old_components,
GSList **new_components);
GError **error
Calls the remove_objects_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
ids |
List of ECalComponentId objects identifying the objects to remove. |
|
mod |
Type of removal. |
|
old_components |
Placeholder for returning the old components as they were stored on the backend. |
[out][transfer full] |
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 |
[out][transfer full] |
error |
Out parameter for a |
Since: 3.6
void e_cal_backend_sync_receive_objects (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *calobj);
GError **error
Calls the receive_objects_sync method on the given backend.
void e_cal_backend_sync_send_objects (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *calobj,
GSList **users,
gchar **modified_calobj);
GError **error
Calls the send_objects_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
calobj |
The iCalendar object to send. |
|
users |
List of users to send notifications to. |
|
modified_calobj |
Placeholder for the iCalendar object after being modified. |
|
error |
Out parameter for a |
void e_cal_backend_sync_get_attachment_uris (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *uidconst
,gchar *rid,
GSList **attachments);
GError **error
Calls the get_attachment_uris_sync method on the given backend.
backend |
An ECalBackendSync object. |
|
cal |
An EDataCal object. |
|
cancellable |
a |
|
uid |
Unique id of the calendar object. |
|
rid |
Recurrence id of the calendar object. |
|
attachments |
Placeholder for list of returned attachment uris. |
|
error |
Out parameter for a |
Since: 3.2
void e_cal_backend_sync_discard_alarm (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *uidconst
,gchar *ridconst
,gchar *auid);
GError **error
Calls the discard_alarm_sync method on the given backend.
void e_cal_backend_sync_get_timezone (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *tzid,
gchar **tzobject);
GError **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 ECalBackendSync can implement only internal_get_timezone and can skip implementation of get_timezone_sync completely.
void e_cal_backend_sync_add_timezone (ECalBackendSync *backend
,,
EDataCal *cal,
GCancellable *cancellableconst
,gchar *tzobject);
GError **error
Calls the add_timezone_sync method on the given backend.
struct ECalBackendSync { };
Contains only private data that should be read and manipulated using the functions below.
struct ECalBackendSyncClass { /* Virtual methods */ void (*open_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, gboolean only_if_exists, GError **error); void (*refresh_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, GError **error); /* This method is deprecated. */ gboolean (*set_backend_property_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *prop_name, const gchar *prop_value, GError **error); void (*get_object_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *uid, const gchar *rid, gchar **calobj, GError **error); void (*get_object_list_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *sexp, GSList **calobjs, GError **error); void (*get_free_busy_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const GSList *users, time_t start, time_t end, GSList **freebusyobjs, GError **error); void (*create_objects_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const GSList *calobjs, GSList **uids, GSList **new_components, GError **error); void (*modify_objects_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const GSList *calobjs, ECalObjModType mod, GSList **old_components, GSList **new_components, GError **error); void (*remove_objects_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const GSList *ids, ECalObjModType mod, GSList **old_components, GSList **new_components, GError **error); void (*receive_objects_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *calobj, GError **error); void (*send_objects_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *calobj, GSList **users, gchar **modified_calobj, GError **error); void (*get_attachment_uris_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *uid, const gchar *rid, GSList **attachments, GError **error); void (*discard_alarm_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *uid, const gchar *rid, const gchar *auid, GError **error); void (*get_timezone_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *tzid, gchar **tzobject, GError **error); void (*add_timezone_sync) (ECalBackendSync *backend, EDataCal *cal, GCancellable *cancellable, const gchar *tzobject, GError **error); };
Base class structure for the ECalBackendSync class
Open the calendar |
||
Refresh the calendar |
||
Deprecated: Set backend property |
||
Get single object |
||
Get multiple objects at once |
||
Get Free/Busy objects |
||
Create objects |
||
Modify objects |
||
Remove objects |
||
Receive objects |
||
Send objects |
||
Get attachments uris for given object |
||
Discard alarm |
||
Get specified timezone |
||
Add specified timezone |
Since: 3.4