Edit

Share via

MfaSubmitChallengeResult class

Package:
@azure/msal-browser

Result of submitting an MFA challenge.

Extends

AuthFlowResultBase<MfaSubmitChallengeResultState, MfaSubmitChallengeError, CustomAuthAccountData>

Constructors

MfaSubmitChallengeResult(MfaSubmitChallengeResultState, CustomAuthAccountData)

Inherited Properties

data
error
state

Methods

createWithError(unknown)

Creates an MfaSubmitChallengeResult with an error.
isCompleted()

Checks if the MFA flow is completed successfully.
isFailed()

Checks if the result is in a failed state.

Constructor Details

MfaSubmitChallengeResult(MfaSubmitChallengeResultState, CustomAuthAccountData) 

new MfaSubmitChallengeResult(state: MfaSubmitChallengeResultState, data?: CustomAuthAccountData)

Parameters

state
MfaSubmitChallengeResultState
data
CustomAuthAccountData

Inherited Property Details

data 

data?: CustomAuthAccountData

Property Value

CustomAuthAccountData

Inherited From AuthFlowResultBase.data

error 

error?: MfaSubmitChallengeError

Property Value

MfaSubmitChallengeError

Inherited From AuthFlowResultBase.error

state 

state: MfaSubmitChallengeResultState

Property Value

MfaSubmitChallengeResultState

Inherited From AuthFlowResultBase.state

Method Details

createWithError(unknown)

Creates an MfaSubmitChallengeResult with an error.

static function createWithError(error: unknown): MfaSubmitChallengeResult

Parameters

error

unknown

The error that occurred.

Returns

MfaSubmitChallengeResult

The MfaSubmitChallengeResult with error.

isCompleted()

Checks if the MFA flow is completed successfully.

function isCompleted(): this

Returns

this

true if completed, false otherwise.

isFailed()

Checks if the result is in a failed state.

function isFailed(): this

Returns

this

true if the result is failed, false otherwise.