Class

EDataServerUICredentialsPrompter

since: 3.16

Description [src]

class EDataServerUI.CredentialsPrompter : GObject.Object
  implements EDataServer.Extensible {
  ECredentialsPrompterPrivate* priv
}

Contains only private data that should be read and manipulated using the functions below.

Available since: 3.16

Hierarchy

hierarchy this ECredentialsPrompter implements_0 EExtensible this--implements_0 ancestor_0 GObject ancestor_0--this

Ancestors

Implements

Constructors

e_credentials_prompter_new

Creates a new ECredentialsPrompter, which listens for credential requests from registry.

since: 3.16

Instance methods

e_credentials_prompter_get_auto_prompt

Returns, whether can respond to credential prompts automatically. Default value is TRUE.

since: 3.16

e_credentials_prompter_get_auto_prompt_disabled_for

Returns whether the auto-prompt is disabled for the given source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property.

since: 3.16

e_credentials_prompter_get_dialog_parent

Returns a GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don’t have any suitable window, then there’s chosen the last active window from the default GApplication, if any available.

since: 3.16

e_credentials_prompter_get_dialog_parent_full

Returns a GtkWindow, which should be used as a dialog parent for the auth_source.

since: 3.42

e_credentials_prompter_get_provider

Returns an ESourceCredentialsProvider, which the prompter uses.

since: 3.16

e_credentials_prompter_get_registry

Returns an ESourceRegistry, to which the prompter listens.

since: 3.16

e_credentials_prompter_loop_prompt_sync

Runs a credentials prompt loop for source, as long as the func doesn’t indicate that the provided credentials can be used to successfully authenticate against source‘s server, or that the func returns FALSE. The loop is also teminated when a used cancels the credentials prompt or the cancellable is cancelled, though not sooner than the credentials prompt dialog is closed.

since: 3.16

e_credentials_prompter_process_awaiting_credentials

Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, like if they just asked for its credentials for the first time.

since: 3.16

e_credentials_prompter_process_source

Continues a credential prompt for source. Returns, whether anything will be done. The FALSE either means that the source‘s connection status is not the E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS or it is disabled.

since: 3.16

e_credentials_prompter_prompt

Asks the prompter to prompt for credentials, which are returned to the caller through callback, when available.The flags are ignored, when the callback is NULL; the credentials are passed to the source with e_source_invoke_authenticate() directly, in this case. Call e_credentials_prompter_prompt_finish() in callback to get to the provided credentials.

since: 3.16

e_credentials_prompter_prompt_finish

Finishes a credentials prompt previously started with e_credentials_prompter_prompt(). The out_source will have set a referenced ESource, for which the prompt was started. Unref it, when no longer needed. Similarly the out_credentials will have set a newly allocated ENamedParameters structure with provided credentials, which should be freed with e_named_credentials_free() when no longer needed. Both output arguments will be set to NULL on error and FALSE will be returned.

since: 3.16

e_credentials_prompter_register_impl

Registers a prompter implementation for a given authentication method. If there is registered a prompter for the same authentication_method, then the function does nothing, otherwise it adds its own reference on the prompter_impl, and uses it for that authentication method. One prompter_impl can be registered for multiple authentication methods.

since: 3.16

e_credentials_prompter_set_auto_prompt

Sets whether can respond to credential prompts automatically. That means that whenever any ESource will ask for credentials, it’ll try to provide them.

since: 3.16

e_credentials_prompter_set_auto_prompt_disabled_for

Sets whether the auto-prompt should be disabled for the given source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property.

since: 3.16

e_credentials_prompter_unregister_impl

Unregisters previously registered prompter_impl for the given autnetication_method with e_credentials_prompter_register_impl(). Function does nothing, if no such authentication method is registered or if it has set a different prompter implementation.

since: 3.16

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from EExtensible (3)
e_extensible_list_extensions

Returns a list of EExtension objects bound to extensible whose types are ancestors of extension_type. For a complete list of extension objects bound to extensible, pass E_TYPE_EXTENSION.

e_extensible_load_extensions

Creates an instance of all instantiable subtypes of EExtension which target the class of extensible. The lifetimes of these newly created EExtension objects are bound to extensible such that they are finalized when extensible is finalized.

e_extensible_reload_extensions

Similar to e_extensible_load_extensions(), only loads newly discovered extensions again. This can help in case a new module had been loaded to the process, which provides the extensions for the extensible.

Properties

EDataServerUI.CredentialsPrompter:auto-prompt

Whether the ECredentialsPrompter can response to credential requests automatically.

since: 3.16

EDataServerUI.CredentialsPrompter:provider

The ESourceCredentialsProvider object, which the prompter uses.

since: 3.16

EDataServerUI.CredentialsPrompter:registry

The ESourceRegistry object, to whose credential requests the prompter listens.

since: 3.16

Signals

EDataServerUI.CredentialsPrompter::get-dialog-parent

Emitted when a new dialog will be shown, to get the right parent window for it. If the result of the call is NULL, then it tries to get the window from the default GtkApplication.

since: 3.16

EDataServerUI.CredentialsPrompter::get-dialog-parent-full

Emitted when a new dialog will be shown, to get the right parent window for it. If the result of the call is NULL, then it tries to get the window from the default GtkApplication.

since: 3.42

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct EDataServerUICredentialsPrompterClass {
  GObjectClass parent_class;
  GtkWindow* (* get_dialog_parent) (
    ECredentialsPrompter* prompter
  );
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.

get_dialog_parent: GtkWindow* (* get_dialog_parent) ( ECredentialsPrompter* prompter )

No description available.

Virtual methods

EDataServerUI.CredentialsPrompterClass.get_dialog_parent

Returns a GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don’t have any suitable window, then there’s chosen the last active window from the default GApplication, if any available.

since: 3.16