| Top |
This class communicates with ECalClients over the bus and accesses an ECalBackend to satisfy client requests.
GError * e_data_cal_create_error (EDataCalCallStatus status,const gchar *custom_msg);
status |
EDataCalCallStatus code |
|
custom_msg |
Custom message to use for the error. When NULL,
then uses a default message based on the |
NULL, when the status
is Success,
or a newly allocated GError, which should be freed
with g_error_free() call.
[nullable][transfer full]
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 message for the error.
status |
||
custom_msg_fmt |
message format, or |
[nullable] |
... |
arguments for the format |
NULL, when the status
is Success,
or a newly allocated GError, which should be freed with g_error_free() call.
The GError has set the custom message, or the default message for
status
, when custom_msg_fmt
is NULL.
[nullable][transfer full]
Since: 2.32
const gchar *
e_data_cal_status_to_string (EDataCalCallStatus status);
Since: 2.32
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.
backend |
an ECalBackend |
|
connection |
a GDBusConnection |
|
object_path |
object path for the D-Bus interface |
|
error |
return location for a GError, or |
struct _ECalBackend *
e_data_cal_ref_backend (EDataCal *cal);
Returns the ECalBackend to which incoming remote method invocations are being forwarded.
The returned ECalBackend is referenced for thread-safety and should
be unreferenced with g_object_unref() when finished with it.
Since: 3.10
GDBusConnection *
e_data_cal_get_connection (EDataCal *cal);
Returns the GDBusConnection on which the Calendar D-Bus interface is exported.
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.
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
object |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
objects |
List of retrieved objects. |
Since: 3.2
void e_data_cal_respond_get_free_busy (EDataCal *cal,guint32 opid,GError *error,const GSList *freebusy);
Notifies listeners of the completion of the get_free_busy method call.
To pass actual free/busy objects to the client asynchronously
use e_data_cal_report_free_busy_data(), but the freebusy
should contain
all the objects being used in e_data_cal_report_free_busy_data().
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
freebusy |
a GSList of iCalendar strings with all gathered free/busy components. |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
uids |
UIDs of the objects created. |
|
new_components |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
old_components |
The old ECalComponent(s). |
|
new_components |
The new ECalComponent(s). |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
ids |
(element-type: utf8) IDs of the removed objects. |
|
old_components |
The old ECalComponent(s). |
[element-type ECalComponent] |
new_components |
The new ECalComponent(s). They will not be NULL only when removing instances of recurring appointments. |
[element-type ECalComponent] |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
users |
List of users. |
|
calobj |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
attachment_uris |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
|
tzobject |
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.
cal |
A calendar client interface. |
|
opid |
associated operation id |
|
error |
Operation error, if any, automatically freed if passed it. |
Since: 3.2
void e_data_cal_report_error (EDataCal *cal,const gchar *message);
Emits an error message, thus the clients can be notified about it.
Since: 3.2
void e_data_cal_report_free_busy_data (EDataCal *cal,const GSList *freebusy);
Reports result of a free/busy query on the cal
.
cal |
an EDataCal |
|
freebusy |
a GSList of free/busy components encoded as string. |
[element-type utf8] |
Since: 3.2
Response statuses of the calls.
|
call finished successfully |
||
|
the backend is busy |
||
|
the backend is offline |
||
|
the call failed due to permission restrictions |
||
|
the provided range for the call is invalid |
||
|
the requested object could not be found |
||
|
the provided object is invalid |
||
|
the provided object has an ID which already exists |
||
|
failed to authenticate with given credentials |
||
|
authentication credentials are required to connect to the calendar |
||
|
requested field is not supported |
||
|
requested method is not supported |
||
|
requested authentication method is not supported |
||
|
TLS for connection is not available for the calendar |
||
|
requested calendar does not exist |
||
|
provided user is unknown |
||
|
requested data are not available in offline |
||
|
a successful search doesn't contain all responses due to size limit |
||
|
a successful search doesn't contain all responses due to time limit |
||
|
a requested search query is invalid |
||
|
a requested search query had been refused, possibly by the server |
||
|
an ongoing operation cannot be cancelled |
||
|
a generic error happened |
||
|
server version is invalid |
||
|
one of the arguments of the call was invalid |
||
|
the operation is not supported |
||
|
the calendar is not opened |
Since: 3.6