struct ECal

struct ECal;

E_CAL_SET_MODE_STATUS_ENUM_TYPE

#define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())

CAL_MODE_ENUM_TYPE

#define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())

enum ECalSetModeStatus

typedef enum {
	E_CAL_SET_MODE_SUCCESS,
	E_CAL_SET_MODE_ERROR,
	E_CAL_SET_MODE_NOT_SUPPORTED
} ECalSetModeStatus;

enum ECalLoadState

typedef enum {
	E_CAL_LOAD_NOT_LOADED,
	E_CAL_LOAD_AUTHENTICATING,
	E_CAL_LOAD_LOADING,
	E_CAL_LOAD_LOADED
} ECalLoadState;

ECalAuthFunc ()

char*       (*ECalAuthFunc)                 (ECal *ecal,
                                             const char *prompt,
                                             const char *key,
                                             gpointer user_data);

e_cal_open_status_enum_get_type ()

GType       e_cal_open_status_enum_get_type (void);

e_cal_set_mode_status_enum_get_type ()

GType       e_cal_set_mode_status_enum_get_type
                                            (void);

cal_mode_enum_get_type ()

GType       cal_mode_enum_get_type          (void);

e_cal_new ()

ECal*       e_cal_new                       (ESource *source,
                                             ECalSourceType type);

Creates a new calendar ecal. It should be initialized by calling e_cal_open().

e_cal_set_auth_func ()

void        e_cal_set_auth_func             (ECal *ecal,
                                             ECalAuthFunc func,
                                             gpointer data);

Sets the given authentication function on the calendar ecal. This function will be called any time the calendar server needs a password for an operation associated with the calendar and should be supplied before any calendar is opened.

When a calendar is opened asynchronously, the open function is processed in a concurrent thread. This means that the authentication function will also be called from this thread. As such, the authentication callback cannot directly call any functions that must be called from the main thread. For example any Gtk+ related functions, which must be proxied synchronously to the main thread by the callback.

The authentication function has the following signature (ECalAuthFunc): char * auth_func (ECal *ecal, const gchar *prompt, const gchar *key, gpointer user_data)

e_cal_open ()

gboolean    e_cal_open                      (ECal *ecal,
                                             gboolean only_if_exists,
                                             GError **error);

Makes a calendar ecal initiate a request to open a calendar. The calendar ecal will emit the "cal_opened" signal when the response from the server is received.

e_cal_open_async ()

void        e_cal_open_async                (ECal *ecal,
                                             gboolean only_if_exists);

Open the calendar asynchronously. The calendar will emit the "cal_opened" signal when the operation has completed.

Because this operation runs in another thread, any authentication callback set on the calendar will be called from this other thread. See e_cal_set_auth_func() for details.

e_cal_uri_list ()

GList*      e_cal_uri_list                  (ECal *ecal,
                                             CalMode mode);

e_cal_get_load_state ()

ECalLoadState e_cal_get_load_state          (ECal *ecal);

Queries the state of loading of a calendar ecal.

e_cal_get_uri ()

const char* e_cal_get_uri                   (ECal *ecal);

Queries the URI that is open in a calendar ecal.

e_cal_is_read_only ()

gboolean    e_cal_is_read_only              (ECal *ecal,
                                             gboolean *read_only,
                                             GError **error);

Queries whether the calendar ecal can perform modifications on the calendar or not. Whether the backend is read only or not is specified, on exit, in the read_only argument.

e_cal_get_cal_address ()

gboolean    e_cal_get_cal_address           (ECal *ecal,
                                             char **cal_address,
                                             GError **error);

Queries the calendar address associated with a calendar ecal.

e_cal_get_alarm_email_address ()

gboolean    e_cal_get_alarm_email_address   (ECal *ecal,
                                             char **alarm_address,
                                             GError **error);

e_cal_get_ldap_attribute ()

gboolean    e_cal_get_ldap_attribute        (ECal *ecal,
                                             char **ldap_attribute,
                                             GError **error);

e_cal_get_one_alarm_only ()

gboolean    e_cal_get_one_alarm_only        (ECal *ecal);

e_cal_get_organizer_must_attend ()

gboolean    e_cal_get_organizer_must_attend (ECal *ecal);

e_cal_get_save_schedules ()

gboolean    e_cal_get_save_schedules        (ECal *ecal);

e_cal_get_static_capability ()

gboolean    e_cal_get_static_capability     (ECal *ecal,
                                             const char *cap);

e_cal_set_mode ()

gboolean    e_cal_set_mode                  (ECal *ecal,
                                             CalMode mode);

e_cal_get_default_object ()

gboolean    e_cal_get_default_object        (ECal *ecal,
                                             icalcomponent **icalcomp,
                                             GError **error);

e_cal_get_object ()

gboolean    e_cal_get_object                (ECal *ecal,
                                             const char *uid,
                                             const char *rid,
                                             icalcomponent **icalcomp,
                                             GError **error);

Queries a calendar for a calendar component object based on its unique identifier.

e_cal_get_changes ()

gboolean    e_cal_get_changes               (ECal *ecal,
                                             const char *change_id,
                                             GList **changes,
                                             GError **error);

e_cal_free_change_list ()

void        e_cal_free_change_list          (GList *list);

e_cal_get_object_list ()

gboolean    e_cal_get_object_list           (ECal *ecal,
                                             const char *query,
                                             GList **objects,
                                             GError **error);

