Interface EmailOTPChallengeMembers

Represents the Email OTP Challenge screen interface.

interface EmailOTPChallengeMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    user: UserMembers;
    untrustedData: UntrustedDataMembers;
    getErrors(): Error[];
    changeLanguage(options: LanguageChangeOptions): Promise<void>;
    screen: ScreenMembersOnEmailOTPChallenge;
    submitCode(options: OtpCodeOptions): Promise<void>;
    resendCode(options?: CustomOptions): Promise<void>;
    resendManager(options?: StartResendOptions): ResendControl;
}

Hierarchy (View Summary)

BaseMembers
- EmailOTPChallengeMembers

Index

Properties

branding client organization prompt tenant transaction user untrustedData screen

Methods

getErrors changeLanguage submitCode resendCode resendManager

Properties

branding

branding: BrandingMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

tenant

tenant: TenantMembers

transaction

transaction: TransactionMembers

user

user: UserMembers

untrustedData

untrustedData: UntrustedDataMembers

screen

screen: ScreenMembersOnEmailOTPChallenge

Methods

getErrors

getErrors(): Error[]
Returns Error[]
Inherited from BaseMembers.getErrors
- Defined in packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:32

changeLanguage

changeLanguage(options: LanguageChangeOptions): Promise<void>
Parameters
- options: LanguageChangeOptions
Returns Promise<void>
Inherited from BaseMembers.changeLanguage
- Defined in packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:33

submitCode

submitCode(options: OtpCodeOptions): Promise<void>
Submits the OTP code entered by the user.
Parameters
- options: OtpCodeOptions
  Optional parameters to include in the submission.
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:26

resendCode

resendCode(options?: CustomOptions): Promise<void>
Requests a new OTP code to be sent to the user's email.
Parameters
- Optionaloptions: CustomOptions
  Optional parameters to include in the resend request.
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:31

resendManager

resendManager(options?: StartResendOptions): ResendControl
Gets resend functionality with timeout management for this screen
Parameters
- Optionaloptions: StartResendOptions
  Configuration options for resend functionality
Returns ResendControl
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:36