Class ResetPasswordMfaPhoneChallenge

constructor

• new ResetPasswordMfaPhoneChallenge(): ResetPasswordMfaPhoneChallenge

  Initializes a new instance of the ResetPasswordMfaPhoneChallenge class. It retrieves the screen context and sets up the screen-specific properties.

  Returns ResetPasswordMfaPhoneChallenge

  Throws

  If the Universal Login Context is not available or if the screen name doesn't match.

screen

StaticscreenIdentifier

continue

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

  Sends the verification code to the user's phone via the selected method (SMS or Voice). Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default').

  Parameters

  • payload: Classes.ResetPasswordMfaPhoneChallengeContinueOptions

    Contains the delivery type (sms or voice) and any optional custom data.

  Returns Promise<void>

  A promise resolving upon successful submission to the server.

  Throws

  If the form submission fails.

  Example

  const screen = new ResetPasswordMfaPhoneChallenge();
  try {
    await screen.continue({ type: 'sms' });
    // Redirects to code entry screen on success
  } catch (error) {
    console.error("Failed to send SMS code:", error);
  }
  Copy

tryAnotherMethod

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

  Initiates the process for the user to select a different MFA authenticator. Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator').

  Parameters

  • payload: Classes.ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions

    Contains the current challenge type (sms or voice) as required by the API, and any optional custom data.

  Returns Promise<void>

  A promise resolving upon successful submission to the server.

  Throws

  If the form submission fails.

  Example

  const screen = new ResetPasswordMfaPhoneChallenge();
  try {
    // Assuming the current screen was for SMS
    await screen.tryAnotherMethod({ type: 'sms' });
    // Redirects to authenticator selection screen on success
  } catch (error) {
    console.error("Failed to switch MFA method:", error);
  }
  Copy