![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Calendar Backend (libedata-cal) | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
struct ECalBackendSync; void e_cal_backend_sync_set_lock (ECalBackendSync *backend
,gboolean lock
); void e_cal_backend_sync_open (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,gboolean only_if_exists
,GError **error
); void e_cal_backend_sync_remove (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,GError **error
); void e_cal_backend_sync_refresh (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,GError **error
); gboolean e_cal_backend_sync_get_backend_property (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *prop_name
,gchar **prop_value
,GError **error
); gboolean e_cal_backend_sync_set_backend_property (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *prop_name
,const gchar *prop_value
,GError **error
); void e_cal_backend_sync_get_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,gchar **calobj
,GError **error
); void e_cal_backend_sync_get_object_list (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *sexp
,GSList **calobjs
,GError **error
); void e_cal_backend_sync_get_free_busy (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const GSList *users
,time_t start
,time_t end
,GSList **freebusyobjs
,GError **error
); void e_cal_backend_sync_create_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,gchar **uid
,gchar **new_object
,GError **error
); void e_cal_backend_sync_modify_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,CalObjModType mod
,gchar **old_object
,gchar **new_object
,GError **error
); void e_cal_backend_sync_remove_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,CalObjModType mod
,gchar **old_object
,gchar **new_object
,GError **error
); void e_cal_backend_sync_receive_objects (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,GError **error
); void e_cal_backend_sync_send_objects (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,GSList **users
,gchar **modified_calobj
,GError **error
); void e_cal_backend_sync_get_attachment_uris (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,GSList **attachments
,GError **error
); void e_cal_backend_sync_discard_alarm (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,const gchar *auid
,GError **error
); void e_cal_backend_sync_get_timezone (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *tzid
,gchar **tzobject
,GError **error
); void e_cal_backend_sync_add_timezone (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *tzobject
,GError **error
); void e_cal_backend_sync_authenticate_user (ECalBackendSync *backend
,GCancellable *cancellable
,ECredentials *credentials
,GError **error
);
void e_cal_backend_sync_set_lock (ECalBackendSync *backend
,gboolean lock
);
Sets the lock mode on the ECalBackendSync object. If TRUE, the backend will create a locking mutex for every operation, so that only one can happen at a time. If FALSE, no lock would be done and many operations can happen at the same time.
|
An ECalBackendSync object. |
|
Lock mode. |
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.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Whether to open the calendar if and only if it already exists or just create it when it does not exist. |
|
Out parameter for a GError. |
void e_cal_backend_sync_remove (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,GError **error
);
Calls the remove_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Out parameter for a GError. |
void e_cal_backend_sync_refresh (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,GError **error
);
Calls the refresh_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Out parameter for a GError. |
Since 2.30
gboolean e_cal_backend_sync_get_backend_property (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *prop_name
,gchar **prop_value
,GError **error
);
Calls the get_backend_property_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Property name whose value to retrieve. |
|
Return value of the prop_name . |
|
Out parameter for a GError. |
Returns : |
whether processed this property. Returning FALSE means to pass
the call to the ECalBackend parent class, thus neither error should be
set in this case. |
Since 3.2
gboolean e_cal_backend_sync_set_backend_property (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *prop_name
,const gchar *prop_value
,GError **error
);
Calls the set_backend_property_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Property name to set. |
|
New value of the prop_name . |
|
Out parameter for a GError. |
Returns : |
whether processed this property. Returning FALSE means to pass
the call to the ECalBackend parent class, thus neither error should be
set in this case. |
Since 3.2
void e_cal_backend_sync_get_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,gchar **calobj
,GError **error
);
Calls the get_object_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
UID of the object to get. |
|
Recurrence ID of the specific instance to get, or NULL if getting the master object. |
|
Placeholder for returned object. |
|
Out parameter for a GError. |
void e_cal_backend_sync_get_object_list (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *sexp
,GSList **calobjs
,GError **error
);
Calls the get_object_list_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Search query. |
|
Placeholder for list of returned objects. |
|
Out parameter for a GError. |
void e_cal_backend_sync_get_free_busy (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const GSList *users
,time_t start
,time_t end
,GSList **freebusyobjs
,GError **error
);
Calls the get_free_busy_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
List of users to get F/B info from. |
|
Time range start. |
|
Time range end. |
|
Out parameter for a GError. |
void e_cal_backend_sync_create_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,gchar **uid
,gchar **new_object
,GError **error
);
Calls the create_object_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
The object to be added. |
|
Placeholder for server-generated UID. |
|
Placeholder for server-calobj, if it changed. Can be left as is if it's same as calobj . |
|
Out parameter for a GError. |
void e_cal_backend_sync_modify_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,CalObjModType mod
,gchar **old_object
,gchar **new_object
,GError **error
);
Calls the modify_object_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Object to be modified. |
|
Type of modification to be done. |
|
Placeholder for returning the old object as it was stored on the backend. |
|
Placeholder for returning the new object as it has been stored on the backend. |
|
Out parameter for a GError. |
void e_cal_backend_sync_remove_object (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,CalObjModType mod
,gchar **old_object
,gchar **new_object
,GError **error
);
Calls the remove_object_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
UID of the object to remove. |
|
Recurrence ID of the instance to remove, or NULL if removing the whole object. |
|
Type of removal. |
|
Placeholder for returning the old object as it was stored on the backend. |
|
Placeholder for returning the object after it has been modified (when removing individual instances). If removing the whole object, this will be NULL. |
|
Out parameter for a GError. |
void e_cal_backend_sync_receive_objects (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,GError **error
);
Calls the receive_objects_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
iCalendar object to receive. |
|
Out parameter for a GError. |
void e_cal_backend_sync_send_objects (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *calobj
,GSList **users
,gchar **modified_calobj
,GError **error
);
Calls the send_objects_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
The iCalendar object to send. |
|
List of users to send notifications to. |
|
Placeholder for the iCalendar object after being modified. |
|
Out parameter for a GError. |
void e_cal_backend_sync_get_attachment_uris (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,GSList **attachments
,GError **error
);
Calls the get_attachment_uris_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Unique id of the calendar object. |
|
Recurrence id of the calendar object. |
|
Placeholder for list of returned attachment uris. |
|
Out parameter for a GError. |
Since 3.2
void e_cal_backend_sync_discard_alarm (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *uid
,const gchar *rid
,const gchar *auid
,GError **error
);
Calls the discard_alarm_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
Unique id of the calendar object. |
|
Recurrence id of the calendar object. |
|
Alarm ID to remove. |
|
Out parameter for a GError. |
void e_cal_backend_sync_get_timezone (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const 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.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
ID of the timezone to retrieve. |
|
Placeholder for the returned timezone. |
|
Out parameter for a GError. |
void e_cal_backend_sync_add_timezone (ECalBackendSync *backend
,EDataCal *cal
,GCancellable *cancellable
,const gchar *tzobject
,GError **error
);
Calls the add_timezone_sync method on the given backend.
|
An ECalBackendSync object. |
|
An EDataCal object. |
|
a GCancellable for the operation |
|
VTIMEZONE object to be added. |
|
Out parameter for a GError. |
void e_cal_backend_sync_authenticate_user (ECalBackendSync *backend
,GCancellable *cancellable
,ECredentials *credentials
,GError **error
);
Authenticates backend
with given credentials
.
|
an ECalBackendSync |
|
a GCancellable for the operation |
|
an ECredentials to authenticate with |
|
GError to set, when something fails |
Since 3.2