VaultOptions
The options passed in to initialize the vault.
Properties
allowSystemPinFallback
If biometric auth fails, allow system pin fallback.
Default
false
androidPromptDescription
The description text for the Android authentication prompt.
Default
null
androidPromptNegativeButtonText
The cancel text for the Android authentication prompt.
Default
"Cancel"
androidPromptSubtitle
The subtitle text for the Android authentication prompt.
Default
null
androidPromptTitle
The title text for the Android authentication prompt.
Default
"Please Authenticate"
authMode
The AuthMode to configure a new vault with. Note: This will only affect newly created vaults. Vaults with existing data and configuration will use there previous configuration. They can be change by unlocking and then chaning the AuthMode.
Default
hideScreenOnBackground
Obscures the app when backgrounded to avoid leaking sensitive information, such as financial statements or balances. App screenshots won't work on Android 10 devices using gesture navigation if this option is set to true.
Default
false
iosPromptText
For iOS, the prompt text for the biometric prompt
Default
"Authenticate to log in"
lockAfter
The amount of number of milliseconds the app can be in the background for until the vault locks. A value of 0 means the vault won't lock in the background.
Default
0
restoreSessionOnReady
Whether or not to attempt to automatically restore the session when the vault is ready If restoreSessionOnReady and unlockOnAccess are both true the vault will be immediately unlocked & the session restored if onReady if the vault is in use.
Default
false
shouldClearVaultAfterTooManyFailedAttempts
After too many failed authentication attempts, should the vault be cleared?
Default
true
unlockOnAccess
Whether or not to attempt to automatically unlock the vault when a value is accessed. If restoreSessionOnReady and unlockOnAccess are both true the vault will be immediately unlocked & the session restored if onReady if the vault is in use.
Default
false
unlockOnReady
Whether or not to attempt to automatically unlock the vault when the vault is ready
Default
false