Class MfaVoiceChallenge

constructor

• new MfaVoiceChallenge(): MfaVoiceChallenge

  Creates an instance of MfaVoiceChallenge.

  Returns MfaVoiceChallenge

screen

untrustedData

StaticscreenIdentifier

continue

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

  Submits the voice verification code to validate the MFA challenge.

  Parameters

  • payload: Screens.MfaVoiceChallengeContinueOptions

    Object containing the verification code and optional parameters

  Returns Promise<void>

  Promise that resolves when the code is successfully validated

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.continue({
    code: '123456',
    rememberDevice: true
  });
  Copy

pickPhone

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

  Navigates to the screen for selecting a different phone number.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when navigation is complete

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.pickPhone();
  Copy

resendCode

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

  Requests a new voice call with a verification code.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when the new code is sent

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.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 MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';
  
  const mfaVoiceChallenge = new MfaVoiceChallenge();
  const { startResend } = mfaVoiceChallenge.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

switchToSms

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

  Switches to SMS verification method instead of voice call.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when switching is complete

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.switchToSms();
  Copy

tryAnotherMethod

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

  Navigates to the screen for selecting an alternative MFA method.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when navigation is complete

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.tryAnotherMethod();
  Copy