Class MfaPhoneChallenge

constructor

• new MfaPhoneChallenge(): MfaPhoneChallenge

  Initializes a new instance of the MfaPhoneChallenge class. It sets up the screen-specific data by creating an instance of ScreenOverride.

  Returns MfaPhoneChallenge

screen

StaticscreenIdentifier

continue

• continue(payload: Classes.MfaPhoneChallengeContinueOptions): Promise<void>

  Submits the user's choice of receiving the MFA code via SMS or voice call. It uses the phone number provided in the screen context.

  Parameters

  • payload: Classes.MfaPhoneChallengeContinueOptions

    Options containing the delivery type ('sms' or 'voice').

  Returns Promise<void>

  A promise that resolves upon successful submission.

  Throws

  Throws an error if the phone number is not available in the screen context or if the submission fails.

  Example

  const mfaPhoneChallenge = new MfaPhoneChallenge();
  // Request code via SMS
  await mfaPhoneChallenge.continue({ type: 'sms' });
  // Request code via Voice Call
  await mfaPhoneChallenge.continue({ type: 'voice' });
  Copy

pickPhone

• pickPhone(payload?: Classes.MfaPhoneChallengePickPhoneOptions): Promise<void>

  Initiates the process for the user to select a different phone number (if applicable). This typically triggers a navigation to a phone selection screen.

  Parameters

  • Optionalpayload: Classes.MfaPhoneChallengePickPhoneOptions

    Optional custom options for the request.

  Returns Promise<void>

  A promise that resolves upon successful submission.

  Throws

  Throws an error if the submission fails.

  Example

  const mfaPhoneChallenge = new MfaPhoneChallenge();
  await mfaPhoneChallenge.pickPhone();
  Copy

tryAnotherMethod

• tryAnotherMethod(
      payload?: Classes.MfaPhoneChallengePickAuthenticatorOptions,
  ): Promise<void>

  Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). This typically triggers navigation to the authenticator selection screen.

  Parameters

  • Optionalpayload: Classes.MfaPhoneChallengePickAuthenticatorOptions

    Optional custom options for the request.

  Returns Promise<void>

  A promise that resolves upon successful submission.

  Throws

  Throws an error if the submission fails.

  Example

  const mfaPhoneChallenge = new MfaPhoneChallenge();
  await mfaPhoneChallenge.tryAnotherMethod();
  Copy