Class MfaEmailChallenge

constructor

• new MfaEmailChallenge(): MfaEmailChallenge

  Creates an instance of MfaEmailChallenge screen manager

  Returns MfaEmailChallenge

screen

untrustedData

StaticscreenIdentifier

continue

• continue(payload: Screens.ContinuePayloadOptions): Promise<void>

  Continues with the email challenge using the provided code

  Parameters

  • payload: Screens.ContinuePayloadOptions

    The options containing the code and rememberDevice flag

  Returns Promise<void>

  Example

  import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
  
  const mfaEmailChallenge = new MfaEmailChallenge();
  await mfaEmailChallenge.continue({
    code: '123456',
    rememberDevice: true
  });
  Copy

pickEmail

• pickEmail(payload?: Screens.CustomOptions): Promise<void>

  Submits the action to pick a different Email configuration, if available.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional payload.

  Returns Promise<void>

  Example

  import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
  
  const mfaEmailChallenge = new MfaEmailChallenge();
  await mfaEmailChallenge.pickEmail();
  Copy

resendCode

• resendCode(payload?: Screens.ResendCodePayloadOptions): Promise<void>

  Resends the email code

  Parameters

  • Optionalpayload: Screens.ResendCodePayloadOptions

    Optional custom options to include with the request

  Returns Promise<void>

  Example

  import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
  
  const mfaEmailChallenge = new MfaEmailChallenge();
  await mfaEmailChallenge.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 MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
  
  const mfaEmailChallenge = new MfaEmailChallenge();
  const { startResend } = mfaEmailChallenge.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

tryAnotherMethod

• tryAnotherMethod(
      payload?: Screens.TryAnotherMethodPayloadOptions,
  ): Promise<void>

  Allows the user to try another MFA method

  Parameters

  • Optionalpayload: Screens.TryAnotherMethodPayloadOptions

    Optional custom options to include with the request

  Returns Promise<void>

  Example

  import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
  
  const mfaEmailChallenge = new MfaEmailChallenge();
  await mfaEmailChallenge.tryAnotherMethod();
  Copy