Top | ![]() |
![]() |
![]() |
![]() |
#define | CLIENT_BACKEND_PROPERTY_ONLINE |
#define | CLIENT_BACKEND_PROPERTY_READONLY |
#define | CLIENT_BACKEND_PROPERTY_CACHE_DIR |
#define | CLIENT_BACKEND_PROPERTY_CAPABILITIES |
#define | CLIENT_BACKEND_PROPERTY_REVISION |
#define | E_CLIENT_ERROR |
enum | EClientError |
struct | EClient |
#define | CLIENT_BACKEND_PROPERTY_OPENED |
#define | CLIENT_BACKEND_PROPERTY_OPENING |
struct | EClientErrorsList |
This class provides some base functionality for clients such as EBookClient and ECalClient.
constgchar * e_client_error_to_string (EClientError code
);
Get localized human readable description of the given error code.
Since: 3.2
ESource *
e_client_get_source (EClient *client
);
Get the ESource that this client has assigned.
Since: 3.2
constGSList * e_client_get_capabilities (EClient *client
);
Get list of strings with capabilities advertised by a backend.
This list, together with inner strings, is owned by the client
.
To check for individual capabilities use e_client_check_capability()
.
Since: 3.2
GMainContext * e_client_ref_main_context (EClient *client
);
Returns the client
are to
be attached.
The returned g_main_context_unref()
Since: 3.8
gboolean e_client_check_capability (EClient *client
,const
);gchar *capability
Check if backend supports particular capability.
To get all capabilities use e_client_get_capabilities()
.
Since: 3.2
gboolean e_client_check_refresh_supported (EClient *client
);
Checks whether a client supports explicit refreshing
(see e_client_refresh()
).
Since: 3.2
gboolean e_client_is_readonly (EClient *client
);
Check if this client
is read-only.
Since: 3.2
gboolean e_client_is_online (EClient *client
);
Check if this client
is connected.
Since: 3.2
void e_client_get_backend_property (EClient *client
,const
,gchar *prop_name,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Queries client
's backend for a property of name prop_name
.
The call is finished by e_client_get_backend_property_finish()
from the callback
.
client |
an EClient |
|
prop_name |
property name, whose value to retrieve; cannot be |
|
cancellable |
a |
|
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.2
gboolean e_client_get_backend_property_finish (EClient *client
,,
GAsyncResult *result,
gchar **prop_value);
GError **error
Finishes previous call of e_client_get_backend_property()
.
client |
an EClient |
|
result |
a |
|
prop_value |
Retrieved backend property value; cannot be |
[out] |
error |
a |
[out] |
Since: 3.2
gboolean e_client_get_backend_property_sync (EClient *client
,const
,gchar *prop_name,
gchar **prop_value,
GCancellable *cancellable);
GError **error
Queries client
's backend for a property of name prop_name
.
client |
an EClient |
|
prop_name |
property name, whose value to retrieve; cannot be |
|
prop_value |
Retrieved backend property value; cannot be |
[out] |
cancellable |
a |
|
error |
a |
[out] |
Since: 3.2
void e_client_refresh (EClient *client
,,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Initiates refresh on the client
. Finishing the method doesn't mean
that the refresh is done, backend only notifies whether it started
refreshing or not. Use e_client_check_refresh_supported()
to check
whether the backend supports this method.
The call is finished by e_client_refresh_finish()
from the callback
.
client |
an EClient |
|
cancellable |
a |
|
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.2
gboolean e_client_refresh_finish (EClient *client
,,
GAsyncResult *result);
GError **error
Finishes previous call of e_client_refresh()
.
Since: 3.2
gboolean e_client_refresh_sync (EClient *client
,,
GCancellable *cancellable);
GError **error
Initiates refresh on the client
. Finishing the method doesn't mean
that the refresh is done, backend only notifies whether it started
refreshing or not. Use e_client_check_refresh_supported()
to check
whether the backend supports this method.
client |
an EClient |
|
cancellable |
a |
|
error |
a |
[out] |
Since: 3.2
void e_client_wait_for_connected (EClient *client
,,
guint32 timeout_seconds,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously waits until the client
is connected (according
to ESource
::connection-status property), but not longer than timeout_seconds
.
The call is finished by e_client_wait_for_connected_finish()
from
the callback
.
client |
an EClient |
|
timeout_seconds |
a timeout for the wait, in seconds |
|
cancellable |
a |
[allow-none] |
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.16
gboolean e_client_wait_for_connected_finish (EClient *client
,,
GAsyncResult *result);
GError **error
Finishes previous call of e_client_wait_for_connected()
.
client |
an EClient |
|
result |
a |
|
error |
(allow-none): a |
[out] |
Since: 3.16
gboolean e_client_wait_for_connected_sync (EClient *client
,,
guint32 timeout_seconds,
GCancellable *cancellable);
GError **error
Synchronously waits until the client
is connected (according
to ESource
::connection-status property), but not longer than timeout_seconds
.
Note: This also calls e_client_retrieve_properties_sync()
on success, to have
up-to-date property values on the client side, without a delay due
to property change notifcations delivery through D-Bus.
client |
an EClient |
|
timeout_seconds |
a timeout for the wait, in seconds |
|
cancellable |
a |
[allow-none] |
error |
(allow-none): a |
[out] |
Since: 3.16
GSList * e_client_util_parse_comma_strings (const
);gchar *strings
Parses comma-separated list of values into
Newly allocated strings
.
Free the returned pointer with e_client_util_free_string_slist()
.
[transfer full][element-type utf8]
Since: 3.2
GError * e_client_error_create (EClientError code
,const
);gchar *custom_msg
e_client_error_create
has been deprecated since version 3.8 and should not be used in newly-written code.
Just use the
code |
an EClientError code to create |
|
custom_msg |
custom message to use for the error; can be |
a new code
. If the custom_msg
is NULL, then the error message is
the one returned from e_client_error_to_string()
for the code
,
otherwise the given message is used.
Returned pointer should be freed with g_error_free()
Since: 3.2
gboolean e_client_is_opened (EClient *client
);
e_client_is_opened
has been deprecated since version 3.8 and should not be used in newly-written code.
Clients don't need to care if they're fully opened
anymore. This function always returns TRUE
Check if this client
is fully opened. This includes
everything from e_client_open()
call up to the authentication,
if required by a backend. Client cannot do any other operation
during the opening phase except of authenticate or cancel it.
Every other operation results in an E_CLIENT_ERROR_BUSY
error.
Since: 3.2
void e_client_cancel_all (EClient *client
);
e_client_cancel_all
has been deprecated since version 3.8 and should not be used in newly-written code.
The function no longer does anything.
Cancels all pending operations started on client
.
Since: 3.2
void e_client_unwrap_dbus_error (EClient *client
,,
GError *dbus_error);
GError **out_error
e_client_unwrap_dbus_error
has been deprecated since version 3.8 and should not be used in newly-written code.
Use g_dbus_error_strip_remote_error()
Unwraps D-Bus error to local error. dbus_error
is automatically freed.
dbus_erorr
and out_error
can point to the same variable.
client |
an EClient |
|
dbus_error |
a |
|
out_error |
a |
Since: 3.2
void e_client_retrieve_capabilities (EClient *client
,,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
e_client_retrieve_capabilities
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_client_get_capabilities()
instead.
Initiates retrieval of capabilities on the client
. This is usually
required only once, after the client
is opened. The returned value
is cached and any subsequent call of e_client_get_capabilities()
and
e_client_check_capability()
is using the cached value.
The call is finished by e_client_retrieve_capabilities_finish()
from the callback
.
client |
an EClient |
|
cancellable |
a |
|
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.2
gboolean e_client_retrieve_capabilities_finish (EClient *client
,,
GAsyncResult *result,
gchar **capabilities);
GError **error
e_client_retrieve_capabilities_finish
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_client_get_capabilities()
instead.
Finishes previous call of e_client_retrieve_capabilities()
.
Returned value of capabilities
should be freed with g_free()
client |
an EClient |
|
result |
a |
|
capabilities |
Comma-separated list of capabilities of the |
[out] |
error |
a |
[out] |
Since: 3.2
gboolean e_client_retrieve_capabilities_sync (EClient *client
,,
gchar **capabilities,
GCancellable *cancellable);
GError **error
e_client_retrieve_capabilities_sync
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_client_get_capabilities()
instead.
Initiates retrieval of capabilities on the client
. This is usually
required only once, after the client
is opened. The returned value
is cached and any subsequent call of e_client_get_capabilities()
and
e_client_check_capability()
is using the cached value. Returned value
of capabilities
should be freed with g_free()
client |
an EClient |
|
capabilities |
Comma-separated list of capabilities of the |
[out] |
cancellable |
a |
|
error |
a |
[out] |
Since: 3.2
void e_client_set_backend_property (EClient *client
,const
,gchar *prop_nameconst
,gchar *prop_value,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
e_client_set_backend_property
has been deprecated since version 3.8 and should not be used in newly-written code.
Clients cannot set backend properties. Any attempt
will fail with an E_CLIENT_ERROR_NOT_SUPPORTED
error.
Sets client
's backend property of name prop_name
to value prop_value
. The call is finished
by e_client_set_backend_property_finish()
from the callback
.
client |
an EClient |
|
prop_name |
property name, whose value to change; cannot be |
|
prop_value |
property value, to set; cannot be |
|
cancellable |
a |
|
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.2
gboolean e_client_set_backend_property_finish (EClient *client
,,
GAsyncResult *result);
GError **error
e_client_set_backend_property_finish
has been deprecated since version 3.8 and should not be used in newly-written code.
Clients cannot set backend properties. Any attempt
will fail with an E_CLIENT_ERROR_NOT_SUPPORTED
error.
Finishes previous call of e_client_set_backend_property()
.
Since: 3.2
gboolean e_client_set_backend_property_sync (EClient *client
,const
,gchar *prop_nameconst
,gchar *prop_value,
GCancellable *cancellable);
GError **error
e_client_set_backend_property_sync
has been deprecated since version 3.8 and should not be used in newly-written code.
Clients cannot set backend properties. Any attempt
will fail with an E_CLIENT_ERROR_NOT_SUPPORTED
error.
Sets client
's backend property of name prop_name
to value prop_value
.
client |
an EClient |
|
prop_name |
property name, whose value to change; cannot be |
|
prop_value |
property value, to set; cannot be |
|
cancellable |
a |
|
error |
a |
[out] |
Since: 3.2
void e_client_open (EClient *client
,,
gboolean only_if_exists,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
e_client_open
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_book_client_connect()
and
e_book_client_connect_finish()
or
e_cal_client_connect()
and
e_cal_client_connect_finish()
instead.
Opens the client
, making it ready for queries and other operations.
The call is finished by e_client_open_finish()
from the callback
.
client |
an EClient |
|
only_if_exists |
if |
|
cancellable |
a |
|
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.2
gboolean e_client_open_finish (EClient *client
,,
GAsyncResult *result);
GError **error
e_client_open_finish
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_book_client_connect()
and
e_book_client_connect_finish()
or
e_cal_client_connect()
and
e_cal_client_connect_finish()
instead.
Finishes previous call of e_client_open()
.
Since: 3.2
gboolean e_client_open_sync (EClient *client
,,
gboolean only_if_exists,
GCancellable *cancellable);
GError **error
e_client_open_sync
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_book_client_connect_sync()
or
e_cal_client_connect_sync()
instead.
Opens the client
, making it ready for queries and other operations.
client |
an EClient |
|
only_if_exists |
if |
|
cancellable |
a |
|
error |
a |
[out] |
Since: 3.2
void e_client_remove (EClient *client
,,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
e_client_remove
has been deprecated since version 3.6 and should not be used in newly-written code.
Use e_source_remove()
instead.
Removes the backing data for this EClient. For example, with the file
backend this deletes the database file. You cannot get it back!
The call is finished by e_client_remove_finish()
from the callback
.
client |
an EClient |
|
cancellable |
a |
|
callback |
callback to call when a result is ready |
|
user_data |
user data for the |
Since: 3.2
gboolean e_client_remove_finish (EClient *client
,,
GAsyncResult *result);
GError **error
e_client_remove_finish
has been deprecated since version 3.6 and should not be used in newly-written code.
Use e_source_remove_finish()
instead.
Finishes previous call of e_client_remove()
.
Since: 3.2
gboolean e_client_remove_sync (EClient *client
,,
GCancellable *cancellable);
GError **error
e_client_remove_sync
has been deprecated since version 3.6 and should not be used in newly-written code.
Use e_source_remove_sync()
instead.
Removes the backing data for this EClient. For example, with the file backend this deletes the database file. You cannot get it back!
client |
an EClient |
|
cancellable |
a |
|
error |
a |
[out] |
Since: 3.2
gboolean e_client_retrieve_properties_sync (EClient *client
,,
GCancellable *cancellable);
GError **error
e_client_retrieve_properties_sync
is deprecated and should not be used in newly-written code.
Retrieves client
properties to match server-side values, without waiting
for the D-Bus property change notifications delivery.
If an error occurs, the function sets error
and returns FALSE
client |
an EClient |
|
cancellable |
optional |
[allow-none] |
error |
return location for a |
[allow-none] |
Since: 3.16
void e_client_retrieve_properties (EClient *client
,,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
e_client_retrieve_properties
is deprecated and should not be used in newly-written code.
Asynchronously retrieves client
properties to match server-side values,
without waiting for the D-Bus property change notifications delivery.
When the operation is finished, callback
will be called. You can then
call e_client_retrieve_properties_finish()
to get the result of the operation.
client |
an EClient |
|
cancellable |
optional |
[allow-none] |
callback |
a |
|
user_data |
data to pass to the callback function |
Since: 3.16
gboolean e_client_retrieve_properties_finish (EClient *client
,,
GAsyncResult *result);
GError **error
e_client_retrieve_properties_finish
is deprecated and should not be used in newly-written code.
Finishes the operation started with e_client_retrieve_properties()
.
If an error occurs, the function sets error
and returns FALSE
Since: 3.16
gchar ** e_client_util_slist_to_strv (const
);GSList *strings
e_client_util_slist_to_strv
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_util_slist_to_strv()
instead.
Convert a list of strings into a NULL
Newly allocated NULL
g_strfreev()
Note: Paired function for this is e_client_util_strv_to_slist()
.
[transfer full]
Since: 3.2
GSList * e_client_util_strv_to_slist (const
);gchar * const *strv
e_client_util_strv_to_slist
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_util_strv_to_slist()
instead.
Convert a NULL
Newly allocated e_client_util_free_string_slist()
.
Note: Paired function for this is e_client_util_slist_to_strv()
.
[transfer full][element-type utf8]
Since: 3.2
GSList * e_client_util_copy_string_slist (,
GSList *copy_toconst
);GSList *strings
e_client_util_copy_string_slist
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_util_copy_string_slist()
instead.
Copies the copy_to
.
copy_to |
Where to copy; may be |
[element-type utf8][allow-none] |
strings |
|
[element-type utf8] |
New head of copy_to
.
The returned pointer can be freed with e_client_util_free_string_slist()
.
[transfer full][element-type utf8]
Since: 3.2
GSList * e_client_util_copy_object_slist (,
GSList *copy_toconst
);GSList *objects
e_client_util_copy_object_slist
has been deprecated since version 3.8 and should not be used in newly-written code.
Use e_util_copy_object_slist()
instead.
Copies a copy_to
.
copy_to |
Where to copy; may be |
[element-type GObject][allow-none] |
objects |
|
[element-type GObject] |
New head of copy_to
.
The returned pointer can be freed with e_client_util_free_object_slist()
.
[transfer full][element-type GObject]
Since: 3.2
void e_client_util_free_string_slist ();
GSList *strings
e_client_util_free_string_slist
has been deprecated since version 3.8 and should not be used in newly-written code.
Use g_slist_free_full()
Frees memory previously allocated by e_client_util_strv_to_slist()
.
Since: 3.2
void e_client_util_free_object_slist ();
GSList *objects
e_client_util_free_object_slist
has been deprecated since version 3.8 and should not be used in newly-written code.
Use g_slist_free_full()
Calls g_object_unref()
objects
and then frees objects
itself.
Since: 3.2
gchar * e_client_dup_bus_name (EClient *client
);
e_client_dup_bus_name
is deprecated and should not be used in newly-written code.
Returns a D-Bus bus name that will be used to connect the client to the backend subprocess.
a newly-allocated string representing a D-Bus bus
name that will be used to connect the client to
the backend subprocess. The string should be
freed by the caller using g_free()
Since: 3.16
void e_client_set_bus_name (EClient *client
,const
);gchar *bus_name
e_client_set_bus_name
is deprecated and should not be used in newly-written code.
Sets a D-Bus bus name that will be used to connect the client to the backend subprocess.
Since: 3.16
gboolean e_client_util_unwrap_dbus_error (,
GError *dbus_error,
GError **client_errorconst EClientErrorsList *known_errors
,,
guint known_errors_count,
GQuark known_errors_domain);
gboolean fail_when_none_matched
e_client_util_unwrap_dbus_error
has been deprecated since version 3.8 and should not be used in newly-written code.
This function is no longer used.
The function takes a dbus_error
and tries to find a match in known_errors
for it, if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else
then the dbus_error
is moved to client_error
.
The fail_when_none_matched
influences behaviour. If it's TRUE
known_errors
matches, or this is not a G_IO_ERROR_DBUS_ERROR, then FALSE
client_error
is left without change. Otherwise, the
fail_when_none_matched
is FALSE
known_error
matches.
dbus_error |
DBus |
|
client_error |
Resulting |
[out] |
known_errors |
List of known errors against which try to match |
|
known_errors_count |
How many items are stored in |
|
known_errors_domain |
Error domain for |
|
fail_when_none_matched |
Whether to fail when none of |
Whether was dbus_error
processed into client_error
.
Note: The dbus_error
is automatically freed if returned TRUE
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_ONLINE "online"
The "online" property is "TRUE" when the client is fully opened and
online, "FALSE" at all other times. See also e_client_is_online()
.
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_READONLY "readonly"
The "online" property is "TRUE" if the backend has only read access
to its data, "FALSE" if the backend can modify its data. See also
e_client_is_readonly()
.
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_CACHE_DIR "cache-dir"
The "cache-dir" property indicates the backend's local directory for cached data.
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_CAPABILITIES
FIXME: Document me.
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_REVISION "revision"
The current overall revision string, this can be used as a quick check to see if data has changed at all since the last time the revision was observed.
Since: 3.4
#define E_CLIENT_ERROR e_client_error_quark ()
Error domain for EClient operations. Errors in this domain will be
from the EClientError enumeration. See
Since: 3.2
Error codes for EClient operations.
Invalid argument was used |
||
The client is busy |
||
The source is not loaded |
||
The source is already loaded |
||
Authentication failed |
||
Authentication required |
||
The repository (client) is offline |
||
The operation is unavailable in offline mode |
||
Permission denied for the operation |
||
The operation was cancelled |
||
The operation cannot be cancelled |
||
The operation is not supported |
||
TLS is not available |
||
Requested authentication method is not supported |
||
Search size limit exceeded |
||
Search time limit exceeded |
||
The query was invalid |
||
The query was refused by the server side |
||
A D-Bus error occurred |
||
Other error |
||
The client is not opened |
||
The clien tis out of sync |
Since: 3.2
struct EClient { };
Contains only private data that should be read and manipulated using the functions below.
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_OPENED "opened"
CLIENT_BACKEND_PROPERTY_OPENED
has been deprecated since version 3.8 and should not be used in newly-written code.
Clients don't need to care if they're fully opened
anymore. This property will always return TRUE
The "opened" property is "TRUE" when the client is fully opened, "FALSE" at all other times.
Since: 3.2
#define CLIENT_BACKEND_PROPERTY_OPENING "opening"
CLIENT_BACKEND_PROPERTY_OPENING
has been deprecated since version 3.8 and should not be used in newly-written code.
Clients don't need to care if they're fully opened
anymore. This property will always return FALSE
The "opening" property is "TRUE" when the client is in the process of opening, "FALSE" at all other times.
Since: 3.2
struct EClientErrorsList { };
EClientErrorsList
has been deprecated since version 3.8 and should not be used in newly-written code.
This structure is no longer used.
Since: 3.2