Top | ![]() |
![]() |
![]() |
![]() |
EConfigLookup * | e_config_lookup_new () |
ESourceRegistry * | e_config_lookup_get_registry () |
ESource * | e_config_lookup_get_source () |
gboolean | e_config_lookup_get_busy () |
void | e_config_lookup_cancel_all () |
void | e_config_lookup_register_worker () |
void | e_config_lookup_unregister_worker () |
GSList * | e_config_lookup_dup_registered_workers () |
void | e_config_lookup_run () |
void | e_config_lookup_run_finish () |
void | e_config_lookup_run_worker () |
void | e_config_lookup_add_result () |
gint | e_config_lookup_count_results () |
GSList * | e_config_lookup_dup_results () |
void | e_config_lookup_clear_results () |
const gchar * | e_config_lookup_encode_certificate_trust () |
ETrustPromptResponse | e_config_lookup_decode_certificate_trust () |
#define | E_CONFIG_LOOKUP_PARAM_USER |
#define | E_CONFIG_LOOKUP_PARAM_PASSWORD |
#define | E_CONFIG_LOOKUP_PARAM_REMEMBER_PASSWORD |
#define | E_CONFIG_LOOKUP_PARAM_EMAIL_ADDRESS |
#define | E_CONFIG_LOOKUP_PARAM_SERVERS |
#define | E_CONFIG_LOOKUP_PARAM_CERTIFICATE_PEM |
#define | E_CONFIG_LOOKUP_PARAM_CERTIFICATE_HOST |
#define | E_CONFIG_LOOKUP_PARAM_CERTIFICATE_TRUST |
struct | EConfigLookup |
EConfigLookup is used to search for configuration of an account, which is identified by an e-mail address, server address or such. It is an EExtensible object, where the extensions connect to the “run” signal to run the configuration lookup.
EConfigLookup *
e_config_lookup_new (ESourceRegistry *registry
);
e_config_lookup_new
is deprecated and should not be used in newly-written code.
Creates a new EConfigLookup instance.
Since: 3.26
ESourceRegistry *
e_config_lookup_get_registry (EConfigLookup *config_lookup
);
e_config_lookup_get_registry
is deprecated and should not be used in newly-written code.
Returns the ESourceRegistry passed to e_config_lookup_new()
.
Since: 3.26
ESource * e_config_lookup_get_source (EConfigLookup *config_lookup
,EConfigLookupSourceKind kind
);
e_config_lookup_get_source
is deprecated and should not be used in newly-written code.
Emits the “get-source” signal and any listener can provide
the source. The function can return NULL
, when there are no listeners
or when such source is not available.
config_lookup |
||
kind |
one of EConfigLookupSourceKind, except of the |
Since: 3.26
gboolean
e_config_lookup_get_busy (EConfigLookup *config_lookup
);
e_config_lookup_get_busy
is deprecated and should not be used in newly-written code.
Returns whether there's any running worker. They can be cancelled
with e_config_lookup_cancel_all()
.
Since: 3.28
void
e_config_lookup_cancel_all (EConfigLookup *config_lookup
);
e_config_lookup_cancel_all
is deprecated and should not be used in newly-written code.
Cancels all pending workers.
Since: 3.28
void e_config_lookup_register_worker (EConfigLookup *config_lookup
,EConfigLookupWorker *worker
);
e_config_lookup_register_worker
is deprecated and should not be used in newly-written code.
Registers a worker
as a worker, which can be run as part of e_config_lookup_run()
.
The function adds its own reference to worker
.
Since: 3.28
void e_config_lookup_unregister_worker (EConfigLookup *config_lookup
,EConfigLookupWorker *worker
);
e_config_lookup_unregister_worker
is deprecated and should not be used in newly-written code.
Removes a worker
previously registered with e_config_lookup_register_worker()
.
Since: 3.28
GSList *
e_config_lookup_dup_registered_workers
(EConfigLookup *config_lookup
);
e_config_lookup_dup_registered_workers
is deprecated and should not be used in newly-written code.
Returns a list of all registered EConfigLookupWorker objects.
The returned GSList should be freed with g_slist_free_full (workers, g_object_unref); when no longer needed.
a GSList with all
workers registered with e_config_lookup_register_worker()
.
[transfer full][element-type EConfigLookupWorker]
Since: 3.28
void e_config_lookup_run (EConfigLookup *config_lookup
,const ENamedParameters *params
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
e_config_lookup_run
is deprecated and should not be used in newly-written code.
Runs configuration lookup asynchronously. Once the run is done, the callback
is called,
and the call can be finished with e_config_lookup_run_finish()
. The callback
is always
called from the main thread.
Workers can be run individually using e_config_lookup_run_worker()
.
Note that there cannot be run two lookups at the same time, thus if it
happens, then the callback
is called immediately with a NULL
result.
config_lookup |
||
params |
an ENamedParameters with lookup parameters |
|
cancellable |
an optional GCancellable, or |
|
callback |
a callback to call, when the run is finished |
|
user_data |
user data for the |
Since: 3.26
void e_config_lookup_run_finish (EConfigLookup *config_lookup
,GAsyncResult *result
);
e_config_lookup_run_finish
is deprecated and should not be used in newly-written code.
Finishes the configuration lookup previously run by e_config_lookup_run()
.
It's expected that the extensions may fail, thus it doesn't return
anything and is provided mainly for consistency with asynchronous API.
Since: 3.26
void e_config_lookup_run_worker (EConfigLookup *config_lookup
,EConfigLookupWorker *worker
,const ENamedParameters *params
,GCancellable *cancellable
);
e_config_lookup_run_worker
is deprecated and should not be used in newly-written code.
Creates a new thread and runs worker
in it. When the cancellable
is NULL
,
then there's creates a new CamelOperation, which either proxies currently
running lookup or the newly created cancellable is completely independent.
This function can be called while there's an ongoing configuration lookup, but
also when the worker
is restarted.
config_lookup |
||
worker |
an EConfigLookupWorker to run in a dedicated thread |
|
params |
an ENamedParameters with lookup parameters |
|
cancellable |
an optional GCancellable, or |
Since: 3.28
void e_config_lookup_add_result (EConfigLookup *config_lookup
,EConfigLookupResult *result
);
e_config_lookup_add_result
is deprecated and should not be used in newly-written code.
Adds a new result
in a list of known configuration lookup results.
The config_lookup
assumes ownership of the result
and frees it
when no longer needed.
The list of results can be obtained with e_config_lookup_dup_results()
.
Since: 3.26
gint
e_config_lookup_count_results (EConfigLookup *config_lookup
);
e_config_lookup_count_results
is deprecated and should not be used in newly-written code.
Since: 3.28
GSList * e_config_lookup_dup_results (EConfigLookup *config_lookup
,EConfigLookupResultKind kind
,const gchar *protocol
);
e_config_lookup_dup_results
is deprecated and should not be used in newly-written code.
Returns a GSList with EConfigLookupResult objects satisfying
the kind
and protocol
filtering conditions. To receive all
gathered results use E_CONFIG_LOOKUP_RESULT_UNKNOWN
for kind
and NULL
for the protocol
.
Free the returned GSList with g_slist_free_full (results, g_object_unref); when no longer needed.
config_lookup |
||
kind |
an EConfigLookupResultKind to filter the results with |
|
protocol |
optional protocol to filter the results with, or |
[nullable] |
a GSList
with results satisfying the kind
and protocol
filtering conditions.
[transfer full][element-type EConfigLookupResult]
Since: 3.28
void
e_config_lookup_clear_results (EConfigLookup *config_lookup
);
e_config_lookup_clear_results
is deprecated and should not be used in newly-written code.
Frees all gathered results. This might be usually called before
starting new custom lookup. The e_config_lookup_run()
frees
all results automatically.
Since: 3.28
const gchar *
e_config_lookup_encode_certificate_trust
(ETrustPromptResponse response
);
e_config_lookup_encode_certificate_trust
is deprecated and should not be used in newly-written code.
Encodes response
to a string. This can be decoded back to enum
with e_config_lookup_decode_certificate_trust()
.
Since: 3.28
ETrustPromptResponse
e_config_lookup_decode_certificate_trust
(const gchar *value
);
e_config_lookup_decode_certificate_trust
is deprecated and should not be used in newly-written code.
Decodes text value
to ETrustPromptResponse, previously encoded
with e_config_lookup_encode_certificate_trust()
.
Since: 3.28
#define E_CONFIG_LOOKUP_PARAM_USER "user"
E_CONFIG_LOOKUP_PARAM_USER
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_PASSWORD "password"
E_CONFIG_LOOKUP_PARAM_PASSWORD
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_REMEMBER_PASSWORD "remember-password" /* Is part of params, if can remember, otherwise not in params */
E_CONFIG_LOOKUP_PARAM_REMEMBER_PASSWORD
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_EMAIL_ADDRESS "email-address"
E_CONFIG_LOOKUP_PARAM_EMAIL_ADDRESS
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_SERVERS "servers"
E_CONFIG_LOOKUP_PARAM_SERVERS
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_CERTIFICATE_PEM "certificate-pem"
E_CONFIG_LOOKUP_PARAM_CERTIFICATE_PEM
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_CERTIFICATE_HOST "certificate-host"
E_CONFIG_LOOKUP_PARAM_CERTIFICATE_HOST
is deprecated and should not be used in newly-written code.
#define E_CONFIG_LOOKUP_PARAM_CERTIFICATE_TRUST "certificate-trust"
E_CONFIG_LOOKUP_PARAM_CERTIFICATE_TRUST
is deprecated and should not be used in newly-written code.
struct EConfigLookup { };
EConfigLookup
is deprecated and should not be used in newly-written code.
Contains only private data that should be read and manipulated using the functions below.
Since: 3.26