Class

PurpleCredentialProvider

unstable since: 3.0

Description [src]

abstract class Purple.CredentialProvider : GObject.Object
{
  /* No available fields */
}

PurpleCredentialProvider is an abstract base class for implementing support for a specific password or keyring manager. At the time of this writing, libpurple ships with plugins for libsecret, macOS Keychain Access, KWallet, and the Windows Credentials store by subclassing PurpleCredentialProvider.

Available since: 3.0

Ancestors

GObject

Descendants

PurpleNoopCredentialProvider

Functions

purple_credential_provider_error_quark

The error domain to identify errors from PurpleCredentialProvider.

unstable since: 3.0

Instance methods

purple_credential_provider_clear_password_async

Clears the password for account from provider.

unstable since: 3.0

purple_credential_provider_clear_password_finish

Finishes a previous call to purple_credential_provider_clear_password_async().

unstable since: 3.0

purple_credential_provider_get_description

Gets the description of provider which can be displayed in user interfaces to help users figure out which provider to use.

unstable since: 3.0

purple_credential_provider_get_id

Gets the identifier of provider.

unstable since: 3.0

purple_credential_provider_get_locked_async

Checks if the credential provider is locked or not.

unstable since: 3.0

purple_credential_provider_get_locked_finish

Gets the result of whether or not the provider is locked.

unstable since: 3.0

purple_credential_provider_get_name

Gets the name of provider which can be show in user interfaces.

unstable since: 3.0

purple_credential_provider_get_settings

Gets the GSettings that provider provides.

unstable since: 3.0

purple_credential_provider_is_valid

Checks whether or not provider is setup correctly. This is primarily meant for #purple_credential_provider_register_provider to call to avoid programming errors, but can be used by anyone.

unstable since: 3.0

purple_credential_provider_read_password_async

Reads the password for account from provider.

unstable since: 3.0

purple_credential_provider_read_password_finish

Finishes a previous call to purple_credential_provider_read_password_async().

unstable since: 3.0

purple_credential_provider_unlock_async

Attempts to unlock the provider.

unstable since: 3.0

purple_credential_provider_unlock_finish

Gets the result from attempting to unlock the provider.

unstable since: 3.0

purple_credential_provider_write_password_async

Writes password for account to provider.

unstable since: 3.0

purple_credential_provider_write_password_finish

Finishes a previous call to purple_credential_provider_write_password_async().

unstable since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.CredentialProvider:description

The description of the provider which will be displayed to the user.

unstable since: 3.0

Purple.CredentialProvider:id

The ID of the provider. Used for preferences and other things that need to address it.

unstable since: 3.0

Purple.CredentialProvider:name

The name of the provider which will be displayed to the user.

unstable since: 3.0

Purple.CredentialProvider:settings

The GSettings used to configure the provider. This may be NULL.

unstable since: 3.0

Signals

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 PurpleCredentialProviderClass {
  GObjectClass parent;
  void (* activate) (
    PurpleCredentialProvider* provider
  );
  void (* deactivate) (
    PurpleCredentialProvider* provider
  );
  void (* get_locked_async) (
    PurpleCredentialProvider* provider,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* get_locked_finish) (
    PurpleCredentialProvider* provider,
    GAsyncResult* result,
    GError** error
  );
  void (* unlock_async) (
    PurpleCredentialProvider* provider,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* unlock_finish) (
    PurpleCredentialProvider* provider,
    GAsyncResult* result,
    GError** error
  );
  void (* read_password_async) (
    PurpleCredentialProvider* provider,
    PurpleAccount* account,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  char* (* read_password_finish) (
    PurpleCredentialProvider* provider,
    GAsyncResult* result,
    GError** error
  );
  void (* write_password_async) (
    PurpleCredentialProvider* provider,
    PurpleAccount* account,
    const char* password,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* write_password_finish) (
    PurpleCredentialProvider* provider,
    GAsyncResult* result,
    GError** error
  );
  void (* clear_password_async) (
    PurpleCredentialProvider* provider,
    PurpleAccount* account,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* clear_password_finish) (
    PurpleCredentialProvider* provider,
    GAsyncResult* result,
    GError** error
  );
  gpointer reserved;
  
}

PurpleCredentialProviderClass defines the interface for interacting with credential providers like libsecret, kwallet, etc.

Class members

parent: GObjectClass: No description available.
activate: void (* activate) ( PurpleCredentialProvider* provider ): Called when the provider is made active.
deactivate: void (* deactivate) ( PurpleCredentialProvider* provider ): Called when another provider has been made active.
get_locked_async: void (* get_locked_async) ( PurpleCredentialProvider* provider, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): No description available.
get_locked_finish: gboolean (* get_locked_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error ): No description available.
unlock_async: void (* unlock_async) ( PurpleCredentialProvider* provider, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): No description available.
unlock_finish: gboolean (* unlock_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error ): No description available.
read_password_async: void (* read_password_async) ( PurpleCredentialProvider* provider, PurpleAccount* account, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): Reads a password from the provider.
read_password_finish: char* (* read_password_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error ): Finishes reading a password.
write_password_async: void (* write_password_async) ( PurpleCredentialProvider* provider, PurpleAccount* account, const char* password, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): Writes a password to the provider.
write_password_finish: gboolean (* write_password_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error ): Finishes writing a password.
clear_password_async: void (* clear_password_async) ( PurpleCredentialProvider* provider, PurpleAccount* account, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): Clears a password from the provider.
clear_password_finish: gboolean (* clear_password_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error ): Finishes clearing a password from the provider.
reserved: gpointer: No description available.

Description [src]

Ancestors

Descendants

Functions

Instance methods

Methods inherited from GObject (43)

Properties

Signals

Signals inherited from GObject (1)

Class structure

Class members

Virtual methods