Interface MfaEmailChallengeMembers

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

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

Hierarchy (View Summary)

Screens.BaseMembers
- MfaEmailChallengeMembers

Implemented by

MfaEmailChallenge

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

changeLanguage continue getErrors pickEmail resendCode resendManager tryAnotherMethod

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnMfaEmailChallenge

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembersOnMfaEmailChallenge

user

user: Screens.UserMembers

Methods

changeLanguage

changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>
Parameters
- options: Screens.LanguageChangeOptions
Returns Promise<void>
Inherited from BaseMembers.changeLanguage
- Defined in interfaces/models/base-context.ts:35

continue

continue(payload: Screens.ContinuePayloadOptions): Promise<void>
Continues with the email challenge using the provided code
Parameters
- payload: Screens.ContinuePayloadOptions
  The options containing the code and rememberDevice flag
Returns Promise<void>
- Defined in interfaces/screens/mfa-email-challenge.ts:65

getErrors

getErrors(): Screens.Error[]
Returns Screens.Error[]
Inherited from BaseMembers.getErrors
- Defined in interfaces/models/base-context.ts:34

pickEmail

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

resendCode

resendCode(payload?: Screens.ResendCodePayloadOptions): Promise<void>
Resends the email code
Parameters
- Optionalpayload: Screens.ResendCodePayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
- Defined in interfaces/screens/mfa-email-challenge.ts:71

resendManager

resendManager(options?: Screens.StartResendOptions): Screens.ResendControl
Gets resend functionality with timeout management for this screen
Parameters
- Optionaloptions: Screens.StartResendOptions
  Configuration options for resend functionality
Returns Screens.ResendControl
- Defined in interfaces/screens/mfa-email-challenge.ts:89

tryAnotherMethod

tryAnotherMethod(
payload?: Screens.TryAnotherMethodPayloadOptions,
): Promise<void>
Allows the user to try another MFA method
Parameters
- Optionalpayload: Screens.TryAnotherMethodPayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
- Defined in interfaces/screens/mfa-email-challenge.ts:77