Interface defining all members and operations available on the MFA Voice Challenge screen.
export interface MfaVoiceChallengeMembers extends BaseMembers {
/**
* Screen-specific properties and data.
*/
screen: ScreenMembersOnMfaVoiceChallenge;
untrustedData: UntrustedDataMembersOnMfaVoiceChallenge;
/**
* Submits the voice verification code to validate the MFA challenge.
*
* @param payload - Object containing the verification code and optional parameters
* @returns Promise that resolves when the code is successfully validated
*
* @example
* ```typescript
* const mfaVoiceChallenge = new MfaVoiceChallenge();
* mfaVoiceChallenge.continue({
* code: '123456',
* rememberDevice: true
* });
* ```
*/
continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>;
/**
* Navigates to the screen for selecting a different phone number.
*
* @param payload - Optional custom parameters
* @returns Promise that resolves when navigation is complete
*
* @example
* ```typescript
* const mfaVoiceChallenge = new MfaVoiceChallenge();
* mfaVoiceChallenge.pickPhone();
* ```
*/
pickPhone(payload?: CustomOptions): Promise<void>;
/**
* Switches to SMS verification method instead of voice call.
*
* @param payload - Optional custom parameters
* @returns Promise that resolves when switching is complete
*
* @example
* ```typescript
* const mfaVoiceChallenge = new MfaVoiceChallenge();
* mfaVoiceChallenge.switchToSms();
* ```
*/
switchToSms(payload?: CustomOptions): Promise<void>;
/**
* Requests a new voice call with a verification code.
*
* @param payload - Optional custom parameters
* @returns Promise that resolves when the new code is sent
*
* @example
* ```typescript
* const mfaVoiceChallenge = new MfaVoiceChallenge();
* mfaVoiceChallenge.resendCode();
* ```
*/
resendCode(payload?: CustomOptions): Promise<void>;
/**
* Navigates to the screen for selecting an alternative MFA method.
*
* @param payload - Optional custom parameters
* @returns Promise that resolves when navigation is complete
*
* @example
* ```typescript
* const mfaVoiceChallenge = new MfaVoiceChallenge();
* mfaVoiceChallenge.tryAnotherMethod();
* ```
*/
tryAnotherMethod(payload?: CustomOptions): Promise<void>;
/**
* Gets resend functionality with timeout management for this screen
* @param options Configuration options for resend functionality
*/
resendManager(options?: StartResendOptions): ResendControl;
}
Properties
Screen-specific properties and data.
Methods
Submits the voice verification code to validate the MFA challenge.Promise that resolves when the code is successfully validatedconst mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.continue({
code: '123456',
rememberDevice: true
});
Object containing the verification code and optional parametersPropertiesThe verification code received via voice call.
Optional flag to remember the device for 30 days, skipping future MFA challenges.
Navigates to the screen for selecting a different phone number.Promise that resolves when navigation is completeconst mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.pickPhone();
Optional custom parameters
Requests a new voice call with a verification code.Promise that resolves when the new code is sentconst mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.resendCode();
Optional custom parameters
Gets resend functionality with timeout management for this screen
Configuration options for resend functionalityProperties
Switches to SMS verification method instead of voice call.Promise that resolves when switching is completeconst mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.switchToSms();
Optional custom parameters
Navigates to the screen for selecting an alternative MFA method.Promise that resolves when navigation is completeconst mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.tryAnotherMethod();
Optional custom parameters