Class MfaSmsChallenge

constructor

• new MfaSmsChallenge(): MfaSmsChallenge

  Creates an instance of MfaSmsChallenge screen manager

  Returns MfaSmsChallenge

screen

untrustedData

StaticscreenIdentifier

continueMfaSmsChallenge

• continueMfaSmsChallenge(payload: Screens.MfaSmsChallengeOptions): Promise<void>

  Submits the MFA SMS challenge with the provided code and rememberDevice option.

  Parameters

  • payload: Screens.MfaSmsChallengeOptions

    The payload containing the code and rememberDevice option.

  Returns Promise<void>

  Example

  import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
  
  const mfaSmsChallenge = new MfaSmsChallenge();
  await mfaSmsChallenge.continueMfaSmsChallenge({
    code: '123456',
    rememberDevice: true,
  });
  Copy

getACall

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

  Submits the action to switch to voice call verification.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional payload.

  Returns Promise<void>

  Example

  import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
  
  const mfaSmsChallenge = new MfaSmsChallenge();
  await mfaSmsChallenge.getACall();
  Copy

pickSms

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

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

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional payload.

  Returns Promise<void>

  Example

  import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
  
  const mfaSmsChallenge = new MfaSmsChallenge();
  await mfaSmsChallenge.pickSms();
  Copy

resendCode

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

  Submits the action to resend the SMS code.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional payload.

  Returns Promise<void>

  Example

  import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
  
  const mfaSmsChallenge = new MfaSmsChallenge();
  await mfaSmsChallenge.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 MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
  
  const mfaSmsChallenge = new MfaSmsChallenge();
  const { startResend } = mfaSmsChallenge.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.CustomOptions): Promise<void>

  Submits the action to try another MFA method.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional payload.

  Returns Promise<void>

  Example

  import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
  
  const mfaSmsChallenge = new MfaSmsChallenge();
  await mfaSmsChallenge.tryAnotherMethod();
  Copy