Nevis Mobile Authentication SDK React Native plugin
    Preparing search index...

    Class BiometricPromptOptionsAbstract

    Defines the elements of the biometric prompt (title, description and cancel button text).

    BiometricUserVerificationHandler.listenForOsCredentials

    Hierarchy (View Summary)

    Index

    Properties

    title cancelButtonText fallbackButtonText? description?

    Methods

    create

    Properties

    title: string

    The title to be used to prompt the user.

    IMPORTANT
    Prompt title is supported only on Android and is ignored on iOS.

    cancelButtonText: string

    The cancel button text.

    fallbackButtonText?: string

    The fallback button text.

    If set to empty string, the button will be hidden. A default title "Enter Password" is used when this property is unspecified.

    IMPORTANT
    Fallback button text is supported only on iOS and is ignored on Android.

    description?: string

    The optional description to be used to prompt the user.

    WARNING
    Specify this message carefully, as it may also be shown on the Device Passcode authentication screen on iOS if device passcode fallback is enabled during registration.

    NOTE
    This property is optional. If not specified, a default description will be used on iOS for the biometric prompt. For details on default values and further customization possibilities, see the Nevis Mobile Authentication SDK documentation.

    Methods

    • Default constructor for BiometricPromptOptions.

      Parameters

      • title: string

        the title to be used to prompt the user.

      • cancelButtonText: string

        the cancel button text.

      • Optionaldescription: string

        the optional description to be used to prompt the user.

      • OptionalfallbackButtonText: string

        the fallback button text.

      Returns BiometricPromptOptions

      the created BiometricPromptOptions instance.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods