Skip to main content
Version: 6.0

Interface: VaultTranslations

The set of native prompt strings that can be changed at runtime with updateTranslations().

Every property maps to the matching property on IdentityVaultConfig. Only the properties that you supply are changed. Any properties that are not provided are left as is. Updating these strings does not unlock the vault, change its configuration, or touch any stored data, and it never triggers a biometric or passcode prompt. The new values are used the next time a prompt is shown.

These cover the strings your app supplies to the prompt. The biometric frameworks also render text that no app can set through these APIs, such as the fingerprint sensor hint and "not recognized" messages on Android, and the "Face ID" label, the retry button, and the "Try Again" message on iOS. That text is localized by the operating system: on Android it follows the device language, and on iOS it follows the app's localizations and effective language. To change those strings, localize the app and switch its effective language rather than calling this method.

Properties

androidBiometricsNegativeButtonText

Optional androidBiometricsNegativeButtonText: string

  • Type: string

For Android, the text of the button to dismiss the biometric prompt.


androidBiometricsPromptDescription

Optional androidBiometricsPromptDescription: string

  • Type: string

For Android, the description text for the Android authentication prompt.


androidBiometricsPromptSubtitle

Optional androidBiometricsPromptSubtitle: string

  • Type: string

For Android, the subtitle text for the authentication prompt.


androidBiometricsPromptTitle

Optional androidBiometricsPromptTitle: string

  • Type: string

For Android, the title text for the authentication prompt.


iosBiometricsLocalizedCancelTitle

Optional iosBiometricsLocalizedCancelTitle: string

  • Type: string

For iOS, the localized title for the cancel button in the dialog presented to the user during authentication. If null, iOS will use an appropriate default value, like "Cancel".


iosBiometricsLocalizedFallbackTitle

Optional iosBiometricsLocalizedFallbackTitle: string

  • Type: string

For iOS, the localized title for the fallback button presented to the user during authentication. If null, iOS will use an appropriate default value, like "Use Passcode".


iosBiometricsLocalizedReason

Optional iosBiometricsLocalizedReason: string

  • Type: string

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