Class MfaEmailList

Class implementing the mfa-email-list screen functionality This screen allows users to select an enrolled email address for MFA

Hierarchy

BaseContext
- MfaEmailList

Implements

Screens.MfaEmailListMembers

Index

Constructors

Properties

branding client organization prompt screen tenant transaction untrustedData user screenIdentifier

Methods

getErrors goBack selectMfaEmail

Constructors

constructor

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

Returns MfaEmailList
Overrides BaseContext.constructor
- Defined in src/screens/mfa-email-list/index.ts:31

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnMfaEmailList

The screen object for the mfa-email-list screen

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.MFA_EMAIL_LIST

Methods

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

goBack

goBack(payload?: Screens.CustomOptions): Promise<void>
Navigates back to the previous screen
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.goBack();
```
Implementation of MfaEmailListMembers.goBack
- Defined in src/screens/mfa-email-list/index.ts:77

selectMfaEmail

selectMfaEmail(payload: Screens.SelectMfaEmailOptions): Promise<void>
Selects an enrolled email address from the list
Parameters
- payload: Screens.SelectMfaEmailOptions
  The options containing the selection action
Returns Promise<void>
Example
```
import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.selectMfaEmail({
  index: 0 // for demonstration we are selecting the first index
});
```
Implementation of MfaEmailListMembers.selectMfaEmail
- Defined in src/screens/mfa-email-list/index.ts:50