Class MfaEmailChallenge

Class implementing the mfa-email-challenge screen functionality This screen is shown when a user needs to verify their email during MFA

Hierarchy

BaseContext
- MfaEmailChallenge

Implements

Screens.MfaEmailChallengeMembers

Index

Constructors

constructor

new MfaEmailChallenge(): MfaEmailChallenge
Creates an instance of MfaEmailChallenge screen manager

Returns MfaEmailChallenge
Overrides BaseContext.constructor
- Defined in src/screens/mfa-email-challenge/index.ts:35

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnMfaEmailChallenge

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembersOnMfaEmailChallenge

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.MFA_EMAIL_CHALLENGE

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

Methods - Other

continue

continue(payload: Screens.ContinuePayloadOptions): Promise<void>
Continues with the email challenge using the provided code
Parameters
- payload: Screens.ContinuePayloadOptions
  The options containing the code and rememberDevice flag
Returns Promise<void>
Example
```
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});
```
Implementation of MfaEmailChallengeMembers.continue
- Defined in src/screens/mfa-email-challenge/index.ts:57

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

pickEmail

pickEmail(payload?: Screens.CustomOptions): Promise<void>
Submits the action to pick a different Email configuration, if available.
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional payload.
Returns Promise<void>
Example
```
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.pickEmail();
```
Implementation of MfaEmailChallengeMembers.pickEmail
- Defined in src/screens/mfa-email-challenge/index.ts:126

resendCode

resendCode(payload?: Screens.ResendCodePayloadOptions): Promise<void>
Resends the email code
Parameters
- Optionalpayload: Screens.ResendCodePayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.resendCode();
```
Implementation of MfaEmailChallengeMembers.resendCode
- Defined in src/screens/mfa-email-challenge/index.ts:81

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 MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
const { startResend } = mfaEmailChallenge.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 MfaEmailChallengeMembers.resendManager
- Defined in src/screens/mfa-email-challenge/index.ts:162

tryAnotherMethod

tryAnotherMethod(
payload?: Screens.TryAnotherMethodPayloadOptions,
): Promise<void>
Allows the user to try another MFA method
Parameters
- Optionalpayload: Screens.TryAnotherMethodPayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.tryAnotherMethod();
```
Implementation of MfaEmailChallengeMembers.tryAnotherMethod
- Defined in src/screens/mfa-email-challenge/index.ts:103

Class MfaEmailChallenge

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns MfaEmailChallenge

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

pickEmail

Parameters

Returns Promise<void>

Example

resendCode

Parameters

Returns Promise<void>

Example

resendManager

Parameters

OptionalonStatusChange?: Screens.OnStatusChangeCallback

OptionalonTimeout?: () => void

OptionaltimeoutSeconds?: number

Returns Screens.ResendControl

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