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

backendGet

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

- Defined in Secret-1.d.ts:313
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

backendGetFinish

backendGetFinish(result: AsyncResult): Secret.Backend

- Defined in Secret-1.d.ts:318
Complete an asynchronous operation to get a #SecretBackend.

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

errorGetQuark

errorGetQuark(): Quark

- Defined in Secret-1.d.ts:322
Get the error quark.

Returns Quark

getSchema

getSchema(type: SchemaType): Secret.Schema

- Defined in Secret-1.d.ts:330
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

passwordClear

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

- Defined in Secret-1.d.ts:350
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

passwordClearFinish

passwordClearFinish(result: AsyncResult): boolean

- Defined in Secret-1.d.ts:336
Finish an asynchronous operation to remove passwords from the secret service.

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

passwordClearSync

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

- Defined in Secret-1.d.ts:364
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

passwordLookup

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

- Defined in Secret-1.d.ts:383
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

passwordLookupFinish

passwordLookupFinish(result: AsyncResult): string

- Defined in Secret-1.d.ts:369
Finish an asynchronous operation to lookup a password in the secret service.

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

passwordLookupSync

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

- Defined in Secret-1.d.ts:397
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

passwordSearch

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

- Defined in Secret-1.d.ts:415
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

passwordSearchFinish

passwordSearchFinish(result: AsyncResult): Retrievable[]

- Defined in Secret-1.d.ts:402
Finish an asynchronous operation to search for items in the secret service.

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

passwordSearchSync

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

- Defined in Secret-1.d.ts:430
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[]

passwordStore

passwordStore(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 Secret-1.d.ts:457
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

passwordStoreBinary

passwordStoreBinary(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 Secret-1.d.ts:473
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

passwordStoreBinarySync

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

- Defined in Secret-1.d.ts:489
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

passwordStoreFinish

passwordStoreFinish(result: AsyncResult): boolean

- Defined in Secret-1.d.ts:435
Finish asynchronous operation to store a password in the secret service.

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

passwordStoreSync

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

- Defined in Secret-1.d.ts:511
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

passwordWipe(password: string): void

- Defined in Secret-1.d.ts:516
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

backendGet

Parameters

flags: BackendFlags

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

backendGetFinish

Parameters

result: AsyncResult

Returns Secret.Backend

errorGetQuark

Returns Quark

getSchema

Parameters

type: SchemaType

Returns Secret.Schema

passwordClear

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

passwordClearFinish

Parameters

result: AsyncResult

Returns boolean

passwordClearSync

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

Returns boolean

passwordLookup

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

passwordLookupFinish

Parameters

result: AsyncResult

Returns string

passwordLookupSync

Parameters

schema: Secret.Schema

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

cancellable: Gio.Cancellable

Returns string

passwordSearch

Parameters

schema: Secret.Schema

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

flags: Secret.SearchFlags

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

passwordSearchFinish

Parameters

result: AsyncResult

Returns Retrievable[]

passwordSearchSync

Parameters

schema: Secret.Schema

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