Interface MfaVoiceEnrollmentMembers

Interface describing the members of the Mfa Voice Enrollment screen.

interface MfaVoiceEnrollmentMembers {
    branding: BrandingMembers;
    tenant: TenantMembers;
    user: UserMembers;
    untrustedData: UntrustedDataMembers;
    getErrors(): Error[];
    changeLanguage(options: LanguageChangeOptions): Promise<void>;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    screen: ScreenMembers;
    transaction: TransactionMembers;
    continue(payload: MfaVoiceEnrollmentContinueOptions): Promise<void>;
    tryAnotherMethod(payload?: CustomOptions): Promise<void>;
    selectPhoneCountryCode(payload?: CustomOptions): Promise<void>;
}

Hierarchy (View Summary)

BaseMembers
- MfaVoiceEnrollmentMembers

Index

Properties

branding tenant user untrustedData client organization prompt screen transaction

Methods

getErrors changeLanguage continue tryAnotherMethod selectPhoneCountryCode

Properties

branding

branding: BrandingMembers

tenant

tenant: TenantMembers

user

user: UserMembers

untrustedData

untrustedData: UntrustedDataMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

screen

screen: ScreenMembers

transaction

transaction: TransactionMembers

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: MfaVoiceEnrollmentContinueOptions): Promise<void>
Continues with the voice enrollment process.
Parameters
- payload: MfaVoiceEnrollmentContinueOptions
  The phone number and optional custom options.
Returns Promise<void>
Promise that resolves when enrollment continues.
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:28

tryAnotherMethod

tryAnotherMethod(payload?: CustomOptions): Promise<void>
Allows trying another authentication method.
Parameters
- Optionalpayload: CustomOptions
  Optional custom options.
Returns Promise<void>
Promise that resolves when the user switches method.
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:34

selectPhoneCountryCode

selectPhoneCountryCode(payload?: CustomOptions): Promise<void>
Allows picking a country code for the phone number.
Parameters
- Optionalpayload: CustomOptions
  Optional custom options.
Returns Promise<void>
Promise that resolves when the country code is selected.
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:40