EmailOTPChallenge

Represents the Email OTP Challenge screen.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.submitCode({
  code: '123456',
});

Constructors

EmailOTPChallenge · Constructor

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

getErrors

Retrieves the array of transaction errors from the context, or an empty array if none exist.

An array of error objects from the transaction context.

resendCode · Promise<void>

Requests a new OTP code to be sent to the user’s email.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.resendCode();

Show Parameters

options?

Optional parameters to include in the resend request.

resendManager

Utility Feature

Gets resend functionality with timeout management for this screen

ResendControl object with startResend method

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
const { startResend } = emailOTPChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Call startResend when user clicks resend button
startResend();

Show Parameters

options?

Configuration options for resend functionality

Properties

onStatusChange?

onTimeout · void

timeoutSeconds? · number

submitCode · Promise<void>

Submits the OTP code entered by the user.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.submitCode({
  code: '123456',
});

Show Parameters

options

Optional parameters to include in the submission.

Properties

code · string

The OTP code that the user enters to submit.