Skip to main content
Version: 4.3

PluginConfiguration

The configuration returned from IonicNativeAuthPlugin when getConfig is called.

Properties

descriptor

The values the uniquely identify the vault

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.

isBiometricsEnabled

Whether biometric authentication is enabled for the vault

isPasscodeEnabled

Whether passcode authentication is enabled for the vault

isPasscodeSetupNeeded

Whether a passcode needs to be set with setPasscode

isSecureStorageModeEnabled

Whether AuthMode.SecureStorage is enabled for the vault

lockAfter

The amount of number of milliseconds the app can be in the background for until the vault locks