Class EmailIdentifierChallenge

Hierarchy

BaseContext
- EmailIdentifierChallenge

Implements

Classes.EmailIdentifierChallengeMembers

Index

Constructors

Properties

branding client organization prompt screen tenant transaction untrustedData user screenIdentifier

Methods

getError resendCode returnToPrevious submitEmailChallenge

Constructors

constructor

new EmailIdentifierChallenge(): EmailIdentifierChallenge
Returns EmailIdentifierChallenge
Overrides BaseContext.constructor
- Defined in src/screens/email-identifier-challenge/index.ts:20

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembersOnEmailIdentifierChallenge

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembers

untrustedData

untrustedData: Classes.UntrustedDataMembers

user

user: Classes.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.EMAIL_IDENTIFIER_CHALLENGE

Methods

getError

getError(): Classes.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Classes.Error[]
An array of error objects from the transaction context.
Inherited from BaseContext.getError
- Defined in src/models/base-context.ts:99

resendCode

resendCode(payload?: Classes.CustomOptions): Promise<void>
Parameters
- Optionalpayload: Classes.CustomOptions
Returns Promise<void>
Example
```
import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';

const emailIdentifierChallenge = new EmailIdentifierChallenge();
emailIdentifierChallenge.resendCode();
```
Implementation of EmailIdentifierChallengeMembers.resendCode
- Defined in src/screens/email-identifier-challenge/index.ts:50

returnToPrevious

returnToPrevious(payload?: Classes.CustomOptions): Promise<void>
Parameters
- Optionalpayload: Classes.CustomOptions
Returns Promise<void>
Example
```
import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';

const emailIdentifierChallenge = new EmailIdentifierChallenge();
emailIdentifierChallenge.returnToPrevious();
```
Implementation of EmailIdentifierChallengeMembers.returnToPrevious
- Defined in src/screens/email-identifier-challenge/index.ts:65

submitEmailChallenge

submitEmailChallenge(payload: Classes.EmailChallengeOptions): Promise<void>
Parameters
- payload: Classes.EmailChallengeOptions
Returns Promise<void>
Example
```
import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';

const emailIdentifierChallenge = new EmailIdentifierChallenge();
emailIdentifierChallenge.submitEmailChallenge({
    code: "<string>"
});
```
Implementation of EmailIdentifierChallengeMembers.submitEmailChallenge
- Defined in src/screens/email-identifier-challenge/index.ts:35