## 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)
    EDataCal *          e_data_cal_new                      (ECalBackend *backend,
                                                             ESource *source);
    guint               e_data_cal_register_gdbus_object    (EDataCal *cal,
                                                             GDBusConnection *connection,
                                                             const gchar *object_path,
                                                             GError **error);
    ECalBackend *       e_data_cal_get_backend              (EDataCal *cal);
    ESource*            e_data_cal_get_source               (EDataCal *cal);
    void                e_data_cal_notify_read_only         (EDataCal *cal,
                                                             GError *error,
                                                             gboolean read_only);
    void                e_data_cal_notify_cal_address       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *address);
    void                e_data_cal_notify_alarm_email_address
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *address);
    void                e_data_cal_notify_ldap_attribute    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *attribute);
    void                e_data_cal_notify_static_capabilities
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *capabilities);
    void                e_data_cal_notify_open              (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);
    void                e_data_cal_notify_refresh           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);
    void                e_data_cal_notify_remove            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);
    void                e_data_cal_notify_object_created    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *uid,
                                                             const gchar *object);
    void                e_data_cal_notify_object_modified   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *old_object,
                                                             const gchar *object);
    void                e_data_cal_notify_object_removed    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const ECalComponentId *id,
                                                             const gchar *old_object,
                                                             const gchar *object);
    void                e_data_cal_notify_alarm_discarded   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);
    void                e_data_cal_notify_objects_received  (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);
    void                e_data_cal_notify_objects_sent      (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *users,
                                                             const gchar *calobj);
    void                e_data_cal_notify_default_object    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *object);
    void                e_data_cal_notify_object            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *object);
    void                e_data_cal_notify_object_list       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *objects);
    void                e_data_cal_notify_query             (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *query_path);
    void                e_data_cal_notify_timezone_requested
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *object);
    void                e_data_cal_notify_timezone_added    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *tzid);
    void                e_data_cal_notify_default_timezone_set
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);
    void                e_data_cal_notify_changes           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *adds,
                                                             GList *modifies,
                                                             GList *deletes);
    void                e_data_cal_notify_free_busy         (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *freebusy);
    void                e_data_cal_notify_mode              (EDataCal *cal,
                                                             EDataCalViewListenerSetModeStatus status,
                                                             EDataCalMode mode);
    void                e_data_cal_notify_auth_required     (EDataCal *cal);
    void                e_data_cal_notify_error             (EDataCal *cal,
                                                             const gchar *message);
    void                e_data_cal_notify_attachment_list   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GSList *objects);

## 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);

`status` : | EDataCalStatus code
`custom_msg` : | Custom message to use for the error. When NULL, then uses a default message based on the `status` code.
Returns : | NULL, when the `status` is Success, or a newly allocated GError, which should be freed with `g_error_free()` call.

Since 2.32

### e_data_cal_create_error_fmt ()

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

Similar as `e_data_cal_create_error()`, only here, instead of custom_msg, is used a `printf()` format to create a custom_msg for the error.

`status` : |
`custom_msg_fmt` : |
`...` : |
Returns : |

Since 2.32

### e_data_cal_status_to_string ()

    const gchar *       e_data_cal_status_to_string         (EDataCalCallStatus status);

`status` : |
Returns : |

Since 2.32

### e_return_data_cal_error_if_fail()

    #define             e_return_data_cal_error_if_fail(expr, _code)

`expr` : |
`_code` : |

Since 2.32

### e_data_cal_new ()

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

`backend` : |
`source` : |
Returns : |

### 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.

`cal` : |
`connection` : |
`object_path` : |
`error` : |
Returns : |

Since 2.32

### e_data_cal_get_backend ()

    ECalBackend *       e_data_cal_get_backend              (EDataCal *cal);

`cal` : |
Returns : |

### 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_notify_read_only ()

    void                e_data_cal_notify_read_only         (EDataCal *cal,
                                                             GError *error,
                                                             gboolean read_only);

Notifies listeners of the completion of the is_read_only method call.

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

### e_data_cal_notify_cal_address ()

    void                e_data_cal_notify_cal_address       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *address);

Notifies listeners of the completion of the get_cal_address method call.

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

### e_data_cal_notify_alarm_email_address ()

    void                e_data_cal_notify_alarm_email_address
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *address);

Notifies listeners of the completion of the get_alarm_email_address method call.

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

### e_data_cal_notify_ldap_attribute ()

    void                e_data_cal_notify_ldap_attribute    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *attribute);

Notifies listeners of the completion of the get_ldap_attribute method call.

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

### e_data_cal_notify_static_capabilities ()

    void                e_data_cal_notify_static_capabilities
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *capabilities);

Notifies listeners of the completion of the get_static_capabilities method call.

`cal` : | A calendar client interface.
`context` : |
`error` : | Operation error, if any, automatically freed if passed it.
`capabilities` : | Static capabilities from the backend.

### e_data_cal_notify_open ()

    void                e_data_cal_notify_open              (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);

Notifies listeners of the completion of the open method call.

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

### e_data_cal_notify_refresh ()

    void                e_data_cal_notify_refresh           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);