e_cal_get_object_list_as_comp ()

gboolean    e_cal_get_object_list_as_comp   (ECal *ecal,
                                             const char *query,
                                             GList **objects,
                                             GError **error);

e_cal_free_object_list ()

void        e_cal_free_object_list          (GList *objects);

e_cal_get_free_busy ()

gboolean    e_cal_get_free_busy             (ECal *ecal,
                                             GList *users,
                                             time_t start,
                                             time_t end,
                                             GList **freebusy,
                                             GError **error);

Gets free/busy information from the calendar server.

e_cal_generate_instances ()

void        e_cal_generate_instances        (ECal *ecal,
                                             time_t start,
                                             time_t end,
                                             ECalRecurInstanceFn cb,
                                             gpointer cb_data);

Does a combination of e_cal_get_object_list() and cal_recur_generate_instances().

The callback function should do a g_object_ref() of the calendar component it gets passed if it intends to keep it around.

e_cal_get_alarms_in_range ()

GSList*     e_cal_get_alarms_in_range       (ECal *ecal,
                                             time_t start,
                                             time_t end);

Queries a calendar for the alarms that trigger in the specified range of time.

e_cal_free_alarms ()

void        e_cal_free_alarms               (GSList *comp_alarms);

Frees a list of ECalComponentAlarms structures as returned by e_cal_get_alarms_in_range().

e_cal_get_alarms_for_object ()

gboolean    e_cal_get_alarms_for_object     (ECal *ecal,
                                             const char *uid,
                                             time_t start,
                                             time_t end,
                                             ECalComponentAlarms **alarms);

Queries a calendar for the alarms of a particular object that trigger in the specified range of time.

e_cal_create_object ()

gboolean    e_cal_create_object             (ECal *ecal,
                                             icalcomponent *icalcomp,
                                             char **uid,
                                             GError **error);

e_cal_modify_object ()

gboolean    e_cal_modify_object             (ECal *ecal,
                                             icalcomponent *icalcomp,
                                             CalObjModType mod,
                                             GError **error);

e_cal_remove_object ()

gboolean    e_cal_remove_object             (ECal *ecal,
                                             const char *uid,
                                             GError **error);

Asks a calendar to remove a component. If the server is able to remove the component, all ecals will be notified and they will emit the "obj_removed" signal.

e_cal_remove_object_with_mod ()

gboolean    e_cal_remove_object_with_mod    (ECal *ecal,
                                             const char *uid,
                                             const char *rid,
                                             CalObjModType mod,
                                             GError **error);

e_cal_discard_alarm ()

gboolean    e_cal_discard_alarm             (ECal *ecal,
                                             ECalComponent *comp,
                                             const char *auid,
                                             GError **error);

Tells the calendar backend to get rid of the alarm identified by the auid argument in comp. Some backends might remove the alarm or update internal information about the alarm be discarded, or, like the file backend does, ignore the operation.

e_cal_receive_objects ()

gboolean    e_cal_receive_objects           (ECal *ecal,
                                             icalcomponent *icalcomp,
                                             GError **error);

Makes the backend receive the set of iCalendar objects specified in the icalcomp argument. This is used for iTIP confirmation/cancellation messages for scheduled meetings.

e_cal_send_objects ()

gboolean    e_cal_send_objects              (ECal *ecal,
                                             icalcomponent *icalcomp,
                                             GList **users,
                                             icalcomponent **modified_icalcomp,
                                             GError **error);

e_cal_get_timezone ()

gboolean    e_cal_get_timezone              (ECal *ecal,
                                             const char *tzid,
                                             icaltimezone **zone,
                                             GError **error);

e_cal_add_timezone ()

gboolean    e_cal_add_timezone              (ECal *ecal,
                                             icaltimezone *izone,
                                             GError **error);

Add a VTIMEZONE object to the given calendar.

e_cal_set_default_timezone ()

gboolean    e_cal_set_default_timezone      (ECal *ecal,
                                             icaltimezone *zone,
                                             GError **error);

e_cal_get_query ()

gboolean    e_cal_get_query                 (ECal *ecal,
                                             const char *sexp,
                                             ECalView **query,
                                             GError **error);

Creates a live query object from a loaded calendar.

e_cal_resolve_tzid_cb ()

icaltimezone* e_cal_resolve_tzid_cb         (const char *tzid,
                                             gpointer data);

e_cal_get_component_as_string ()

char*       e_cal_get_component_as_string   (ECal *ecal,
                                             icalcomponent *icalcomp);

Gets a calendar component as an iCalendar string, with a toplevel VCALENDAR component and all VTIMEZONEs needed for the component.

e_cal_get_error_message ()

const char* e_cal_get_error_message         (ECalendarStatus status);

Get an error message for the given status code.

The "backend-died" signal

void        user_function                  (ECal *ecal,
                                            gpointer user_data);

The "backend-error" signal

void        user_function                  (ECal *ecal,
                                            gchar *arg1,
                                            gpointer user_data);

The "cal-opened" signal

void        user_function                  (ECal *ecal,
                                            gint arg1,
                                            gpointer user_data);

The "cal-set-mode" signal

void        user_function                  (ECal *ecal,
                                            ECalSetModeStatusEnum arg1,
                                            CalModeEnum arg2,
                                            gpointer user_data);

The "categories-changed" signal

void        user_function                  (ECal *ecal,
                                            gpointer arg1,
                                            gpointer user_data);