|  |  |  | Evolution-Data-Server Manual: Calendar Backend (libedata-cal) |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
                    ECalBackendSync;
typedef             ECalBackendSyncStatus;
ECalBackendSync *   (*ECalBackendSyncFactoryFn)         (void);
void                e_cal_backend_sync_set_lock         (ECalBackendSync *backend,
                                                         gboolean lock);
ECalBackendSyncStatus  e_cal_backend_sync_is_read_only  (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gboolean *read_only);
ECalBackendSyncStatus  e_cal_backend_sync_get_cal_address
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gchar **address);
ECalBackendSyncStatus  e_cal_backend_sync_get_alarm_email_address
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gchar **address);
ECalBackendSyncStatus  e_cal_backend_sync_get_ldap_attribute
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gchar **attribute);
ECalBackendSyncStatus  e_cal_backend_sync_get_static_capabilities
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gchar **capabiliites);
ECalBackendSyncStatus  e_cal_backend_sync_open          (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gboolean only_if_exists,
                                                         const gchar *username,
                                                         const gchar *password);
ECalBackendSyncStatus  e_cal_backend_sync_remove        (ECalBackendSync *backend,
                                                         EDataCal *cal);
ECalBackendSyncStatus  e_cal_backend_sync_create_object (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gchar **calobj,
                                                         gchar **uid);
ECalBackendSyncStatus  e_cal_backend_sync_modify_object (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *calobj,
                                                         CalObjModType mod,
                                                         gchar **old_object,
                                                         gchar **new_object);
ECalBackendSyncStatus  e_cal_backend_sync_remove_object (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *uid,
                                                         const gchar *rid,
                                                         CalObjModType mod,
                                                         gchar **old_object,
                                                         gchar **object);
ECalBackendSyncStatus  e_cal_backend_sync_get_attachment_list
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *uid,
                                                         const gchar *rid,
                                                         GSList **attachments);
ECalBackendSyncStatus  e_cal_backend_sync_discard_alarm (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *uid,
                                                         const gchar *auid);
ECalBackendSyncStatus  e_cal_backend_sync_receive_objects
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *calobj);
ECalBackendSyncStatus  e_cal_backend_sync_send_objects  (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *calobj,
                                                         GList **users,
                                                         gchar **modified_calobj);
ECalBackendSyncStatus  e_cal_backend_sync_get_default_object
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         gchar **object);
ECalBackendSyncStatus  e_cal_backend_sync_get_object    (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *uid,
                                                         const gchar *rid,
                                                         gchar **object);
ECalBackendSyncStatus  e_cal_backend_sync_get_object_list
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *sexp,
                                                         GList **objects);
ECalBackendSyncStatus  e_cal_backend_sync_get_timezone  (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *tzid,
                                                         gchar **object);
ECalBackendSyncStatus  e_cal_backend_sync_add_timezone  (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *tzobj);
ECalBackendSyncStatus  e_cal_backend_sync_set_default_timezone
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *tzid);
ECalBackendSyncStatus  e_cal_backend_sync_set_default_zone
                                                        (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *tzobj);
ECalBackendSyncStatus  e_cal_backend_sync_get_changes   (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         const gchar *change_id,
                                                         GList **adds,
                                                         GList **modifies,
                                                         GList **deletes);
ECalBackendSyncStatus  e_cal_backend_sync_get_free_busy (ECalBackendSync *backend,
                                                         EDataCal *cal,
                                                         GList *users,
                                                         time_t start,
                                                         time_t end,
                                                         GList **freebusy);
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. | 
ECalBackendSyncStatus e_cal_backend_sync_is_read_only (ECalBackendSync *backend, EDataCal *cal, gboolean *read_only);
Calls the is_read_only method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Return value for read-only status. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_cal_address (ECalBackendSync *backend, EDataCal *cal, gchar **address);
Calls the get_cal_address method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Return value for the address. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_alarm_email_address (ECalBackendSync *backend, EDataCal *cal, gchar **address);
Calls the get_alarm_email_address method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Return value for the address. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_ldap_attribute (ECalBackendSync *backend, EDataCal *cal, gchar **attribute);
Calls the get_ldap_attribute method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Return value for LDAP attribute. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_static_capabilities (ECalBackendSync *backend, EDataCal *cal, gchar **capabiliites);
Calls the get_capabilities method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | |
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_open (ECalBackendSync *backend, EDataCal *cal, gboolean only_if_exists, const gchar *username, const gchar *password);
Calls the open method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Whether to open the calendar if and only if it already exists or just create it when it does not exist. | 
| 
 | User name to use for authentication. | 
