Namespace Secret

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const BACKEND_EXTENSION_POINT_NAME

BACKEND_EXTENSION_POINT_NAME: string

Extension point for the secret backend.

Const COLLECTION_DEFAULT

COLLECTION_DEFAULT: string

An alias to the default collection.

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

Const COLLECTION_SESSION

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.

Const MAJOR_VERSION

MAJOR_VERSION: number

The major version of libsecret.

Const MICRO_VERSION

MICRO_VERSION: number

The micro version of libsecret.

Const MINOR_VERSION

MINOR_VERSION: number

The minor version of libsecret.

Functions

backend_get

backend_get(flags: BackendFlags, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/Secret-1.d.ts:314
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
- flags: BackendFlags
  
  flags for which service functionality to ensure is initialized
- cancellable: Gio.Cancellable
  
  optional cancellation object
- callback: AsyncReadyCallback
  
  called when the operation completes
Returns void

backend_get_finish

backend_get_finish(result: AsyncResult): Secret.Backend

- Defined in @types/Gjs/Secret-1.d.ts:319
Complete an asynchronous operation to get a #SecretBackend.

Parameters
- result: AsyncResult
  
  the asynchronous result passed to the callback
Returns Secret.Backend

error_get_quark

error_get_quark(): Quark

- Defined in @types/Gjs/Secret-1.d.ts:323
Get the error quark.

Returns Quark

get_schema

get_schema(type: SchemaType): Secret.Schema

- Defined in @types/Gjs/Secret-1.d.ts:331
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
- type: SchemaType
  
  type of schema to get
Returns Secret.Schema

password_clear

password_clear(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/Secret-1.d.ts:351
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

password_clear_finish

password_clear_finish(result: AsyncResult): boolean

- Defined in @types/Gjs/Secret-1.d.ts:337
Finish an asynchronous operation to remove passwords from the secret service.

Parameters
- result: AsyncResult
  
  the asynchronous result passed to the callback
Returns boolean

password_clear_sync

password_clear_sync(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, cancellable: Gio.Cancellable): boolean

- Defined in @types/Gjs/Secret-1.d.ts:365
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

password_lookup

password_lookup(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/Secret-1.d.ts:384
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

password_lookup_finish

password_lookup_finish(result: AsyncResult): string

- Defined in @types/Gjs/Secret-1.d.ts:370
Finish an asynchronous operation to lookup a password in the secret service.

Parameters
- result: AsyncResult
  
  the asynchronous result passed to the callback
Returns string

password_lookup_sync

password_lookup_sync(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, cancellable: Gio.Cancellable): string

- Defined in @types/Gjs/Secret-1.d.ts:398
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

password_search

password_search(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, flags: Secret.SearchFlags, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/Secret-1.d.ts:416
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
- schema: Secret.Schema
  
  the schema for attributes
- attributes: HashTable<string | number | symbol, string | number | boolean>
  
  the attribute keys and values
- flags: Secret.SearchFlags
  
  search option flags
- cancellable: Gio.Cancellable
  
  optional cancellation object
- callback: AsyncReadyCallback
  
  called when the operation completes
Returns void

password_search_finish

password_search_finish(result: AsyncResult): Retrievable[]

- Defined in @types/Gjs/Secret-1.d.ts:403
Finish an asynchronous operation to search for items in the secret service.

Parameters
- result: AsyncResult
  
  the asynchronous result passed to the callback
Returns Retrievable[]

password_search_sync

password_search_sync(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, flags: Secret.SearchFlags, cancellable: Gio.Cancellable): Retrievable[]

- Defined in @types/Gjs/Secret-1.d.ts:431
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
- schema: Secret.Schema
  
  the schema for attributes
- attributes: HashTable<string | number | symbol, string | number | boolean>
  
  the attribute keys and values
- flags: Secret.SearchFlags
  
  search option flags
- cancellable: Gio.Cancellable
  
  optional cancellation object
Returns Retrievable[]

password_store

password_store(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, collection: string, label: string, password: string, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/Secret-1.d.ts:458
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

password_store_binary

password_store_binary(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, collection: string, label: string, value: Secret.Value, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/Secret-1.d.ts:474
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

password_store_binary_sync

password_store_binary_sync(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, collection: string, label: string, value: Secret.Value, cancellable: Gio.Cancellable): boolean

- Defined in @types/Gjs/Secret-1.d.ts:490
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

password_store_finish

password_store_finish(result: AsyncResult): boolean

- Defined in @types/Gjs/Secret-1.d.ts:436
Finish asynchronous operation to store a password in the secret service.

Parameters
- result: AsyncResult
  
  the asynchronous result passed to the callback
Returns boolean

password_store_sync

password_store_sync(schema: Secret.Schema, attributes: HashTable<string | number | symbol, string | number | boolean>, collection: string, label: string, password: string, cancellable: Gio.Cancellable): boolean

- Defined in @types/Gjs/Secret-1.d.ts:512
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

password_wipe

password_wipe(password: string): void

- Defined in @types/Gjs/Secret-1.d.ts:517
Clear the memory used by a password.

Parameters
- password: string
  
  password to clear
Returns void

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const BACKEND_EXTENSION_POINT_NAME

Const COLLECTION_DEFAULT

Const COLLECTION_SESSION

Const MAJOR_VERSION

Const MICRO_VERSION

Const MINOR_VERSION

Functions

backend_get

Parameters

flags: BackendFlags

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

backend_get_finish

Parameters

result: AsyncResult

Returns Secret.Backend

error_get_quark

Returns Quark

get_schema

Parameters

type: SchemaType

Returns Secret.Schema

password_clear

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

password_clear_finish

Parameters

result: AsyncResult

Returns boolean

password_clear_sync

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

Returns boolean

password_lookup

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

password_lookup_finish

Parameters

result: AsyncResult

Returns string

password_lookup_sync

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

Returns string

password_search

Parameters

schema: Secret.Schema

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

flags: Secret.SearchFlags

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

password_search_finish

Parameters

result: AsyncResult

Returns Retrievable[]

password_search_sync

Parameters

schema: Secret.Schema

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