Interface BiometricEncryptedStorageManager

interface BiometricEncryptedStorageManager {
    delete(key: string): boolean;
    get(
        key: string,
        config?: BiometricConfig,
    ): Promise<BiometricEncryptedStorageGetResult>;
    has(key: string): boolean;
    set(
        key: string,
        value: string,
        config?: BiometricConfig,
    ): Promise<BiometricEncryptedStorageSetResult>;
}

Index

Methods

delete get has set

Methods

delete

delete(key: string): boolean
Deletes the key and the associated encrypted value.
Parameters
- key: string
Returns boolean
true if the key was deleted, or false if the key didn't exist.

get

get(
key: string,
config?: BiometricConfig,
): Promise<BiometricEncryptedStorageGetResult>
Retrieves an encrypted value associated with the key.

Note: This operation requires the user interaction, consider using ActivityManager.runUserInteraction to ensure that consequent UI-related operations are suspended until this one is completed.
Parameters
- key: string
  A key to get value for.
- Optionalconfig: BiometricConfig
  The options of the biometric prompt.
Returns Promise<BiometricEncryptedStorageGetResult>

has

has(key: string): boolean
Returns true if the key exists in the storage, or false otherwise.
Parameters
- key: string
Returns boolean

set

set(
    key: string,
    value: string,
    config?: BiometricConfig,
): Promise<BiometricEncryptedStorageSetResult>
Associates a value with a key in an encrypted storage.

Note: This operation requires the user interaction, consider using ActivityManager.runUserInteraction to ensure that consequent UI-related operations are suspended until this one is completed.
Parameters
- key: string
  A key to set.
- value: string
  A value to write.
- Optionalconfig: BiometricConfig
  The options of the biometric prompt.
Returns Promise<BiometricEncryptedStorageSetResult>