Gjsify LogoGjsify Logo

Index

Variables

BACKEND_EXTENSION_POINT_NAME: string

Extension point for the secret backend.

COLLECTION_DEFAULT: string

An alias to the default collection.

This can be passed to [funcpassword_store] [funcCollection.for_alias].

COLLECTION_SESSION: string

An alias to the session collection, which will be cleared when the user ends the session.

This can be passed to [funcpassword_store], [funcCollection.for_alias] or similar functions.

MAJOR_VERSION: number

The major version of libsecret.

MICRO_VERSION: number

The micro version of libsecret.

MINOR_VERSION: number

The minor version of libsecret.

Functions

  • Get a #SecretBackend 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.

    Parameters

    Returns void

  • Get a secret storage schema of the given type.

    C code may access the schemas (such as %SECRET_SCHEMA_NOTE) directly, but language bindings cannot, and must use this accessor.

    Parameters

    Returns Secret.Schema

  • Remove unlocked matching passwords from the secret service.

    The attributes should be a set of key and value string pairs.

    All unlocked items that match the attributes will be deleted.

    This method will return immediately and complete asynchronously.

    Parameters

    • schema: Secret.Schema

      the schema for the attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • cancellable: Gio.Cancellable

      optional cancellation object

    • callback: AsyncReadyCallback

      called when the operation completes

    Returns void

  • Finish an asynchronous operation to remove passwords from the secret service.

    Parameters

    • result: AsyncResult

      the asynchronous result passed to the callback

    Returns boolean

  • Remove unlocked matching passwords from the secret service.

    The attributes should be a set of key and value string pairs.

    All unlocked items that match the attributes will be deleted.

    This method may block indefinitely and should not be used in user interface threads.

    Parameters

    • schema: Secret.Schema

      the schema for the attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • cancellable: Gio.Cancellable

      optional cancellation object

    Returns boolean

  • Lookup a password in the secret service.

    The attributes should be a set of key and value string pairs.

    If no secret is found then %NULL is returned.

    This method will return immediately and complete asynchronously.

    Parameters

    • schema: Secret.Schema

      the schema for attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • cancellable: Gio.Cancellable

      optional cancellation object

    • callback: AsyncReadyCallback

      called when the operation completes

    Returns void

  • Finish an asynchronous operation to lookup a password in the secret service.

    Parameters

    • result: AsyncResult

      the asynchronous result passed to the callback

    Returns string

  • Lookup a password in the secret service.

    The attributes should be a set of key and value string pairs.

    If no secret is found then %NULL is returned.

    This method may block indefinitely and should not be used in user interface threads.

    Parameters

    • schema: Secret.Schema

      the schema for attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • cancellable: Gio.Cancellable

      optional cancellation object

    Returns string

  • Search for items in the secret service.

    The attributes should be a set of key and value string pairs.

    This method will return immediately and complete asynchronously.

    Parameters

    Returns void

  • Finish an asynchronous operation to search for items in the secret service.

    Parameters

    • result: AsyncResult

      the asynchronous result passed to the callback

    Returns Retrievable[]

  • Search for items in the secret service.

    The attributes should be a set of key and value string pairs.

    If no secret is found then %NULL is returned.

    This method may block indefinitely and should not be used in user interface threads.

    Parameters

    Returns Retrievable[]

  • Store a password in the secret service.

    The attributes should be a set of key and value string pairs.

    If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.

    If collection is %NULL, then the default collection will be used. Use [constCOLLECTION_SESSION] to store the password in the session collection, which doesn't get stored across login sessions.

    This method will return immediately and complete asynchronously.

    Parameters

    • schema: Secret.Schema

      the schema for attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • collection: string

      a collection alias, or D-Bus object path of the collection where to store the secret

    • label: string

      label for the secret

    • password: string

      the null-terminated password to store

    • cancellable: Gio.Cancellable

      optional cancellation object

    • callback: AsyncReadyCallback

      called when the operation completes

    Returns void

  • Store a password in the secret service.

    This is similar to [funcpassword_storev], but takes a [structValue] as the argument instead of a null-terminated password.

    This method will return immediately and complete asynchronously.

    Parameters

    • schema: Secret.Schema

      the schema for attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • collection: string

      a collection alias, or D-Bus object path of the collection where to store the secret

    • label: string

      label for the secret

    • value: Secret.Value

      a [structValue]

    • cancellable: Gio.Cancellable

      optional cancellation object

    • callback: AsyncReadyCallback

      called when the operation completes

    Returns void

  • Store a password in the secret service.

    This is similar to [funcpassword_storev_sync], but takes a [structValue] as the argument instead of a null-terminated passwords.

    This method may block indefinitely and should not be used in user interface threads.

    Parameters

    • schema: Secret.Schema

      the schema for attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • collection: string

      a collection alias, or D-Bus object path of the collection where to store the secret

    • label: string

      label for the secret

    • value: Secret.Value

      a [structValue]

    • cancellable: Gio.Cancellable

      optional cancellation object

    Returns boolean

  • Finish asynchronous operation to store a password in the secret service.

    Parameters

    • result: AsyncResult

      the asynchronous result passed to the callback

    Returns boolean

  • passwordStoreSync(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, collection: string, label: string, password: string, cancellable: Gio.Cancellable): boolean
  • Store a password in the secret service.

    The attributes should be a set of key and value string pairs.

    If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.

    If collection is %NULL, then the default collection will be used. Use [constCOLLECTION_SESSION] to store the password in the session collection, which doesn't get stored across login sessions.

    This method may block indefinitely and should not be used in user interface threads.

    Parameters

    • schema: Secret.Schema

      the schema for attributes

    • attributes: HashTable<string | number | symbol, string | number | boolean>

      the attribute keys and values

    • collection: string

      a collection alias, or D-Bus object path of the collection where to store the secret

    • label: string

      label for the secret

    • password: string

      the null-terminated password to store

    • cancellable: Gio.Cancellable

      optional cancellation object

    Returns boolean

  • passwordWipe(password: string): void
  • Clear the memory used by a password.

    Parameters

    • password: string

      password to clear

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method