@nevis-security/nevis-mobile-authentication-sdk-react
Version:
React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.
50 lines • 1.9 kB
TypeScript
/**
* Copyright © 2023 Nevis Security AG. All rights reserved.
*/
import { PromptOptions } from './PromptOptions';
/**
* Defines the elements of the biometric prompt (title, description and cancel button text).
*
* @see {@link BiometricUserVerificationHandler.listenForOsCredentials}
*/
export declare abstract class BiometricPromptOptions extends PromptOptions {
/**
* The title to be used to prompt the user.
*
* **IMPORTANT** \
* Prompt title is supported only on Android and is ignored on iOS.
*/
abstract title: string;
/**
* The cancel button text.
*/
abstract cancelButtonText: 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.
*/
abstract fallbackButtonText?: string;
/**
* Default constructor for {@link BiometricPromptOptions}.
*
* @param title the title to be used to prompt the user.
* @param cancelButtonText the cancel button text.
* @param description the optional description to be used to prompt the user.
* @param fallbackButtonText the fallback button text.
* @returns the created {@link BiometricPromptOptions} instance.
*/
static create(title: string, cancelButtonText: string, description?: string, fallbackButtonText?: string): BiometricPromptOptions;
}
export declare class BiometricPromptOptionsImpl extends BiometricPromptOptions {
title: string;
description?: string;
cancelButtonText: string;
fallbackButtonText?: string;
constructor(title: string, cancelButtonText: string, description?: string, fallbackButtonText?: string);
}
//# sourceMappingURL=BiometricPromptOptions.d.ts.map