Class MfaPhoneChallenge

MfaPhoneChallenge

Hierarchy

BaseContext
- MfaPhoneChallenge

Implements

Screens.MfaPhoneChallengeMembers

Index

Constructors

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

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnMfaPhoneChallenge

Holds the specific screen data for the MFA Phone Challenge.

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.MFA_PHONE_CHALLENGE

The unique identifier for this screen.

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 MfaPhoneChallengeMembers.changeLanguage
Inherited from BaseContext.changeLanguage
- Defined in src/models/base-context.ts:156

Methods - Other

continue

continue(payload: Screens.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: Screens.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' });
```
Implementation of MfaPhoneChallengeMembers.continue
- Defined in src/screens/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 MfaPhoneChallengeMembers.getErrors
Inherited from BaseContext.getErrors
- Defined in src/models/base-context.ts:103

pickPhone

pickPhone(payload?: Screens.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: Screens.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();
```
Implementation of MfaPhoneChallengeMembers.pickPhone
- Defined in src/screens/mfa-phone-challenge/index.ts:90

tryAnotherMethod

tryAnotherMethod(
payload?: Screens.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: Screens.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();
```
Implementation of MfaPhoneChallengeMembers.tryAnotherMethod
- Defined in src/screens/mfa-phone-challenge/index.ts:115

Class MfaPhoneChallenge

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns MfaPhoneChallenge

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[]

pickPhone

Parameters

Returns Promise<void>

Throws

Example

tryAnotherMethod

Parameters

Returns Promise<void>

Throws

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"