Interface MfaRecoveryCodeEnrollmentMembers

Interface describing the members of the Mfa Recovery Code Enrollment screen.

interface MfaRecoveryCodeEnrollmentMembers {
    branding: Screens.BrandingMembers;
    client: Screens.ClientMembers;
    organization: Screens.OrganizationMembers;
    prompt: Screens.PromptMembers;
    screen: Screens.ScreenMembersOnMfaRecoveryCodeEnrollment;
    tenant: Screens.TenantMembers;
    transaction: Screens.TransactionMembers;
    untrustedData: Screens.UntrustedDataMembers;
    user: Screens.UserMembers;
    changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>;
    continue(
        payload: Screens.MfaRecoveryCodeEnrollmentContinueOptions,
    ): Promise<void>;
    getErrors(): Screens.Error[];
}

Hierarchy (View Summary)

Screens.BaseMembers
- MfaRecoveryCodeEnrollmentMembers

Implemented by

MfaRecoveryCodeEnrollment

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

changeLanguage continue getErrors

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnMfaRecoveryCodeEnrollment

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembers

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.MfaRecoveryCodeEnrollmentContinueOptions,
): Promise<void>
Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. It redirects to the next screen in the authentication flow.
Parameters
- payload: Screens.MfaRecoveryCodeEnrollmentContinueOptions
  An object containing any custom options.
Returns Promise<void>
A promise that resolves when the action is successfully submitted. Rejects with an error if the submission fails.
- Defined in interfaces/screens/mfa-recovery-code-enrollment.ts:37

getErrors

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