MfaRequestChallengeResult class

Package:

@azure/msal-browser

Result of requesting an MFA challenge. Uses base state type to avoid circular dependencies.

Extends

AuthFlowResultBase<MfaRequestChallengeResultState, MfaRequestChallengeError>

Constructors

MfaRequestChallengeResult(MfaRequestChallengeResultState, void)

Inherited Properties

data
error
state

Methods

createWithError(unknown)	Creates an MfaRequestChallengeResult with an error.
isFailed()	Checks if the result is in a failed state.
isVerificationRequired()	Checks if the result indicates that verification is required.

Constructor Details

MfaRequestChallengeResult(MfaRequestChallengeResultState, void)

new MfaRequestChallengeResult(state: MfaRequestChallengeResultState, data?: void)

Parameters

state

MfaRequestChallengeResultState

data

void

Inherited Property Details

data

data?: void

Property Value

void

Inherited From AuthFlowResultBase.data

error

error?: MfaRequestChallengeError

Property Value

MfaRequestChallengeError

Inherited From AuthFlowResultBase.error

state

state: MfaRequestChallengeResultState

Property Value

MfaRequestChallengeResultState

Inherited From AuthFlowResultBase.state

Method Details

createWithError(unknown)

Creates an MfaRequestChallengeResult with an error.

static function createWithError(error: unknown): MfaRequestChallengeResult

Parameters

error

unknown

The error that occurred.

Returns

MfaRequestChallengeResult

The MfaRequestChallengeResult with error.

isFailed()

Checks if the result is in a failed state.

function isFailed(): this

Returns

this

true if the result is failed, false otherwise.

isVerificationRequired()

Checks if the result indicates that verification is required.

function isVerificationRequired(): this

Returns

this

true if verification is required, false otherwise.