Class EmailIdentifierChallenge

Hierarchy

BaseContext
- EmailIdentifierChallenge

Implements

Screens.EmailIdentifierChallengeMembers

Index

Constructors

Constructors

constructor

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

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

countryCodes

countryCodes: Screens.CountryCodesMembers

Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

experiment

experiment: Screens.ExperimentMembers | null

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnEmailIdentifierChallenge

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.EMAIL_IDENTIFIER_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 EmailIdentifierChallengeMembers.changeLanguage
Inherited from BaseContext.changeLanguage
- Defined in src/models/base-context.ts:167

Methods - Other

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

resendCode

resendCode(payload?: Screens.CustomOptions): Promise<void>
Requests a new verification code for the user's email address.
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom parameters to send with the request.
Returns Promise<void>
A promise that resolves once the form is submitted, before the new page loads. It doesn't confirm that a new code was sent.
Remarks
Submits a form POST with action: "resend-code". Auth0 responds by rendering this screen again, or the interstitial-captcha screen if a captcha is required. Either way the browser loads a new page, and the current JavaScript context, including component state and timers, is lost.

Code after await resendCode() may still run, but anything it sets up, such as a "code sent" message or a countdown, is gone after the reload. If the resend fails, for example because of a rate limit, Auth0 renders this screen again without an error, so that it doesn't reveal whether the user exists. Nothing appears in transaction.errors, and the returned promise doesn't reject.

To add a cooldown between resends, use resendManager(). It stores its countdown in localStorage, so the countdown survives the reload. It also disables resending when screen.data.resendLimitReached is true.
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:74

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 EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
  const handleStatusChange = (remainingSeconds, isDisabled) => {
    setDisabled(isDisabled);
    setRemaining(remainingSeconds);
  };

  const handleTimeout = () => {
    console.log('Timeout completed, resend is now available');
  };

  const { startResend } = emailChallenge.resendManager({
    timeoutSeconds: 15,
    onStatusChange: handleStatusChange,
    onTimeout: handleTimeout
  });
  
  // Call startResend when user clicks resend button
  await startResend();

returnToPrevious

returnToPrevious(payload?: Screens.CustomOptions): Promise<void>
Parameters
- Optionalpayload: Screens.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:89

submitEmailChallenge

submitEmailChallenge(payload: Screens.EmailChallengeOptions): Promise<void>
Parameters
- payload: Screens.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:37

switchToPassword

switchToPassword(payload?: Screens.CustomOptions): Promise<void>
Parameters
- Optionalpayload: Screens.CustomOptions
Returns Promise<void>
Remarks
Switches the authentication flow from OTP-based to password-based authentication.
Example
```
import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';

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

Class EmailIdentifierChallenge

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns EmailIdentifierChallenge

Properties

branding

client

countryCodes

experiment

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

getErrors

Returns Screens.Error[]

resendCode

Parameters

Returns Promise<void>

Remarks

Example

resendManager

Parameters

OptionalonStatusChange?: Screens.OnStatusChangeCallback

OptionalonTimeout?: () => void

OptionaltimeoutSeconds?: number

Returns Screens.ResendControl

Example

returnToPrevious

Parameters

Returns Promise<void>

Example

submitEmailChallenge

Parameters

Returns Promise<void>

Example

switchToPassword

Parameters

Returns Promise<void>

Remarks

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"

`Optional`onStatusChange?: Screens.OnStatusChangeCallback

`Optional`onTimeout?: () => void

`Optional`timeoutSeconds?: number