Class

PurpleCredentialProvider

since: 3.0.0

Description [src] 

abstract class Purple.CredentialProvider : GObject.Object {
  parent_instance: GObject
}

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.0

Ancestors

Descendants

Instance methods

purple_credential_provider_clear_password_async

Clears the password for account from provider.

since: 3.0.0

purple_credential_provider_clear_password_finish

Finishes a previous call to purple_credential_provider_clear_password_async().

since: 3.0.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.

since: 3.0.0

purple_credential_provider_get_id

Gets the identifier of provider.

since: 3.0.0

purple_credential_provider_get_name

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

since: 3.0.0

purple_credential_provider_get_settings

Gets the GSettings that provider provides.

since: 3.0.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.

since: 3.0.0

purple_credential_provider_read_password_async

Reads the password for account from provider.

since: 3.0.0

purple_credential_provider_read_password_finish

Finishes a previous call to purple_credential_provider_read_password_async().

since: 3.0.0

purple_credential_provider_write_password_async

Writes password for account to provider.

since: 3.0.0

purple_credential_provider_write_password_finish

Finishes a previous call to purple_credential_provider_write_password_async().

since: 3.0.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.CredentialProvider:description
No description available.

Purple.CredentialProvider:id
No description available.

Purple.CredentialProvider:name
No description available.

Purple.CredentialProvider:settings
No description available.

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 {
  void (* activate) (
    PurpleCredentialProvider* provider
  );
  void (* deactivate) (
    PurpleCredentialProvider* provider
  );
  void (* read_password_async) (
    PurpleCredentialProvider* provider,
    PurpleAccount* account,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gchar* (* read_password_finish) (
    PurpleCredentialProvider* provider,
    GAsyncResult* result,
    GError** error
  );
  void (* write_password_async) (
    PurpleCredentialProvider* provider,
    PurpleAccount* account,
    const gchar* 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
  );
  
}

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

Class members
activate: void (* activate) ( PurpleCredentialProvider* provider )
No description available.
deactivate: void (* deactivate) ( PurpleCredentialProvider* provider )
No description available.
read_password_async: void (* read_password_async) ( PurpleCredentialProvider* provider, PurpleAccount* account, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data )
No description available.
read_password_finish: gchar* (* read_password_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error )
No description available.
write_password_async: void (* write_password_async) ( PurpleCredentialProvider* provider, PurpleAccount* account, const gchar* password, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data )
No description available.
write_password_finish: gboolean (* write_password_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error )
No description available.
clear_password_async: void (* clear_password_async) ( PurpleCredentialProvider* provider, PurpleAccount* account, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data )
No description available.
clear_password_finish: gboolean (* clear_password_finish) ( PurpleCredentialProvider* provider, GAsyncResult* result, GError** error )
No description available.

Virtual methods

Purple.CredentialProviderClass.activate
No description available.

Purple.CredentialProviderClass.clear_password_async

Clears the password for account from provider.

since: 3.0.0

Purple.CredentialProviderClass.clear_password_finish

Finishes a previous call to purple_credential_provider_clear_password_async().

since: 3.0.0

Purple.CredentialProviderClass.deactivate
No description available.

Purple.CredentialProviderClass.read_password_async

Reads the password for account from provider.

since: 3.0.0

Purple.CredentialProviderClass.read_password_finish

Finishes a previous call to purple_credential_provider_read_password_async().

since: 3.0.0

Purple.CredentialProviderClass.write_password_async

Writes password for account to provider.

since: 3.0.0

Purple.CredentialProviderClass.write_password_finish

Finishes a previous call to purple_credential_provider_write_password_async().

since: 3.0.0