Secret.Backend

Implementations:

Secret.Service

Methods

class	get (flags, cancellable, callback, *user_data)
class	get_finish (result)

Virtual Methods

	do_clear (schema, attributes, cancellable, callback, *user_data)
	do_clear_finish (result)
	do_ensure_for_flags (flags, cancellable, callback, *user_data)
	do_ensure_for_flags_finish (result)
	do_lookup (schema, attributes, cancellable, callback, *user_data)
	do_lookup_finish (result)
	do_search (schema, attributes, flags, cancellable, callback, *user_data)
	do_store (schema, attributes, collection, label, value, cancellable, callback, *user_data)
	do_store_finish (result)

Properties

Name	Type	Flags	Short Description
flags	Secret.ServiceFlags	r/w/co	Service flags

Signals

None

Fields

None

Class Details

class Secret.Backend

Bases:

GObject.GInterface

Structure:

Secret.BackendInterface

Secret.Backend represents a backend implementation of password storage.

New in version 0.19.0.

classmethod get(flags, cancellable, callback, *user_data)

Parameters:

• flags (Secret.BackendFlags) – flags for which service functionality to ensure is initialized

• cancellable (Gio.Cancellable or None) – optional cancellation object

• callback (Gio.AsyncReadyCallback or None) – called when the operation completes

• user_data (object or None) – data to be passed to the callback

Get a Secret.Backend instance.

If such a backend already exists, then the same backend is returned.

If flags contains any flags of which parts of the secret backend to ensure are initialized, then those will be initialized before completing.

This method will return immediately and complete asynchronously.

New in version 0.19.0.

classmethod get_finish(result)

Parameters:

result (Gio.AsyncResult) – the asynchronous result passed to the callback

Raises:

GLib.Error

Returns:

a new reference to a Secret.Backend proxy, which should be released with [method`GObject`.Object.unref].

Return type:

Secret.Backend

Complete an asynchronous operation to get a Secret.Backend.

New in version 0.19.0.

do_clear(schema, attributes, cancellable, callback, *user_data) virtual

Parameters:

• schema (Secret.Schema) –

• attributes ({object: object}) –

• cancellable (Gio.Cancellable or None) –

• callback (Gio.AsyncReadyCallback or None) –

• user_data (object or None) –

implementation of [func`password_clear`], required

do_clear_finish(result) virtual

Parameters:

result (Gio.AsyncResult) –

Return type:

bool

implementation of [func`password_clear_finish`], required

do_ensure_for_flags(flags, cancellable, callback, *user_data) virtual

Parameters:

• flags (Secret.BackendFlags) –

• cancellable (Gio.Cancellable or None) –

• callback (Gio.AsyncReadyCallback or None) –

• user_data (object or None) –

implementation of reinitialization step in constructor, optional

do_ensure_for_flags_finish(result) virtual

Parameters:

result (Gio.AsyncResult) –

Return type:

bool

implementation of reinitialization step in constructor, optional

do_lookup(schema, attributes, cancellable, callback, *user_data) virtual

Parameters:

• schema (Secret.Schema) –

• attributes ({object: object}) –

• cancellable (Gio.Cancellable or None) –

• callback (Gio.AsyncReadyCallback or None) –

• user_data (object or None) –

implementation of [func`password_lookup`], required

do_lookup_finish(result) virtual

Parameters:

result (Gio.AsyncResult) –

Return type:

Secret.Value

implementation of [func`password_lookup_finish`], required

do_search(schema, attributes, flags, cancellable, callback, *user_data) virtual

Parameters:

• schema (Secret.Schema) –

• attributes ({object: object}) –

• flags (Secret.SearchFlags) –

• cancellable (Gio.Cancellable or None) –

• callback (Gio.AsyncReadyCallback or None) –

• user_data (object or None) –

implementation of [func`password_search`], required

do_store(schema, attributes, collection, label, value, cancellable, callback, *user_data) virtual

Parameters:

• schema (Secret.Schema) –

• attributes ({object: object}) –

• collection (str) –

• label (str) –

• value (Secret.Value) –

• cancellable (Gio.Cancellable or None) –

• callback (Gio.AsyncReadyCallback or None) –

• user_data (object or None) –

implementation of [func`password_store`], required

do_store_finish(result) virtual

Parameters:

result (Gio.AsyncResult) –

Return type:

bool

implementation of [func`password_store_finish`], required

Property Details

Secret.Backend.props.flags

Name:

flags

Type:

Secret.ServiceFlags

Default Value:

Secret.ServiceFlags.NONE

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

A set of flags describing which parts of the secret backend have been initialized.

New in version 0.19.0.