![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Calendar Client (libecal) | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
struct ECalClient; #define CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS #define CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS #define CAL_BACKEND_PROPERTY_DEFAULT_OBJECT enum ECalClientSourceType; #define E_CAL_CLIENT_ERROR enum ECalClientError; const gchar * e_cal_client_error_to_string (ECalClientError code
); GError * e_cal_client_error_create (ECalClientError code
,const gchar *custom_msg
); ECalClient * e_cal_client_new (ESource *source
,ECalClientSourceType source_type
,GError **error
); ECalClient * e_cal_client_new_from_uri (const gchar *uri
,ECalClientSourceType source_type
,GError **error
); ECalClient * e_cal_client_new_system (ECalClientSourceType source_type
,GError **error
); ECalClient * e_cal_client_new_default (ECalClientSourceType source_type
,GError **error
); gboolean e_cal_client_set_default (ECalClient *client
,GError **error
); gboolean e_cal_client_set_default_source (ESource *source
,ECalClientSourceType source_type
,GError **error
); gboolean e_cal_client_get_sources (ESourceList **sources
,ECalClientSourceType source_type
,GError **error
); ECalClientSourceType e_cal_client_get_source_type (ECalClient *client
); const gchar * e_cal_client_get_local_attachment_store (ECalClient *client
); void e_cal_client_set_default_timezone (ECalClient *client
,icaltimezone *zone
); icaltimezone * e_cal_client_get_default_timezone (ECalClient *client
); gboolean e_cal_client_check_one_alarm_only (ECalClient *client
); gboolean e_cal_client_check_save_schedules (ECalClient *client
); gboolean e_cal_client_check_organizer_must_attend (ECalClient *client
); gboolean e_cal_client_check_organizer_must_accept (ECalClient *client
); gboolean e_cal_client_check_recurrences_no_master (ECalClient *client
); void e_cal_client_free_icalcomp_slist (GSList *icalcomps
); void e_cal_client_free_ecalcomp_slist (GSList *ecalcomps
); icaltimezone * e_cal_client_resolve_tzid_cb (const gchar *tzid
,gpointer data
); void e_cal_client_generate_instances (ECalClient *client
,time_t start
,time_t end
,ECalRecurInstanceFn cb
,gpointer cb_data
); void e_cal_client_generate_instances_for_object (ECalClient *client
,icalcomponent *icalcomp
,time_t start
,time_t end
,ECalRecurInstanceFn cb
,gpointer cb_data
); gchar * e_cal_client_get_component_as_string (ECalClient *client
,icalcomponent *icalcomp
); void e_cal_client_get_default_object (ECalClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_default_object_finish (ECalClient *client
,GAsyncResult *result
,icalcomponent **icalcomp
,GError **error
); gboolean e_cal_client_get_default_object_sync (ECalClient *client
,icalcomponent **icalcomp
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_object (ECalClient *client
,const gchar *uid
,const gchar *rid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_object_finish (ECalClient *client
,GAsyncResult *result
,icalcomponent **icalcomp
,GError **error
); gboolean e_cal_client_get_object_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,icalcomponent **icalcomp
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_objects_for_uid (ECalClient *client
,const gchar *uid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_objects_for_uid_finish (ECalClient *client
,GAsyncResult *result
,GSList **ecalcomps
,GError **error
); gboolean e_cal_client_get_objects_for_uid_sync (ECalClient *client
,const gchar *uid
,GSList **ecalcomps
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_object_list (ECalClient *client
,const gchar *sexp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_object_list_finish (ECalClient *client
,GAsyncResult *result
,GSList **icalcomps
,GError **error
); gboolean e_cal_client_get_object_list_sync (ECalClient *client
,const gchar *sexp
,GSList **icalcomps
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_object_list_as_comps (ECalClient *client
,const gchar *sexp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_object_list_as_comps_finish (ECalClient *client
,GAsyncResult *result
,GSList **ecalcomps
,GError **error
); gboolean e_cal_client_get_object_list_as_comps_sync (ECalClient *client
,const gchar *sexp
,GSList **ecalcomps
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_free_busy (ECalClient *client
,time_t start
,time_t end
,const GSList *users
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_free_busy_finish (ECalClient *client
,GAsyncResult *result
,GError **error
); gboolean e_cal_client_get_free_busy_sync (ECalClient *client
,time_t start
,time_t end
,const GSList *users
,GCancellable *cancellable
,GError **error
); void e_cal_client_create_object (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_create_object_finish (ECalClient *client
,GAsyncResult *result
,gchar **uid
,GError **error
); gboolean e_cal_client_create_object_sync (ECalClient *client
,icalcomponent *icalcomp
,gchar **uid
,GCancellable *cancellable
,GError **error
); void e_cal_client_modify_object (ECalClient *client
,icalcomponent *icalcomp
,CalObjModType mod
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_modify_object_finish (ECalClient *client
,GAsyncResult *result
,GError **error
); gboolean e_cal_client_modify_object_sync (ECalClient *client
,icalcomponent *icalcomp
,CalObjModType mod
,GCancellable *cancellable
,GError **error
); void e_cal_client_remove_object (ECalClient *client
,const gchar *uid
,const gchar *rid
,CalObjModType mod
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_remove_object_finish (ECalClient *client
,GAsyncResult *result
,GError **error
); gboolean e_cal_client_remove_object_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,CalObjModType mod
,GCancellable *cancellable
,GError **error
); void e_cal_client_receive_objects (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_receive_objects_finish (ECalClient *client
,GAsyncResult *result
,GError **error
); gboolean e_cal_client_receive_objects_sync (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GError **error
); void e_cal_client_send_objects (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_send_objects_finish (ECalClient *client
,GAsyncResult *result
,GSList **users
,icalcomponent **modified_icalcomp
,GError **error
); gboolean e_cal_client_send_objects_sync (ECalClient *client
,icalcomponent *icalcomp
,GSList **users
,icalcomponent **modified_icalcomp
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_attachment_uris (ECalClient *client
,const gchar *uid
,const gchar *rid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_attachment_uris_finish (ECalClient *client
,GAsyncResult *result
,GSList **attachment_uris
,GError **error
); gboolean e_cal_client_get_attachment_uris_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,GSList **attachment_uris
,GCancellable *cancellable
,GError **error
); void e_cal_client_discard_alarm (ECalClient *client
,const gchar *uid
,const gchar *rid
,const gchar *auid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_discard_alarm_finish (ECalClient *client
,GAsyncResult *result
,GError **error
); gboolean e_cal_client_discard_alarm_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,const gchar *auid
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_view (ECalClient *client
,const gchar *sexp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_view_finish (ECalClient *client
,GAsyncResult *result
,ECalClientView **view
,GError **error
); gboolean e_cal_client_get_view_sync (ECalClient *client
,const gchar *sexp
,ECalClientView **view
,GCancellable *cancellable
,GError **error
); void e_cal_client_get_timezone (ECalClient *client
,const gchar *tzid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_get_timezone_finish (ECalClient *client
,GAsyncResult *result
,icaltimezone **zone
,GError **error
); gboolean e_cal_client_get_timezone_sync (ECalClient *client
,const gchar *tzid
,icaltimezone **zone
,GCancellable *cancellable
,GError **error
); void e_cal_client_add_timezone (ECalClient *client
,icaltimezone *zone
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean e_cal_client_add_timezone_finish (ECalClient *client
,GAsyncResult *result
,GError **error
); gboolean e_cal_client_add_timezone_sync (ECalClient *client
,icaltimezone *zone
,GCancellable *cancellable
,GError **error
);
#define CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS "cal-email-address"
#define CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS "alarm-email-address"
typedef enum { E_CAL_CLIENT_SOURCE_TYPE_EVENTS, E_CAL_CLIENT_SOURCE_TYPE_TASKS, E_CAL_CLIENT_SOURCE_TYPE_MEMOS, E_CAL_CLIENT_SOURCE_TYPE_LAST } ECalClientSourceType;
typedef enum { E_CAL_CLIENT_ERROR_NO_SUCH_CALENDAR, E_CAL_CLIENT_ERROR_OBJECT_NOT_FOUND, E_CAL_CLIENT_ERROR_INVALID_OBJECT, E_CAL_CLIENT_ERROR_UNKNOWN_USER, E_CAL_CLIENT_ERROR_OBJECT_ID_ALREADY_EXISTS, E_CAL_CLIENT_ERROR_INVALID_RANGE } ECalClientError;
GError * e_cal_client_error_create (ECalClientError code
,const gchar *custom_msg
);
|
an ECalClientError code to create |
|
custom message to use for the error; can be NULL
|
Returns : |
a new GError containing an E_CAL_CLIENT_ERROR of the given
code . If the custom_msg is NULL, then the error message is
the one returned from e_cal_client_error_to_string() for the code ,
otherwise the given message is used.
Returned pointer should be freed with g_error_free() . |
ECalClient * e_cal_client_new (ESource *source
,ECalClientSourceType source_type
,GError **error
);
Creates a new ECalClient corresponding to the given source. There are
only two operations that are valid on this calendar at this point:
e_client_open()
, and e_client_remove()
.
|
An ESource pointer |
|
source type of the calendar |
|
A GError pointer |
Returns : |
a new but unopened ECalClient. |
Since 3.2
ECalClient * e_cal_client_new_from_uri (const gchar *uri
,ECalClientSourceType source_type
,GError **error
);
Creates a new ECalClient corresponding to the given uri. See the
documentation for e_cal_client_new()
for further information.
|
the URI to load |
|
source type of the calendar |
|
A GError pointer |
Returns : |
a new but unopened ECalClient. |
Since 3.2
ECalClient * e_cal_client_new_system (ECalClientSourceType source_type
,GError **error
);
Creates a new ECalClient corresponding to the user's system
calendar. See the documentation for e_cal_client_new()
for further
information.
|
source type of the calendar |
|
A GError pointer |
Returns : |
a new but unopened ECalClient. |
Since 3.2
ECalClient * e_cal_client_new_default (ECalClientSourceType source_type
,GError **error
);
Creates a new ECalClient corresponding to the user's default
calendar. See the documentation for e_cal_client_new()
for
further information.
|
source type of the calendar |
|
return location for a GError, or NULL
|
Returns : |
a new but unopened ECalClient |
Since 3.2
gboolean e_cal_client_set_default (ECalClient *client
,GError **error
);
Sets the ESource of the ECalClient as the "default" calendar. This is the source
that will be loaded in the e_cal_client_get_default_calendar()
call.
|
An ECalClient pointer |
|
A GError pointer |
Returns : |
TRUE if the setting was stored in libecal's ESourceList, otherwise FALSE . |
Since 3.2
gboolean e_cal_client_set_default_source (ESource *source
,ECalClientSourceType source_type
,GError **error
);
Sets source
as the "default" calendar. This is the source that
will be loaded in the e_cal_client_get_default_calendar()
call.
|
An ESource pointer |
|
source type of the calendar |
|
A GError pointer |
Returns : |
TRUE if the setting was stored in libecal's ESourceList, otherwise FALSE . |
Since 3.2
gboolean e_cal_client_get_sources (ESourceList **sources
,ECalClientSourceType source_type
,GError **error
);
Populate @*sources with the list of all sources which have been added to Evolution.
|
A pointer to an ESourceList to set. [out] |
|
source type of calendars |
|
A pointer to a GError to set on error |
Returns : |
TRUE if sources was set, otherwise FALSE . |
Since 3.2
ECalClientSourceType e_cal_client_get_source_type (ECalClient *client
);
Gets the source type of the calendar client.
|
A calendar client. |
Returns : |
an ECalClientSourceType value corresponding to the source type of the calendar client. |
Since 3.2
const gchar * e_cal_client_get_local_attachment_store
(ECalClient *client
);
Queries the URL where the calendar attachments are serialized in the local filesystem. This enable clients to operate with the reference to attachments rather than the data itself unless it specifically uses the attachments for open/sending operations.
|
A calendar client. |
Returns : |
The URL where the attachments are serialized in the local filesystem. |
Since 3.2
void e_cal_client_set_default_timezone (ECalClient *client
,icaltimezone *zone
);
Sets the default timezone to use to resolve DATE and floating DATE-TIME values. This will typically be from the user's timezone setting. Call this before using any other object fetching functions.
|
A calendar client. |
|
A timezone object. |
Since 3.2
icaltimezone * e_cal_client_get_default_timezone (ECalClient *client
);
|
A calendar client. |
Returns : |
Default timezone previously set with e_cal_client_set_default_timezone() .
Returned pointer is owned by the client and should not be freed. |
Since 3.2
gboolean e_cal_client_check_one_alarm_only (ECalClient *client
);
Checks if a calendar supports only one alarm per component.
|
A calendar client. |
Returns : |
TRUE if the calendar allows only one alarm, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_check_save_schedules (ECalClient *client
);
Checks whether the calendar saves schedules.
|
A calendar client. |
Returns : |
TRUE if it saves schedules, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_check_organizer_must_attend
(ECalClient *client
);
Checks if a calendar forces organizers of meetings to be also attendees.
|
A calendar client. |
Returns : |
TRUE if the calendar forces organizers to attend meetings, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_check_organizer_must_accept
(ECalClient *client
);
gboolean e_cal_client_check_recurrences_no_master
(ECalClient *client
);
Checks if the calendar has a master object for recurrences.
|
A calendar client. |
Returns : |
TRUE if the calendar has a master object for recurrences, FALSE otherwise. |
Since 3.2
void e_cal_client_free_icalcomp_slist (GSList *icalcomps
);
Frees each element of icalcomps
list and the list itself.
Each element is an object of icalcomponent type.
|
slist of icalcomponent objects |
Since 3.2
void e_cal_client_free_ecalcomp_slist (GSList *ecalcomps
);
Frees each element of ecalcomps
list and the list itself.
Each element is an object of ECalComponent type.
|
list of ECalComponent objects |
Since 3.2
icaltimezone * e_cal_client_resolve_tzid_cb (const gchar *tzid
,gpointer data
);
Resolves TZIDs for the recurrence generator.
|
ID of the timezone to resolve. |
|
Closure data for the callback, in this case ECalClient. |
Returns : |
The timezone identified by the tzid argument, or NULL if
it could not be found. |
void e_cal_client_generate_instances (ECalClient *client
,time_t start
,time_t end
,ECalRecurInstanceFn cb
,gpointer cb_data
);
Does a combination of #e_cal_client_get_object_list()
and
#e_cal_client_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, since it will be unref'ed
as soon as the callback returns.
|
A calendar client. |
|
Start time for query. |
|
End time for query. |
|
Callback for each generated instance. |
|
Closure data for the callback. |
void e_cal_client_generate_instances_for_object (ECalClient *client
,icalcomponent *icalcomp
,time_t start
,time_t end
,ECalRecurInstanceFn cb
,gpointer cb_data
);
Does a combination of #e_cal_client_get_object_list()
and
#e_cal_client_recur_generate_instances()
, like #e_cal_client_generate_instances()
, but
for a single object.
The callback function should do a g_object_ref()
of the calendar component
it gets passed if it intends to keep it around, since it will be unref'ed
as soon as the callback returns.
|
A calendar client. |
|
Object to generate instances from. |
|
Start time for query. |
|
End time for query. |
|
Callback for each generated instance. |
|
Closure data for the callback. |
gchar * e_cal_client_get_component_as_string (ECalClient *client
,icalcomponent *icalcomp
);
Gets a calendar component as an iCalendar string, with a toplevel VCALENDAR component and all VTIMEZONEs needed for the component.
|
A calendar client. |
|
A calendar component object. |
Returns : |
the component as a complete iCalendar string, or NULL on
failure. The string should be freed with g_free() . |
Since 3.2
void e_cal_client_get_default_object (ECalClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Retrives an icalcomponent from the backend that contains the default
values for properties needed. The call is finished
by e_cal_client_get_default_object_finish()
from the callback
.
|
an ECalClient |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_default_object_finish (ECalClient *client
,GAsyncResult *result
,icalcomponent **icalcomp
,GError **error
);
Finishes previous call of e_cal_client_get_default_object()
and
sets icalcomp
to an icalcomponent from the backend that contains
the default values for properties needed. This icalcomp
should be
freed with icalcomponent_free()
.
|
an ECalClient |
|
a GAsyncResult |
|
Return value for the default calendar object. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_default_object_sync (ECalClient *client
,icalcomponent **icalcomp
,GCancellable *cancellable
,GError **error
);
Retrives an icalcomponent from the backend that contains the default
values for properties needed. This icalcomp
should be freed with
icalcomponent_free()
.
|
an ECalClient |
|
Return value for the default calendar object. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_object (ECalClient *client
,const gchar *uid
,const gchar *rid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Queries a calendar for a calendar component object based on its unique
identifier. The call is finished by e_cal_client_get_object_finish()
from the callback
.
Use e_cal_client_get_objects_for_uid()
to get list of all
objects for the given uid, which includes master object and
all detached instances.
|
an ECalClient |
|
Unique identifier for a calendar component. |
|
Recurrence identifier. |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_object_finish (ECalClient *client
,GAsyncResult *result
,icalcomponent **icalcomp
,GError **error
);
Finishes previous call of e_cal_client_get_object()
and
sets icalcomp
to queried component. This function always returns
master object for a case of rid
being NULL or an empty string.
This component should be freed with icalcomponent_free()
.
Use e_cal_client_get_objects_for_uid()
to get list of all
objects for the given uid, which includes master object and
all detached instances.
|
an ECalClient |
|
a GAsyncResult |
|
Return value for the calendar component object. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_object_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,icalcomponent **icalcomp
,GCancellable *cancellable
,GError **error
);
Queries a calendar for a calendar component object based
on its unique identifier. This function always returns
master object for a case of rid
being NULL or an empty string.
This component should be freed with icalcomponent_free()
.
Use e_cal_client_get_objects_for_uid_sync()
to get list of all
objects for the given uid, which includes master object and
all detached instances.
|
an ECalClient |
|
Unique identifier for a calendar component. |
|
Recurrence identifier. |
|
Return value for the calendar component object. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_objects_for_uid (ECalClient *client
,const gchar *uid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Queries a calendar for all calendar components with the given unique
ID. This will return any recurring event and all its detached recurrences.
For non-recurring events, it will just return the object with that ID.
The call is finished by e_cal_client_get_objects_for_uid_finish()
from
the callback
.
|
an ECalClient |
|
Unique identifier for a calendar component |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_objects_for_uid_finish (ECalClient *client
,GAsyncResult *result
,GSList **ecalcomps
,GError **error
);
Finishes previous call of e_cal_client_get_objects_for_uid()
and
sets ecalcomps
to a list of ECalComponent-s corresponding to
found components for a given uid of the same type as this client.
This list should be freed with e_cal_client_free_ecalcomp_slist()
.
|
an ECalClient |
|
a GAsyncResult |
|
Return value for the list of objects obtained from the backend. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_objects_for_uid_sync (ECalClient *client
,const gchar *uid
,GSList **ecalcomps
,GCancellable *cancellable
,GError **error
);
Queries a calendar for all calendar components with the given unique
ID. This will return any recurring event and all its detached recurrences.
For non-recurring events, it will just return the object with that ID.
This list should be freed with e_cal_client_free_ecalcomp_slist()
.
|
an ECalClient |
|
Unique identifier for a calendar component |
|
Return value for the list of objects obtained from the backend. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_object_list (ECalClient *client
,const gchar *sexp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Gets a list of objects from the calendar that match the query specified
by the sexp
argument, returning matching objects as a list of icalcomponent-s.
The call is finished by e_cal_client_get_object_list_finish()
from
the callback
.
|
an ECalClient |
|
an S-expression representing the query |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_object_list_finish (ECalClient *client
,GAsyncResult *result
,GSList **icalcomps
,GError **error
);
Finishes previous call of e_cal_client_get_object_list()
and
sets icalcomps
to a matching list of icalcomponent-s.
This list should be freed with #e_cal_client_free_icalcomp_slist()
.
|
an ECalClient |
|
a GAsyncResult |
|
list of matching icalcomponent-s. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_object_list_sync (ECalClient *client
,const gchar *sexp
,GSList **icalcomps
,GCancellable *cancellable
,GError **error
);
Gets a list of objects from the calendar that match the query specified
by the sexp
argument. The objects will be returned in the icalcomps
argument, which is a list of icalcomponent.
This list should be freed with #e_cal_client_free_icalcomp_slist()
.
|
an ECalClient |
|
an S-expression representing the query |
|
list of matching icalcomponent-s. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_object_list_as_comps (ECalClient *client
,const gchar *sexp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Gets a list of objects from the calendar that match the query specified
by the sexp
argument, returning matching objects as a list of ECalComponent-s.
The call is finished by e_cal_client_get_object_list_as_comps_finish()
from
the callback
.
|
an ECalClient |
|
an S-expression representing the query |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_object_list_as_comps_finish (ECalClient *client
,GAsyncResult *result
,GSList **ecalcomps
,GError **error
);
Finishes previous call of e_cal_client_get_object_list_as_comps()
and
sets ecalcomps
to a matching list of ECalComponent-s.
This list should be freed with #e_cal_client_free_ecalcomp_slist()
.
|
an ECalClient |
|
a GAsyncResult |
|
list of matching ECalComponent-s. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_object_list_as_comps_sync (ECalClient *client
,const gchar *sexp
,GSList **ecalcomps
,GCancellable *cancellable
,GError **error
);
Gets a list of objects from the calendar that match the query specified
by the sexp
argument. The objects will be returned in the ecalcomps
argument, which is a list of ECalComponent.
This list should be freed with #e_cal_client_free_ecalcomp_slist()
.
|
an ECalClient |
|
an S-expression representing the query |
|
list of matching ECalComponent-s. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_free_busy (ECalClient *client
,time_t start
,time_t end
,const GSList *users
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Begins retrieval of free/busy information from the calendar server
as a list of ECalComponent-s. Connect to "free-busy-data" signal
to receive chunks of free/busy components.
The call is finished by e_cal_client_get_free_busy_finish()
from
the callback
.
|
an ECalClient |
|
Start time for query |
|
End time for query |
|
List of users to retrieve free/busy information for |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_free_busy_finish (ECalClient *client
,GAsyncResult *result
,GError **error
);
Finishes previous call of e_cal_client_get_free_busy()
.
All VFREEBUSY ECalComponent-s were received by "free-busy-data" signal.
|
an ECalClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_free_busy_sync (ECalClient *client
,time_t start
,time_t end
,const GSList *users
,GCancellable *cancellable
,GError **error
);
Gets free/busy information from the calendar server. All VFREEBUSY ECalComponent-s were received by "free-busy-data" signal.
|
an ECalClient |
|
Start time for query |
|
End time for query |
|
List of users to retrieve free/busy information for |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_create_object (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests the calendar backend to create the object specified by the icalcomp
argument. Some backends would assign a specific UID to the newly created object,
but this function does not modify the original icalcomp
if its UID changes.
The call is finished by e_cal_client_create_object_finish()
from
the callback
.
|
an ECalClient |
|
The component to create |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_create_object_finish (ECalClient *client
,GAsyncResult *result
,gchar **uid
,GError **error
);
Finishes previous call of e_cal_client_create_object()
and
sets uid
to newly assigned UID for the created object.
This uid
should be freed with g_free()
.
|
an ECalClient |
|
a GAsyncResult |
|
Return value for the UID assigned to the new component by the calendar backend. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_create_object_sync (ECalClient *client
,icalcomponent *icalcomp
,gchar **uid
,GCancellable *cancellable
,GError **error
);
Requests the calendar backend to create the object specified by the icalcomp
argument. Some backends would assign a specific UID to the newly created object,
in those cases that UID would be returned in the uid
argument. This function
does not modify the original icalcomp
if its UID changes.
Returned uid
should be freed with g_free()
.
|
an ECalClient |
|
The component to create |
|
Return value for the UID assigned to the new component by the calendar backend. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_modify_object (ECalClient *client
,icalcomponent *icalcomp
,CalObjModType mod
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests the calendar backend to modify an existing object. If the object does not exist on the calendar, an error will be returned.
For recurrent appointments, the mod
argument specifies what to modify,
if all instances (CALOBJ_MOD_ALL), a single instance (CALOBJ_MOD_THIS),
or a specific set of instances (CALOBJ_MOD_THISNADPRIOR and
CALOBJ_MOD_THISANDFUTURE).
The call is finished by e_cal_client_modify_object_finish()
from
the callback
.
|
an ECalClient |
|
Component to modify |
|
Type of modification |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_modify_object_finish (ECalClient *client
,GAsyncResult *result
,GError **error
);
Finishes previous call of e_cal_client_modify_object()
.
|
an ECalClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_modify_object_sync (ECalClient *client
,icalcomponent *icalcomp
,CalObjModType mod
,GCancellable *cancellable
,GError **error
);
Requests the calendar backend to modify an existing object. If the object does not exist on the calendar, an error will be returned.
For recurrent appointments, the mod
argument specifies what to modify,
if all instances (CALOBJ_MOD_ALL), a single instance (CALOBJ_MOD_THIS),
or a specific set of instances (CALOBJ_MOD_THISNADPRIOR and
CALOBJ_MOD_THISANDFUTURE).
|
an ECalClient |
|
Component to modify |
|
Type of modification |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_remove_object (ECalClient *client
,const gchar *uid
,const gchar *rid
,CalObjModType mod
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
This function allows the removal of instances of a recurrent
appointment. By using a combination of the uid
, rid
and mod
arguments, you can remove specific instances. If what you want
is to remove all instances, use NULL rid
and CALOBJ_MODE_THIS
for the mod
.
The call is finished by e_cal_client_remove_object_finish()
from
the callback
.
|
an ECalClient |
|
UID of the object to remove |
|
Recurrence ID of the specific recurrence to remove |
|
Type of the removal |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_remove_object_finish (ECalClient *client
,GAsyncResult *result
,GError **error
);
Finishes previous call of e_cal_client_remove_object()
.
|
an ECalClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_remove_object_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,CalObjModType mod
,GCancellable *cancellable
,GError **error
);
This function allows the removal of instances of a recurrent
appointment. By using a combination of the uid
, rid
and mod
arguments, you can remove specific instances. If what you want
is to remove all instances, use NULL rid
and CALOBJ_MODE_THIS
for the mod
.
|
an ECalClient |
|
UID of the object to remove |
|
Recurrence ID of the specific recurrence to remove |
|
Type of the removal |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_receive_objects (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
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.
The call is finished by e_cal_client_receive_objects_finish()
from
the callback
.
|
an ECalClient |
|
An icalcomponent |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_receive_objects_finish (ECalClient *client
,GAsyncResult *result
,GError **error
);
Finishes previous call of e_cal_client_receive_objects()
.
|
an ECalClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_receive_objects_sync (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,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.
|
an ECalClient |
|
An icalcomponent |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_send_objects (ECalClient *client
,icalcomponent *icalcomp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests a calendar backend to send meeting information stored in icalcomp
.
The backend can modify this component and request a send to particular users.
The call is finished by e_cal_client_send_objects_finish()
from
the callback
.
|
an ECalClient |
|
An icalcomponent to be sent |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_send_objects_finish (ECalClient *client
,GAsyncResult *result
,GSList **users
,icalcomponent **modified_icalcomp
,GError **error
);
Finishes previous call of e_cal_client_send_objects()
and
populates users
with a list of users to send modified_icalcomp
to.
The users
list should be freed with e_client_util_free_string_slist()
and
the modified_icalcomp
should be freed with icalcomponent_free()
.
|
an ECalClient |
|
a GAsyncResult |
|
List of users to send the modified_icalcomp to. [out]
|
|
Return value for the icalcomponent to be sent. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_send_objects_sync (ECalClient *client
,icalcomponent *icalcomp
,GSList **users
,icalcomponent **modified_icalcomp
,GCancellable *cancellable
,GError **error
);
Requests a calendar backend to send meeting information stored in icalcomp
.
The backend can modify this component and request a send to users in the users
list.
The users
list should be freed with e_client_util_free_string_slist()
and
the modified_icalcomp
should be freed with icalcomponent_free()
.
|
an ECalClient |
|
An icalcomponent to be sent |
|
List of users to send the modified_icalcomp to. [out]
|
|
Return value for the icalcomponent to be sent. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_attachment_uris (ECalClient *client
,const gchar *uid
,const gchar *rid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Queries a calendar for a specified component's object attachment uris.
The call is finished by e_cal_client_get_attachment_uris_finish()
from
the callback
.
|
an ECalClient |
|
Unique identifier for a calendar component |
|
Recurrence identifier |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_attachment_uris_finish (ECalClient *client
,GAsyncResult *result
,GSList **attachment_uris
,GError **error
);
Finishes previous call of e_cal_client_get_attachment_uris()
and
sets attachment_uris
to uris for component's attachments.
The list should be freed with e_client_util_free_string_slist()
.
|
an ECalClient |
|
a GAsyncResult |
|
(out:) Return the list of attachment uris |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_attachment_uris_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,GSList **attachment_uris
,GCancellable *cancellable
,GError **error
);
Queries a calendar for a specified component's object attachment uris.
The list should be freed with e_client_util_free_string_slist()
.
|
an ECalClient |
|
Unique identifier for a calendar component |
|
Recurrence identifier |
|
(out:) Return the list of attachment uris |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_discard_alarm (ECalClient *client
,const gchar *uid
,const gchar *rid
,const gchar *auid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Removes alarm auid
from a given component identified by uid
and rid
.
The call is finished by e_cal_client_discard_alarm_finish()
from
the callback
.
|
an ECalClient |
|
Unique identifier for a calendar component |
|
Recurrence identifier |
|
Alarm identifier to remove |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_discard_alarm_finish (ECalClient *client
,GAsyncResult *result
,GError **error
);
Finishes previous call of e_cal_client_discard_alarm()
.
|
an ECalClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_discard_alarm_sync (ECalClient *client
,const gchar *uid
,const gchar *rid
,const gchar *auid
,GCancellable *cancellable
,GError **error
);
Removes alarm auid
from a given component identified by uid
and rid
.
|
an ECalClient |
|
Unique identifier for a calendar component |
|
Recurrence identifier |
|
Alarm identifier to remove |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_view (ECalClient *client
,const gchar *sexp
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Query client
with sexp
, creating an ECalClientView.
The call is finished by e_cal_client_get_view_finish()
from the callback
.
|
an ECalClient |
|
an S-expression representing the query. |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_view_finish (ECalClient *client
,GAsyncResult *result
,ECalClientView **view
,GError **error
);
Finishes previous call of e_cal_client_get_view()
.
If successful, then the view
is set to newly allocated ECalClientView,
which should be freed with g_object_unref()
.
|
an ECalClient |
|
a GAsyncResult |
|
(out) an ECalClientView |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_view_sync (ECalClient *client
,const gchar *sexp
,ECalClientView **view
,GCancellable *cancellable
,GError **error
);
Query client
with sexp
, creating an ECalClientView.
If successful, then the view
is set to newly allocated ECalClientView,
which should be freed with g_object_unref()
.
|
an ECalClient |
|
an S-expression representing the query. |
|
(out) an ECalClientView |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_get_timezone (ECalClient *client
,const gchar *tzid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Retrieves a timezone object from the calendar backend.
The call is finished by e_cal_client_get_timezone_finish()
from
the callback
.
|
an ECalClient |
|
ID of the timezone to retrieve |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_get_timezone_finish (ECalClient *client
,GAsyncResult *result
,icaltimezone **zone
,GError **error
);
Finishes previous call of e_cal_client_get_timezone()
and
sets zone
to a retrieved timezone object from the calendar backend.
This object is owned by the client
, thus do not free it.
|
an ECalClient |
|
a GAsyncResult |
|
Return value for the timezone. [out] |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_get_timezone_sync (ECalClient *client
,const gchar *tzid
,icaltimezone **zone
,GCancellable *cancellable
,GError **error
);
Retrieves a timezone object from the calendar backend.
This object is owned by the client
, thus do not free it.
|
an ECalClient |
|
ID of the timezone to retrieve |
|
Return value for the timezone. [out] |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
void e_cal_client_add_timezone (ECalClient *client
,icaltimezone *zone
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Add a VTIMEZONE object to the given calendar client.
The call is finished by e_cal_client_add_timezone_finish()
from
the callback
.
|
an ECalClient |
|
The timezone to add |
|
a GCancellable; can be NULL
|
|
callback to call when a result is ready |
|
user data for the callback
|
Since 3.2
gboolean e_cal_client_add_timezone_finish (ECalClient *client
,GAsyncResult *result
,GError **error
);
Finishes previous call of e_cal_client_add_timezone()
.
|
an ECalClient |
|
a GAsyncResult |
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
gboolean e_cal_client_add_timezone_sync (ECalClient *client
,icaltimezone *zone
,GCancellable *cancellable
,GError **error
);
Add a VTIMEZONE object to the given calendar client.
|
an ECalClient |
|
The timezone to add |
|
a GCancellable; can be NULL
|
|
a GError to set an error, if any. [out] |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
"free-busy-data"
signalvoid user_function (ECalClient *ecalclient,
gpointer arg1,
gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |