Class EmailOTPChallenge

constructor

• new EmailOTPChallenge(): EmailOTPChallenge

  Returns EmailOTPChallenge

StaticscreenIdentifier

resendCode

• resendCode(options?: Screens.CustomOptions): Promise<void>

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

  Parameters

  • Optionaloptions: Screens.CustomOptions

    Optional parameters to include in the resend request.

  Returns Promise<void>

  Example

  import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
  
  const emailOTPChallenge = new EmailOTPChallenge();
  emailOTPChallenge.resendCode();
  Copy

resendManager

• resendManager(options?: Screens.StartResendOptions): Screens.ResendControl
  Utility Feature

  Gets resend functionality with timeout management for this screen

  Parameters

  • Optionaloptions: Screens.StartResendOptions

    Configuration options for resend functionality

    Options for configuring resend functionality

    • OptionalonStatusChange?: Screens.OnStatusChangeCallback

    • OptionalonTimeout?: () => void

    • OptionaltimeoutSeconds?: number

  Returns Screens.ResendControl

  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();
  Copy

submitCode

• submitCode(options: Screens.OtpCodeOptions): Promise<void>

  Submits the OTP code entered by the user.

  Parameters

  • options: Screens.OtpCodeOptions

    Optional parameters to include in the submission.

  Returns Promise<void>

  Example

  import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
  
  const emailOTPChallenge = new EmailOTPChallenge();
  emailOTPChallenge.submitCode({
    code: '123456',
  });
  Copy