Interface MfaEmailChallengeMembers

Interface defining the available methods and properties for the mfa-email-challenge screen

interface MfaEmailChallengeMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    user: UserMembers;
    getErrors(): Error[];
    changeLanguage(options: LanguageChangeOptions): Promise<void>;
    screen: ScreenMembersOnMfaEmailChallenge;
    untrustedData: UntrustedDataMembersOnMfaEmailChallenge;
    continue(payload: ContinuePayloadOptions): Promise<void>;
    resendCode(payload?: ResendCodePayloadOptions): Promise<void>;
    tryAnotherMethod(payload?: TryAnotherMethodPayloadOptions): Promise<void>;
    pickEmail(payload?: CustomOptions): Promise<void>;
    resendManager(options?: StartResendOptions): ResendControl;
}

Hierarchy (View Summary)

BaseMembers
- MfaEmailChallengeMembers

Index

Properties

branding client organization prompt tenant transaction user screen untrustedData

Methods

getErrors changeLanguage continue resendCode tryAnotherMethod pickEmail resendManager

Properties

branding

branding: BrandingMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

tenant

tenant: TenantMembers

transaction

transaction: TransactionMembers

user

user: UserMembers

screen

screen: ScreenMembersOnMfaEmailChallenge

untrustedData

untrustedData: UntrustedDataMembersOnMfaEmailChallenge

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

continue

continue(payload: ContinuePayloadOptions): Promise<void>
Continues with the email challenge using the provided code
Parameters
- payload: ContinuePayloadOptions
  The options containing the code and rememberDevice flag
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:58

resendCode

resendCode(payload?: ResendCodePayloadOptions): Promise<void>
Resends the email code
Parameters
- Optionalpayload: ResendCodePayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:63

tryAnotherMethod

tryAnotherMethod(payload?: TryAnotherMethodPayloadOptions): Promise<void>
Allows the user to try another MFA method
Parameters
- Optionalpayload: TryAnotherMethodPayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:68

pickEmail

pickEmail(payload?: CustomOptions): Promise<void>
Submits the action to pick a different Email configuration, if available
Parameters
- Optionalpayload: CustomOptions
  Optional custom options to include with the request
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:73

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/mfa-email-challenge.d.ts:78