/**
 * Copyright © 2023 Nevis Security AG. All rights reserved.
 */

/**
 * Defines the elements of a user prompt.
 *
 * Depending on the nature of the user prompt, this object will be either a {@link BiometricPromptOptions},
 * a {@link DevicePasscodePromptOptions} or a {@link FingerprintPromptOptions}.
 *
 * @group User Interaction
 */
export abstract class PromptOptions {
	/**
	 * 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](https://docs.nevis.net/mobilesdk/guide/operation/registration#biometric-prompt-customization).
	 */
	abstract description?: string;
}