PluginOptions

The options passed the the IonicNativeAuthPlugin when creating a vault with getVault

Properties

allowSystemPinFallback

If biometric auth fails, allow system pin fallback.

Please note: when Android devices are set to allow system pin fallback, the behavior of the biometrics prompt changes. The OS biometric prompt will not report that biometrics failed nor that the user has been locked out of biometrics. It is only currently possible to know the user either canceled the authentication prompt, or was successful in verifying.

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"

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.

iosPromptText

For iOS, the localized explanation for authentication shown in the dialog presented to the user.

Default

"Authenticate to log in"

lockAfter

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

shouldClearVaultAfterTooManyFailedAttempts

After too many failed authentication attempts, should the vault be cleared?

Default

true

username

The username for the vault you wish to access

Inherited from: VaultDescriptor.username

vaultId

The vaultId for the vault you wish to access

Inherited from: VaultDescriptor.vaultId

Methods

onConfig

A handler that will receive events any time the vault is configuration is changed

Parameters

Name	Type
event	PluginConfiguration

Returns: any

onError

Called when there is an error during vault setup

Parameters

Name	Type	Description
error	VaultError	The VaultError that occurred.

Returns: any

onLock

A handler that will receive events any time the vault is locked

Parameters

Name	Type
event	LockEvent

Returns: any

onReady

Called when the vault is configured and available.

Parameters

Name	Type	Description
vault	IdentityVault	The IdentityVault instance.

Returns: any

onUnlock

A handler that will receive events any time the vault is unlocked

Parameters

Name	Type
event	PluginConfiguration

Returns: any