ECalBackend
3
LIBEDATA-CAL Library

# ECalBackend

Base class for calendar/tasks backend implementations.

## Synopsis

    ESource*            e_cal_backend_get_source            (ECalBackend *backend);
    const char*         e_cal_backend_get_uri               (ECalBackend *backend);
    icalcomponent_kind  e_cal_backend_get_kind              (ECalBackend *backend);
    void                e_cal_backend_add_client            (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_remove_client         (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_add_query             (ECalBackend *backend,
                                                             EDataCalView *query);
    EList*              e_cal_backend_get_queries           (ECalBackend *backend);
    void                e_cal_backend_remove_query          (ECalBackend *backend,
                                                             EDataCalView *query);
    void                e_cal_backend_is_read_only          (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_get_cal_address       (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_get_alarm_email_address
                                                            (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_get_ldap_attribute    (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_get_static_capabilities
                                                            (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_open                  (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             gboolean only_if_exists,
                                                             const char *username,
                                                             const char *password);
    void                e_cal_backend_remove                (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_create_object         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj);
    void                e_cal_backend_modify_object         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj,
                                                             CalObjModType mod);
    void                e_cal_backend_remove_object         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *rid,
                                                             CalObjModType mod);
    void                e_cal_backend_discard_alarm         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *auid);
    void                e_cal_backend_receive_objects       (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj);
    void                e_cal_backend_send_objects          (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj);
    void                e_cal_backend_get_default_object    (ECalBackend *backend,
                                                             EDataCal *cal);
    void                e_cal_backend_get_object            (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *rid);
    void                e_cal_backend_get_object_list       (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *sexp);
    void                e_cal_backend_get_attachment_list   (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *rid);
    gboolean            e_cal_backend_is_loaded             (ECalBackend *backend);
    void                e_cal_backend_start_query           (ECalBackend *backend,
                                                             EDataCalView *query);
    CalMode             e_cal_backend_get_mode              (ECalBackend *backend);
    void                e_cal_backend_set_mode              (ECalBackend *backend,
                                                             CalMode mode);
    void                e_cal_backend_get_timezone          (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *tzid);
    void                e_cal_backend_add_timezone          (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *object);
    void                e_cal_backend_set_default_timezone  (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *tzid);
    void                e_cal_backend_set_default_zone      (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *tzobj);
    void                e_cal_backend_get_changes           (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *change_id);
    void                e_cal_backend_get_free_busy         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             GList *users,
                                                             time_t start,
                                                             time_t end);
    icaltimezone*       e_cal_backend_internal_get_default_timezone
                                                            (ECalBackend *backend);
    icaltimezone*       e_cal_backend_internal_get_timezone (ECalBackend *backend,
                                                             const char *tzid);
    void                e_cal_backend_last_client_gone      (ECalBackend *backend);
    void                e_cal_backend_set_notification_proxy
                                                            (ECalBackend *backend,
                                                             ECalBackend *proxy);
    void                e_cal_backend_notify_object_created (ECalBackend *backend,
                                                             const char *calobj);
    void                e_cal_backend_notify_object_modified
                                                            (ECalBackend *backend,
                                                             const char *old_object,
                                                             const char *object);
    void                e_cal_backend_notify_object_removed (ECalBackend *backend,
                                                             const ECalComponentId *id,
                                                             const char *old_object,
                                                             const char *object);
    void                e_cal_backend_notify_mode           (ECalBackend *backend,
                                                             GNOME_Evolution_Calendar_CalListener_SetModeStatus status,
                                                             GNOME_Evolution_Calendar_CalMode mode);
    void                e_cal_backend_notify_auth_required  (ECalBackend *backend);
    void                e_cal_backend_notify_error          (ECalBackend *backend,
                                                             const char *message);
    void                e_cal_backend_notify_view_done      (ECalBackend *backend,
                                                             GNOME_Evolution_Calendar_CallStatus status);
    void                e_cal_backend_notify_view_progress  (ECalBackend *backend,
                                                             const char *message,
                                                             int percent);
    void                e_cal_backend_notify_readonly       (ECalBackend *backend,
                                                             gboolean read_only);
    void                e_cal_backend_notify_cal_address    (ECalBackend *backend,
                                                             char *address);

## Description

## Details

### e_cal_backend_get_source ()

    ESource*            e_cal_backend_get_source            (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_get_uri ()

    const char*         e_cal_backend_get_uri               (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_get_kind ()

    icalcomponent_kind  e_cal_backend_get_kind              (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_add_client ()

    void                e_cal_backend_add_client            (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_remove_client ()

    void                e_cal_backend_remove_client         (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_add_query ()

    void                e_cal_backend_add_query             (ECalBackend *backend,
                                                             EDataCalView *query);

`backend` :

`query` :

### e_cal_backend_get_queries ()

    EList*              e_cal_backend_get_queries           (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_remove_query ()

    void                e_cal_backend_remove_query          (ECalBackend *backend,
                                                             EDataCalView *query);

`backend` :

`query` :

### e_cal_backend_is_read_only ()

    void                e_cal_backend_is_read_only          (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_get_cal_address ()

    void                e_cal_backend_get_cal_address       (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_get_alarm_email_address ()

    void                e_cal_backend_get_alarm_email_address
                                                            (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_get_ldap_attribute ()

    void                e_cal_backend_get_ldap_attribute    (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_get_static_capabilities ()

    void                e_cal_backend_get_static_capabilities
                                                            (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_open ()

    void                e_cal_backend_open                  (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             gboolean only_if_exists,
                                                             const char *username,
                                                             const char *password);

`backend` :

`cal` :

`only_if_exists` :

`username` :

`password` :

### e_cal_backend_remove ()

    void                e_cal_backend_remove                (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_create_object ()

    void                e_cal_backend_create_object         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj);

`backend` :

`cal` :

`calobj` :

### e_cal_backend_modify_object ()

    void                e_cal_backend_modify_object         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj,
                                                             CalObjModType mod);

`backend` :

`cal` :

`calobj` :

`mod` :

### e_cal_backend_remove_object ()

    void                e_cal_backend_remove_object         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *rid,
                                                             CalObjModType mod);

`backend` :

`cal` :

`uid` :

`rid` :

`mod` :

### e_cal_backend_discard_alarm ()

    void                e_cal_backend_discard_alarm         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *auid);

`backend` :

`cal` :

`uid` :

`auid` :

### e_cal_backend_receive_objects ()

    void                e_cal_backend_receive_objects       (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj);

`backend` :

`cal` :

`calobj` :

### e_cal_backend_send_objects ()

    void                e_cal_backend_send_objects          (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *calobj);

`backend` :

`cal` :

`calobj` :

### e_cal_backend_get_default_object ()

    void                e_cal_backend_get_default_object    (ECalBackend *backend,
                                                             EDataCal *cal);

`backend` :

`cal` :

### e_cal_backend_get_object ()

    void                e_cal_backend_get_object            (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *rid);

`backend` :

`cal` :

`uid` :

`rid` :

### e_cal_backend_get_object_list ()

    void                e_cal_backend_get_object_list       (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *sexp);

`backend` :

`cal` :

`sexp` :

### e_cal_backend_get_attachment_list ()

    void                e_cal_backend_get_attachment_list   (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *uid,
                                                             const char *rid);

`backend` :

`cal` :

`uid` :

`rid` :

### e_cal_backend_is_loaded ()

    gboolean            e_cal_backend_is_loaded             (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_start_query ()

    void                e_cal_backend_start_query           (ECalBackend *backend,
                                                             EDataCalView *query);

`backend` :

`query` :

### e_cal_backend_get_mode ()

    CalMode             e_cal_backend_get_mode              (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_set_mode ()

    void                e_cal_backend_set_mode              (ECalBackend *backend,
                                                             CalMode mode);

`backend` :

`mode` :

### e_cal_backend_get_timezone ()

    void                e_cal_backend_get_timezone          (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *tzid);

`backend` :

`cal` :

`tzid` :

### e_cal_backend_add_timezone ()

    void                e_cal_backend_add_timezone          (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *object);

`backend` :

`cal` :

`object` :

### e_cal_backend_set_default_timezone ()

    void                e_cal_backend_set_default_timezone  (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *tzid);

`backend` :

`cal` :

`tzid` :

### e_cal_backend_set_default_zone ()

    void                e_cal_backend_set_default_zone      (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *tzobj);

`backend` :

`cal` :

`tzobj` :

### e_cal_backend_get_changes ()

    void                e_cal_backend_get_changes           (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             const char *change_id);

`backend` :

`cal` :

`change_id` :

### e_cal_backend_get_free_busy ()

    void                e_cal_backend_get_free_busy         (ECalBackend *backend,
                                                             EDataCal *cal,
                                                             GList *users,
                                                             time_t start,
                                                             time_t end);

`backend` :

`cal` :

`users` :

`start` :

`end` :

### e_cal_backend_internal_get_default_timezone ()

    icaltimezone*       e_cal_backend_internal_get_default_timezone
                                                            (ECalBackend *backend);

`backend` :

Returns :

### e_cal_backend_internal_get_timezone ()

    icaltimezone*       e_cal_backend_internal_get_timezone (ECalBackend *backend,
                                                             const char *tzid);

`backend` :

`tzid` :

Returns :

### e_cal_backend_last_client_gone ()

    void                e_cal_backend_last_client_gone      (ECalBackend *backend);

`backend` :

### e_cal_backend_set_notification_proxy ()

    void                e_cal_backend_set_notification_proxy
                                                            (ECalBackend *backend,
                                                             ECalBackend *proxy);

`backend` :

`proxy` :

### e_cal_backend_notify_object_created ()

    void                e_cal_backend_notify_object_created (ECalBackend *backend,
                                                             const char *calobj);

`backend` :

`calobj` :

### e_cal_backend_notify_object_modified ()

    void                e_cal_backend_notify_object_modified
                                                            (ECalBackend *backend,
                                                             const char *old_object,
                                                             const char *object);

`backend` :

`old_object` :

`object` :

### e_cal_backend_notify_object_removed ()

    void                e_cal_backend_notify_object_removed (ECalBackend *backend,
                                                             const ECalComponentId *id,
                                                             const char *old_object,
                                                             const char *object);

`backend` :

`id` :

`old_object` :

`object` :

### e_cal_backend_notify_mode ()

    void                e_cal_backend_notify_mode           (ECalBackend *backend,
                                                             GNOME_Evolution_Calendar_CalListener_SetModeStatus status,
                                                             GNOME_Evolution_Calendar_CalMode mode);

`backend` :

`status` :

`mode` :

### e_cal_backend_notify_auth_required ()

    void                e_cal_backend_notify_auth_required  (ECalBackend *backend);

`backend` :

### e_cal_backend_notify_error ()

    void                e_cal_backend_notify_error          (ECalBackend *backend,
                                                             const char *message);

`backend` :

`message` :

### e_cal_backend_notify_view_done ()

    void                e_cal_backend_notify_view_done      (ECalBackend *backend,
                                                             GNOME_Evolution_Calendar_CallStatus status);

`backend` :

`status` :

### e_cal_backend_notify_view_progress ()

    void                e_cal_backend_notify_view_progress  (ECalBackend *backend,
                                                             const char *message,
                                                             int percent);

`backend` :

`message` :

`percent` :

### e_cal_backend_notify_readonly ()

    void                e_cal_backend_notify_readonly       (ECalBackend *backend,
                                                             gboolean read_only);

`backend` :

`read_only` :

### e_cal_backend_notify_cal_address ()

    void                e_cal_backend_notify_cal_address    (ECalBackend *backend,
                                                             char *address);

`backend` :

`address` :