Class MfaVoiceEnrollment

Class implementing the mfa-voice-enrollment screen functionality.

Hierarchy

BaseContext
- MfaVoiceEnrollment

Implements

Screens.MfaVoiceEnrollmentMembers

Index

Constructors

constructor

new MfaVoiceEnrollment(): MfaVoiceEnrollment
Creates an instance of MfaVoiceEnrollment screen manager.

Returns MfaVoiceEnrollment
Overrides BaseContext.constructor
- Defined in src/screens/mfa-voice-enrollment/index.ts:18

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembers

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.MFA_VOICE_ENROLLMENT

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

Methods - Other

continue

continue(payload: Screens.MfaVoiceEnrollmentContinueOptions): Promise<void>

Continues with the default action.

Parameters

payload: Screens.MfaVoiceEnrollmentContinueOptions
Optional payload.

Returns Promise<void>

Example

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment();
const handleContinueEnrollment = async () => {
 try {
   await mfaVoiceEnrollmentManager.continue({
     phone: '+1234567890',
     // Add any optional CustomOptions here if needed 
   });
   console.log('Voice enrollment continued successfully.');
 } catch (error) {
   console.error('Error continuing voice enrollment:', error);
 }
};

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

selectPhoneCountryCode

selectPhoneCountryCode(payload?: Screens.CustomOptions): Promise<void>
Allows picking a country code for the phone number
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional payload.
Returns Promise<void>
Example
```
import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();
const handlePickCountryCode = async () => {
 await mfaVoiceEnrollment.selectPhoneCountryCode();
};
```
Implementation of MfaVoiceEnrollmentMembers.selectPhoneCountryCode
- Defined in src/screens/mfa-voice-enrollment/index.ts:91

tryAnotherMethod

tryAnotherMethod(payload?: Screens.CustomOptions): Promise<void>
Allows trying another authentication method
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional payload.
Returns Promise<void>
Example
```
import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();
const handleTryAnotherMethod = async () => {
 await mfaVoiceEnrollment.tryAnotherMethod();
};
```
Implementation of MfaVoiceEnrollmentMembers.tryAnotherMethod
- Defined in src/screens/mfa-voice-enrollment/index.ts:67

Class MfaVoiceEnrollment

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns MfaVoiceEnrollment

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

selectPhoneCountryCode

Parameters

Returns Promise<void>

Example

tryAnotherMethod

Parameters

Returns Promise<void>

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"