Interface MfaVoiceChallengeMembers

Interface defining all members and operations available on the MFA Voice Challenge screen.

interface MfaVoiceChallengeMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    screen: ScreenMembersOnMfaVoiceChallenge;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    untrustedData: UntrustedDataMembersOnMfaVoiceChallenge;
    user: UserMembers;
    continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>;
    pickPhone(payload?: CustomOptions): Promise<void>;
    resendCode(payload?: CustomOptions): Promise<void>;
    switchToSms(payload?: CustomOptions): Promise<void>;
    tryAnotherMethod(payload?: CustomOptions): Promise<void>;
}

Hierarchy

BaseMembers
- MfaVoiceChallengeMembers

Implemented by

MfaVoiceChallenge

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

continue pickPhone resendCode switchToSms tryAnotherMethod

Properties

branding

branding: BrandingMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

screen

screen: ScreenMembersOnMfaVoiceChallenge

Screen-specific properties and data.

tenant

tenant: TenantMembers

transaction

transaction: TransactionMembers

untrustedData

untrustedData: UntrustedDataMembersOnMfaVoiceChallenge

user

user: UserMembers

Methods

continue

continue(payload): Promise<void>
Submits the voice verification code to validate the MFA challenge.
Parameters
- payload: MfaVoiceChallengeContinueOptions
  Object containing the verification code and optional parameters
Returns Promise<void>
Promise that resolves when the code is successfully validated
Example
```
const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.continue({
  code: '123456',
  rememberDevice: true
});
```
- Defined in interfaces/screens/mfa-voice-challenge.ts:77

pickPhone

pickPhone(payload?): Promise<void>
Navigates to the screen for selecting a different phone number.
Parameters
- Optionalpayload: CustomOptions
  Optional custom parameters
Returns Promise<void>
Promise that resolves when navigation is complete
Example
```
const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.pickPhone();
```
- Defined in interfaces/screens/mfa-voice-challenge.ts:91

resendCode

resendCode(payload?): Promise<void>
Requests a new voice call with a verification code.
Parameters
- Optionalpayload: CustomOptions
  Optional custom parameters
Returns Promise<void>
Promise that resolves when the new code is sent
Example
```
const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.resendCode();
```
- Defined in interfaces/screens/mfa-voice-challenge.ts:119

switchToSms

switchToSms(payload?): Promise<void>
Switches to SMS verification method instead of voice call.
Parameters
- Optionalpayload: CustomOptions
  Optional custom parameters
Returns Promise<void>
Promise that resolves when switching is complete
Example
```
const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.switchToSms();
```
- Defined in interfaces/screens/mfa-voice-challenge.ts:105

tryAnotherMethod

tryAnotherMethod(payload?): Promise<void>
Navigates to the screen for selecting an alternative MFA method.
Parameters
- Optionalpayload: CustomOptions
  Optional custom parameters
Returns Promise<void>
Promise that resolves when navigation is complete
Example
```
const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.tryAnotherMethod();
```
- Defined in interfaces/screens/mfa-voice-challenge.ts:133