Class ResetPasswordMfaPhoneChallenge

ResetPasswordMfaPhoneChallenge

Hierarchy

BaseContext
- ResetPasswordMfaPhoneChallenge

Implements

Screens.ResetPasswordMfaPhoneChallengeMembers

Index

Constructors

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.
Overrides BaseContext.constructor
- Defined in src/screens/reset-password-mfa-phone-challenge/index.ts:41

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

Access to client-specific information (e.g., client ID, name).

organization

organization: Screens.OrganizationMembers

Access to organization-specific information, if applicable.

prompt

prompt: Screens.PromptMembers

Access to prompt details (e.g., prompt name).

screen

screen: Screens.ScreenMembersOnResetPasswordMfaPhoneChallenge

Holds the specific screen data and properties, processed by ScreenOverride.

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

Access to the current transaction details (e.g., state, errors).

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_PHONE_CHALLENGE

The unique identifier for this screen, used internally and for telemetry.

Methods - Language

changeLanguage

changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>
Utility Feature
Changes the language/locale for the current authentication flow.

This method triggers a language change by submitting the new locale preference to the server with the 'change-language' action. The language change will cause the current screen to re-render with the new locale.
Parameters
- options: Screens.LanguageChangeOptions
  Language change options including the target language code
  
  Options for changing the language/locale during the authentication flow
  - [key: string]: string | number | boolean | undefined
    Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.
  - language: string
    Short language name (locale code) to be set (e.g., 'en', 'fr', 'es').
  - Optionalpersist?: "session"
    Defines persistence scope for the language preference. Currently only 'session' is supported.
    
    Default
    'session'
Returns Promise<void>
A promise that resolves when the form submission is complete
Example
```
import LoginId from "@auth0/auth0-acul-js/login-id";

const loginManager = new LoginId();

// Change language to French
await loginManager.changeLanguage({
  language: 'fr',
  persist: 'session'
});
```
Example
```
import LoginPassword from "@auth0/auth0-acul-js/login-password";

const loginPasswordManager = new LoginPassword();

// Change language to Spanish with additional custom data
await loginPasswordManager.changeLanguage({
  language: 'es',
  persist: 'session',
  'ulp-custom-field': 'custom-value'
});
```
Remarks
- This method is available on all screen instances that extend BaseContext
- The language must be one of the enabled locales configured in your Auth0 tenant
- The screen will automatically re-render with the new language after submission
- Custom fields can be included and will be accessible in the Post Login Trigger
Implementation of ResetPasswordMfaPhoneChallengeMembers.changeLanguage
Inherited from BaseContext.changeLanguage
- Defined in src/models/base-context.ts:156

Methods - Other

continue

continue(
payload: Screens.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: Screens.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);
}
```
Implementation of ResetPasswordMfaPhoneChallengeMembers.continue
- Defined in src/screens/reset-password-mfa-phone-challenge/index.ts:65

getErrors

getErrors(): Screens.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Screens.Error[]
An array of error objects from the transaction context.
Implementation of ResetPasswordMfaPhoneChallengeMembers.getErrors
Inherited from BaseContext.getErrors
- Defined in src/models/base-context.ts:103

tryAnotherMethod

tryAnotherMethod(
payload: Screens.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: Screens.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);
}
```
Implementation of ResetPasswordMfaPhoneChallengeMembers.tryAnotherMethod
- Defined in src/screens/reset-password-mfa-phone-challenge/index.ts:108

Class ResetPasswordMfaPhoneChallenge

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns ResetPasswordMfaPhoneChallenge

Throws

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

StaticscreenIdentifier

Methods - Language

changeLanguage

Parameters

[key: string]: string | number | boolean | undefined

language: string

Optionalpersist?: "session"

Default

Returns Promise<void>

Example

Example

Remarks

Methods - Other

continue

Parameters

Returns Promise<void>

Throws

Example

getErrors

Returns Screens.Error[]

tryAnotherMethod

Parameters

Returns Promise<void>

Throws

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"