![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Calendar Backend (libedata-cal) | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
#define E_DATA_CAL_ERROR struct EDataCal; enum EDataCalCallStatus; 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 (struct _ECalBackend *backend
,GDBusConnection *connection
,const gchar *object_path
,GError **error
); struct _ECalBackend * e_data_cal_get_backend (EDataCal *cal
); GDBusConnection * e_data_cal_get_connection (EDataCal *cal
); const gchar * e_data_cal_get_object_path (EDataCal *cal
); void e_data_cal_respond_open (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_objects (EDataCal *cal
,guint32 opid
,GError *error
,const GSList *uids
,GSList *new_components
); void e_data_cal_respond_modify_objects (EDataCal *cal
,guint32 opid
,GError *error
,GSList *old_components
,GSList *new_components
); void e_data_cal_respond_remove_objects (EDataCal *cal
,guint32 opid
,GError *error
,const GSList *ids
,GSList *old_components
,GSList *new_components
); 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 *attachment_uris
); 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_opened (EDataCal *cal
,const GError *error
); void e_data_cal_report_free_busy_data (EDataCal *cal
,const GSList *freebusy
); void e_data_cal_report_backend_property_changed (EDataCal *cal
,const gchar *prop_name
,const gchar *prop_value
);
"backend" ECalBackend* : Read / Write / Construct Only "connection" GDBusConnection* : Read / Write / Construct Only "object-path" gchar* : Read / Write / Construct Only
typedef enum { Success, Busy, RepositoryOffline, PermissionDenied, InvalidRange, ObjectNotFound, InvalidObject, ObjectIdAlreadyExists, AuthenticationFailed, AuthenticationRequired, UnsupportedField, UnsupportedMethod, UnsupportedAuthenticationMethod, TLSNotAvailable, NoSuchCal, UnknownUser, OfflineUnavailable, /* These can be returned for successful searches, but indicate the result set was truncated */ SearchSizeLimitExceeded, SearchTimeLimitExceeded, InvalidQuery, QueryRefused, CouldNotCancel, OtherError, InvalidServerVersion, InvalidArg, NotSupported, NotOpened } EDataCalCallStatus;
FIXME Document me!
Since 3.6
GError * e_data_cal_create_error (EDataCalCallStatus status
,const gchar *custom_msg
);
|
EDataCalStatus code |
|
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
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.
Since 2.32
const gchar * e_data_cal_status_to_string (EDataCalCallStatus status
);
Since 2.32
#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
EDataCal * e_data_cal_new (struct _ECalBackend *backend
,GDBusConnection *connection
,const gchar *object_path
,GError **error
);
Creates a new EDataCal and exports the Calendar D-Bus interface
on connection
at object_path
. The EDataCal handles incoming remote
method invocations and forwards them to the backend
. If the Calendar
interface fails to export, the function sets error
and returns NULL
.
|
an ECalBackend |
|
a GDBusConnection |
|
object path for the D-Bus interface |
|
return location for a GError, or NULL
|
Returns : |
an EDataCal, or NULL on error |
struct _ECalBackend * e_data_cal_get_backend (EDataCal *cal
);
Returns the ECalBackend to which incoming remote method invocations are being forwarded.
|
an EDataCal |
Returns : |
the ECalBackend |
GDBusConnection * e_data_cal_get_connection (EDataCal *cal
);
Returns the GDBusConnection on which the Calendar D-Bus interface is exported.
|
an EDataCal |
Returns : |
the GDBusConnection |
Since 3.8
const gchar * e_data_cal_get_object_path (EDataCal *cal
);
Returns the object path at which the Calendar D-Bus interface is exported.
|
an EDataCal |
Returns : |
the object path |
Since 3.8
void e_data_cal_respond_open (EDataCal *cal
,guint32 opid
,GError *error
);
Notifies listeners of the completion of the open method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
void e_data_cal_respond_refresh (EDataCal *cal
,guint32 opid
,GError *error
);
Notifies listeners of the completion of the refresh method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
Value of a property |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
The object retrieved as an iCalendar string. |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
List of retrieved objects. |
Since 3.2
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()
.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
void e_data_cal_respond_create_objects (EDataCal *cal
,guint32 opid
,GError *error
,const GSList *uids
,GSList *new_components
);
Notifies listeners of the completion of the create_objects method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
UIDs of the objects created. |
|
The newly created ECalComponent objects. |
Since 3.6
void e_data_cal_respond_modify_objects (EDataCal *cal
,guint32 opid
,GError *error
,GSList *old_components
,GSList *new_components
);
Notifies listeners of the completion of the modify_objects method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
The old ECalComponents. |
|
The new ECalComponents. |
Since 3.6
void e_data_cal_respond_remove_objects (EDataCal *cal
,guint32 opid
,GError *error
,const GSList *ids
,GSList *old_components
,GSList *new_components
);
Notifies listeners of the completion of the remove_objects method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
IDs of the removed objects. |
|
The old ECalComponents. |
|
The new ECalComponents. They will not be NULL only when removing instances of recurring appointments. |
Since 3.6
void e_data_cal_respond_receive_objects (EDataCal *cal
,guint32 opid
,GError *error
);
Notifies listeners of the completion of the receive_objects method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
List of users. |
|
An iCalendar string representing the object sent. |
Since 3.2
void e_data_cal_respond_get_attachment_uris (EDataCal *cal
,guint32 opid
,GError *error
,const GSList *attachment_uris
);
Notifies listeners of the completion of the get_attachment_uris method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
List of retrieved attachment uri's. |
Since 3.2
void e_data_cal_respond_discard_alarm (EDataCal *cal
,guint32 opid
,GError *error
);
Notifies listeners of the completion of the discard_alarm method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
The new live view path. |
Since 3.2
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.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
|
The requested timezone as an iCalendar string. |
Since 3.2
void e_data_cal_respond_add_timezone (EDataCal *cal
,guint32 opid
,GError *error
);
Notifies listeners of the completion of the add_timezone method call.
|
A calendar client interface. |
|
Operation error, if any, automatically freed if passed it. |
Since 3.2
void e_data_cal_report_error (EDataCal *cal
,const gchar *message
);
FIXME: Document me.
Since 3.2
void e_data_cal_report_readonly (EDataCal *cal
,gboolean is_readonly
);
FIXME: Document me.
Since 3.2
void e_data_cal_report_online (EDataCal *cal
,gboolean is_online
);
FIXME: Document me.
Since 3.2
void e_data_cal_report_opened (EDataCal *cal
,const GError *error
);
Reports to associated client that opening phase of the cal is finished. error being NULL means successfully, otherwise reports an error which happened during opening phase. By opening phase is meant a process including successfull authentication to the server/storage.
Since 3.2
void e_data_cal_report_free_busy_data (EDataCal *cal
,const GSList *freebusy
);
FIXME: Document me.
Since 3.2
"backend"
property"backend" ECalBackend* : Read / Write / Construct Only
The backend driving this connection.
"connection"
property"connection" GDBusConnection* : Read / Write / Construct Only
The GDBusConnection on which to export the calendar interface.
"object-path"
property"object-path" gchar* : Read / Write / Construct Only
The object path at which to export the calendar interface.
Default value: NULL