Notifies listeners of the completion of the refresh method call.

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

Since 2.30

### e_data_cal_notify_remove ()

    void                e_data_cal_notify_remove            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);

Notifies listeners of the completion of the remove method call.

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

### e_data_cal_notify_object_created ()

    void                e_data_cal_notify_object_created    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *uid,
                                                             const gchar *object);

Notifies listeners of the completion of the create_object method call.

`cal` : | A calendar client interface.
`context` : |
`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_notify_object_modified ()

    void                e_data_cal_notify_object_modified   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             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.
`context` : |
`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_notify_object_removed ()

    void                e_data_cal_notify_object_removed    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             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.
`context` : |
`error` : | Operation error, if any, automatically freed if passed it.
`id` : |
`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_notify_alarm_discarded ()

    void                e_data_cal_notify_alarm_discarded   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);

Notifies listeners of the completion of the discard_alarm method call.

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

### e_data_cal_notify_objects_received ()

    void                e_data_cal_notify_objects_received  (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);

Notifies listeners of the completion of the receive_objects method call.

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

### e_data_cal_notify_objects_sent ()

    void                e_data_cal_notify_objects_sent      (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *users,
                                                             const gchar *calobj);

Notifies listeners of the completion of the send_objects method call.

`cal` : | A calendar client interface.
`context` : |
`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_notify_default_object ()

    void                e_data_cal_notify_default_object    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *object);

Notifies listeners of the completion of the get_default_object method call.

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

### e_data_cal_notify_object ()

    void                e_data_cal_notify_object            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *object);

Notifies listeners of the completion of the get_object method call.

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

### e_data_cal_notify_object_list ()

    void                e_data_cal_notify_object_list       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *objects);

Notifies listeners of the completion of the get_object_list method call.

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

### e_data_cal_notify_query ()

    void                e_data_cal_notify_query             (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *query_path);

`cal` : |
`context` : |
`error` : |
`query_path` : |

### e_data_cal_notify_timezone_requested ()

    void                e_data_cal_notify_timezone_requested
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *object);

Notifies listeners of the completion of the get_timezone method call.

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

### e_data_cal_notify_timezone_added ()

    void                e_data_cal_notify_timezone_added    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             const gchar *tzid);

Notifies listeners of the completion of the add_timezone method call.

`cal` : | A calendar client interface.
`context` : |
`error` : | Operation error, if any, automatically freed if passed it.
`tzid` : | ID of the added timezone.

### e_data_cal_notify_default_timezone_set ()

    void                e_data_cal_notify_default_timezone_set
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error);

Notifies listeners of the completion of the set_default_timezone method call.

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

### e_data_cal_notify_changes ()

    void                e_data_cal_notify_changes           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *adds,
                                                             GList *modifies,
                                                             GList *deletes);

Notifies listeners of the completion of the get_changes method call.

`cal` : | A calendar client interface.
`context` : |
`error` : | Operation error, if any, automatically freed if passed it.
`adds` : | List of additions.
`modifies` : | List of modifications.
`deletes` : | List of removals.

### e_data_cal_notify_free_busy ()

    void                e_data_cal_notify_free_busy         (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GList *freebusy);

Notifies listeners of the completion of the get_free_busy method call.

`cal` : | A calendar client interface.
`context` : |
`error` : | Operation error, if any, automatically freed if passed it.
`freebusy` : | List of free/busy objects.

### e_data_cal_notify_mode ()

    void                e_data_cal_notify_mode              (EDataCal *cal,
                                                             EDataCalViewListenerSetModeStatus status,
                                                             EDataCalMode mode);

Notifies the listener of the results of a set_mode call.

`cal` : | A calendar client interface.
`status` : | Status of the mode set.
`mode` : | The current mode.

### e_data_cal_notify_auth_required ()

    void                e_data_cal_notify_auth_required     (EDataCal *cal);

Notifies listeners that authorization is required to open the calendar.

`cal` : | A calendar client interface.

### e_data_cal_notify_error ()

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

Notify a calendar client of an error occurred in the backend.

`cal` : | A calendar client interface.
`message` : | Error message.

### e_data_cal_notify_attachment_list ()

    void                e_data_cal_notify_attachment_list   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             GError *error,
                                                             GSList *objects);

Notifies listeners of the completion of the get_attachment_list method call.+ */ void e_data_cal_notify_attachment_list (EDataCal *cal, EServerMethodContext context, GError *error, GSList *attachments) { GDBusMethodInvocation *invocation = context; gchar **seq;

seq = create_str_array_from_gslist (attachments);

if (error) { /* Translators: The '`s`' is replaced with a detailed error message */ data_cal_return_error (invocation, error, _("Could not retrieve attachment list: `s`")); g_error_free (error); } else e_gdbus_cal_complete_get_attachment_list (cal->priv->gdbus_object, invocation, (const gchar * const *) seq);

g_free (seq); }

/** e_data_cal_notify_query: `cal`: A calendar client interface. `error`: Operation error, if any, automatically freed if passed it. `query`: The new live query.

Notifies listeners of the completion of the get_query method call.

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