Class MfaVoiceChallenge

MFA Voice Challenge screen implementation.

This screen is displayed when a user needs to verify their identity using a voice call as part of a multi-factor authentication flow.

Hierarchy

BaseContext
- MfaVoiceChallenge

Implements

Screens.MfaVoiceChallengeMembers

Index

Constructors

constructor

new MfaVoiceChallenge(): MfaVoiceChallenge
Creates an instance of MfaVoiceChallenge.

Returns MfaVoiceChallenge
Overrides BaseContext.constructor
- Defined in src/screens/mfa-voice-challenge/index.ts:41

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnMfaVoiceChallenge

Screen-specific properties and data.

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembersOnMfaVoiceChallenge

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.MFA_VOICE_CHALLENGE

Screen identifier for validation and 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 MfaVoiceChallengeMembers.changeLanguage
Inherited from BaseContext.changeLanguage
- Defined in src/models/base-context.ts:156

Methods - Other

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
});
```
Implementation of MfaVoiceChallengeMembers.continue
- Defined in src/screens/mfa-voice-challenge/index.ts:64

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 MfaVoiceChallengeMembers.getErrors
Inherited from BaseContext.getErrors
- Defined in src/models/base-context.ts:103

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();
```
Implementation of MfaVoiceChallengeMembers.pickPhone
- Defined in src/screens/mfa-voice-challenge/index.ts:91

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();
```
Implementation of MfaVoiceChallengeMembers.resendCode
- Defined in src/screens/mfa-voice-challenge/index.ts:139

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();
```
Implementation of MfaVoiceChallengeMembers.resendManager
- Defined in src/screens/mfa-voice-challenge/index.ts:203

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();
```
Implementation of MfaVoiceChallengeMembers.switchToSms
- Defined in src/screens/mfa-voice-challenge/index.ts:115

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();
```
Implementation of MfaVoiceChallengeMembers.tryAnotherMethod
- Defined in src/screens/mfa-voice-challenge/index.ts:163

Class MfaVoiceChallenge

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns MfaVoiceChallenge

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>

Example

getErrors

Returns Screens.Error[]

pickPhone

Parameters

Returns Promise<void>

Example

resendCode

Parameters

Returns Promise<void>

Example

resendManager

Parameters

OptionalonStatusChange?: Screens.OnStatusChangeCallback

OptionalonTimeout?: () => void

OptionaltimeoutSeconds?: number

Returns Screens.ResendControl

Example

switchToSms

Parameters

Returns Promise<void>

Example

tryAnotherMethod

Parameters

Returns Promise<void>

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"

`Optional`onStatusChange?: Screens.OnStatusChangeCallback

`Optional`onTimeout?: () => void

`Optional`timeoutSeconds?: number