## EDataCal EDataCal — Implementation of the calendar CORBA client interface. |

## Synopsis

    #define             E_DATA_CAL_ERROR
                        EDataCal;
    GError *            e_data_cal_create_error             (EDataCalCallStatus status,
                                                             const gchar *custom_msg);
    GError *            e_data_cal_create_error_fmt         (EDataCalCallStatus status,
                                                             const gchar *custom_msg_fmt,
                                                             ...);
    const gchar *       e_data_cal_status_to_string         (EDataCalCallStatus status);
    #define             e_return_data_cal_error_if_fail     (expr,
                                                             _code)
    #define             e_return_data_cal_error_val_if_fail (expr,
                                                             _code)
    EDataCal *          e_data_cal_new                      (ECalBackend *backend,
                                                             ESource *source);
    ECalBackend *       e_data_cal_get_backend              (EDataCal *cal);
    ESource *           e_data_cal_get_source               (EDataCal *cal);
    guint               e_data_cal_register_gdbus_object    (EDataCal *cal,
                                                             GDBusConnection *connection,
                                                             const gchar *object_path,
                                                             GError **error);
    void                e_data_cal_respond_open             (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_remove           (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_refresh          (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_get_backend_property
                                                            (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *prop_value);
    void                e_data_cal_respond_set_backend_property
                                                            (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_get_object       (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *object);
    void                e_data_cal_respond_get_object_list  (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const GSList *objects);
    void                e_data_cal_respond_get_free_busy    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_create_object    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *uid,
                                                             const gchar *object);
    void                e_data_cal_respond_modify_object    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *old_object,
                                                             const gchar *object);
    void                e_data_cal_respond_remove_object    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const ECalComponentId *id,
                                                             const gchar *old_object,
                                                             const gchar *object);
    void                e_data_cal_respond_receive_objects  (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_send_objects     (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const GSList *users,
                                                             const gchar *calobj);
    void                e_data_cal_respond_get_attachment_uris
                                                            (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const GSList *attachments);
    void                e_data_cal_respond_discard_alarm    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_respond_get_view         (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *view_path);
    void                e_data_cal_respond_get_timezone     (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *tzobject);
    void                e_data_cal_respond_add_timezone     (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);
    void                e_data_cal_report_error             (EDataCal *cal,
                                                             const gchar *message);
    void                e_data_cal_report_readonly          (EDataCal *cal,
                                                             gboolean is_readonly);
    void                e_data_cal_report_online            (EDataCal *cal,
                                                             gboolean is_online);
    void                e_data_cal_report_auth_required     (EDataCal *cal,
                                                             const ECredentials *credentials);
    void                e_data_cal_report_opened            (EDataCal *cal,
                                                             const GError *error);
    void                e_data_cal_report_free_busy_data    (EDataCal *cal,
                                                             const GSList *freebusy);

## Object Hierarchy

      GObject
       +----EDataCal

## Description

## Details

### E_DATA_CAL_ERROR

    #define E_DATA_CAL_ERROR e_data_cal_error_quark ()

Since 2.30

### EDataCal

    typedef struct _EDataCal EDataCal;

### e_data_cal_create_error ()

    GError *            e_data_cal_create_error             (EDataCalCallStatus status,
                                                             const gchar *custom_msg);

Since 2.32

### e_data_cal_create_error_fmt ()

    GError *            e_data_cal_create_error_fmt         (EDataCalCallStatus status,
                                                             const gchar *custom_msg_fmt,
                                                             ...);

Since 2.32

### e_data_cal_status_to_string ()

    const gchar *       e_data_cal_status_to_string         (EDataCalCallStatus status);

Since 2.32

### e_return_data_cal_error_if_fail()

    #define             e_return_data_cal_error_if_fail(expr, _code)

Since 2.32

### e_return_data_cal_error_val_if_fail()

    #define             e_return_data_cal_error_val_if_fail(expr, _code)

Same as `e_return_data_cal_error_if_fail()`, only returns FALSE on a failure

Since 3.2

### e_data_cal_new ()

    EDataCal *          e_data_cal_new                      (ECalBackend *backend,
                                                             ESource *source);

### e_data_cal_get_backend ()

    ECalBackend *       e_data_cal_get_backend              (EDataCal *cal);

### e_data_cal_get_source ()

    ESource *           e_data_cal_get_source               (EDataCal *cal);

Returns the ESource for `cal`.

`cal` : | an EDataCal
Returns : | the ESource for `cal`

Since 2.30

### e_data_cal_register_gdbus_object ()

    guint               e_data_cal_register_gdbus_object    (EDataCal *cal,
                                                             GDBusConnection *connection,
                                                             const gchar *object_path,
                                                             GError **error);

Registers GDBus object of this EDataCal.

Since 2.32

### e_data_cal_respond_open ()

    void                e_data_cal_respond_open             (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

### e_data_cal_respond_remove ()

    void                e_data_cal_respond_remove           (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

Notifies listeners of the completion of the remove method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

### e_data_cal_respond_refresh ()

    void                e_data_cal_respond_refresh          (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

Notifies listeners of the completion of the refresh method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

Since 2.30

### e_data_cal_respond_get_backend_property ()

    void                e_data_cal_respond_get_backend_property
                                                            (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *prop_value);

Notifies listeners of the completion of the get_backend_property method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`prop_value` : | Value of a property

### e_data_cal_respond_set_backend_property ()

    void                e_data_cal_respond_set_backend_property
                                                            (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

Notifies listeners of the completion of the set_backend_property method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

### e_data_cal_respond_get_object ()

    void                e_data_cal_respond_get_object       (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *object);

Notifies listeners of the completion of the get_object method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`object` : | The object retrieved as an iCalendar string.

### e_data_cal_respond_get_object_list ()

    void                e_data_cal_respond_get_object_list  (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const GSList *objects);

Notifies listeners of the completion of the get_object_list method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`objects` : | List of retrieved objects.

### e_data_cal_respond_get_free_busy ()

    void                e_data_cal_respond_get_free_busy    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

Notifies listeners of the completion of the get_free_busy method call. To pass actual free/busy objects to the client use `e_data_cal_report_free_busy_data()`.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

### e_data_cal_respond_create_object ()

    void                e_data_cal_respond_create_object    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *uid,
                                                             const gchar *object);

Notifies listeners of the completion of the create_object method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`uid` : | UID of the object created.
`object` : | The object created as an iCalendar string.

### e_data_cal_respond_modify_object ()

    void                e_data_cal_respond_modify_object    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *old_object,
                                                             const gchar *object);

Notifies listeners of the completion of the modify_object method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`old_object` : | The old object as an iCalendar string.
`object` : | The modified object as an iCalendar string.

### e_data_cal_respond_remove_object ()

    void                e_data_cal_respond_remove_object    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const ECalComponentId *id,
                                                             const gchar *old_object,
                                                             const gchar *object);

Notifies listeners of the completion of the remove_object method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`old_object` : | The old object as an iCalendar string.
`object` : | The new object as an iCalendar string. This will not be NULL only when removing instances of a recurring appointment.

### e_data_cal_respond_receive_objects ()

    void                e_data_cal_respond_receive_objects  (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

Notifies listeners of the completion of the receive_objects method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

### e_data_cal_respond_send_objects ()

    void                e_data_cal_respond_send_objects     (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const GSList *users,
                                                             const gchar *calobj);

Notifies listeners of the completion of the send_objects method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`users` : | List of users.
`calobj` : | An iCalendar string representing the object sent.

### e_data_cal_respond_get_attachment_uris ()

    void                e_data_cal_respond_get_attachment_uris
                                                            (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const GSList *attachments);

Notifies listeners of the completion of the get_attachment_uris method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

### e_data_cal_respond_discard_alarm ()

    void                e_data_cal_respond_discard_alarm    (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

Notifies listeners of the completion of the discard_alarm method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.

### e_data_cal_respond_get_view ()

    void                e_data_cal_respond_get_view         (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *view_path);

Notifies listeners of the completion of the get_view method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`view_path` : | The new live view path.

### e_data_cal_respond_get_timezone ()

    void                e_data_cal_respond_get_timezone     (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error,
                                                             const gchar *tzobject);

Notifies listeners of the completion of the get_timezone method call.

`cal` : | A calendar client interface.
`error` : | Operation error, if any, automatically freed if passed it.
`tzobject` : | The requested timezone as an iCalendar string.

### e_data_cal_respond_add_timezone ()

    void                e_data_cal_respond_add_timezone     (EDataCal *cal,
                                                             guint32 opid,
                                                             GError *error);

### e_data_cal_report_error ()

    void                e_data_cal_report_error             (EDataCal *cal,
                                                             const gchar *message);

### e_data_cal_report_readonly ()

    void                e_data_cal_report_readonly          (EDataCal *cal,
                                                             gboolean is_readonly);

### e_data_cal_report_online ()

    void                e_data_cal_report_online            (EDataCal *cal,
                                                             gboolean is_online);

### e_data_cal_report_auth_required ()

    void                e_data_cal_report_auth_required     (EDataCal *cal,
                                                             const ECredentials *credentials);

### e_data_cal_report_opened ()

    void                e_data_cal_report_opened            (EDataCal *cal,
                                                             const GError *error);

### e_data_cal_report_free_busy_data ()

    void                e_data_cal_report_free_busy_data    (EDataCal *cal,
                                                             const GSList *freebusy);