| 
 | Password to use for authentication. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_remove (ECalBackendSync *backend, EDataCal *cal);
Calls the remove method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_create_object (ECalBackendSync *backend, EDataCal *cal, gchar **calobj, gchar **uid);
Calls the create_object method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | The object to be added. | 
| 
 | Placeholder for server-generated UID. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_modify_object (ECalBackendSync *backend, EDataCal *cal, const gchar *calobj, CalObjModType mod, gchar **old_object, gchar **new_object);
Calls the modify_object method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | 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. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_remove_object (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *rid, CalObjModType mod, gchar **old_object, gchar **object);
Calls the remove_object method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | 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. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_attachment_list (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *rid, GSList **attachments);
Calls the get_attachment_list method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Unique id of the calendar object. | 
| 
 | Recurrence id of the calendar object. | 
| 
 | Placeholder for list of returned attachment uris. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_discard_alarm (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *auid);
Calls the discard_alarm method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | UID of the object to discard the alarm from. | 
| 
 | UID of the alarm to be discarded. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_receive_objects (ECalBackendSync *backend, EDataCal *cal, const gchar *calobj);
Calls the receive_objects method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | iCalendar object to receive. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_send_objects (ECalBackendSync *backend, EDataCal *cal, const gchar *calobj, GList **users, gchar **modified_calobj);
Calls the send_objects method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | The iCalendar object to send. | 
| 
 | List of users to send notifications to. | 
| 
 | Placeholder for the iCalendar object after being modified. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_default_object (ECalBackendSync *backend, EDataCal *cal, gchar **object);
Calls the get_default_object method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Placeholder for returned object. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_object (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *rid, gchar **object);
Calls the get_object method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | 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. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_object_list (ECalBackendSync *backend, EDataCal *cal, const gchar *sexp, GList **objects);
Calls the get_object_list method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | Search query. | 
| 
 | Placeholder for list of returned objects. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_timezone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzid, gchar **object);
Calls the get_timezone method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | ID of the timezone to retrieve. | 
| 
 | Placeholder for the returned timezone. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_add_timezone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzobj);
Calls the add_timezone method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | VTIMEZONE object to be added. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_set_default_timezone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzid);
| 
 | |
| 
 | |
| 
 | |
| Returns : | 
ECalBackendSyncStatus e_cal_backend_sync_set_default_zone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzobj);
Calls the set_default_timezone method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | |
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_changes (ECalBackendSync *backend, EDataCal *cal, const gchar *change_id, GList **adds, GList **modifies, GList **deletes);
Calls the get_changes method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | ID of the change to use as base. | 
| 
 | Placeholder for list of additions. | 
| 
 | Placeholder for list of modifications. | 
| 
 | Placeholder for list of deletions. | 
| Returns : | Status code. | 
ECalBackendSyncStatus e_cal_backend_sync_get_free_busy (ECalBackendSync *backend, EDataCal *cal, GList *users, time_t start, time_t end, GList **freebusy);
Calls the get_free_busy method on the given backend.
| 
 | An ECalBackendSync object. | 
| 
 | An EDataCal object. | 
| 
 | List of users to get F/B info from. | 
| 
 | Time range start. | 
| 
 | Time range end. | 
| 
 | Placeholder for F/B information. | 
| Returns : | Status code. |