Modifica

Condividi tramite

AuthMethodRegistrationChallengeMethodResult class

Package:
@azure/msal-browser

Result of challenging an authentication method for registration. Uses base state type to avoid circular dependencies.

Extends

AuthFlowResultBase<AuthMethodRegistrationChallengeMethodResultState, AuthMethodRegistrationChallengeMethodError, CustomAuthAccountData>

Constructors

AuthMethodRegistrationChallengeMethodResult(AuthMethodRegistrationChallengeMethodResultState, CustomAuthAccountData)

Inherited Properties

data
error
state

Methods

createWithError(unknown)

Creates an AuthMethodRegistrationChallengeMethodResult with an error.
isCompleted()

Checks if the result indicates that registration is completed (fast-pass scenario).
isFailed()

Checks if the result is in a failed state.
isVerificationRequired()

Checks if the result indicates that verification is required.

Constructor Details

AuthMethodRegistrationChallengeMethodResult(AuthMethodRegistrationChallengeMethodResultState, CustomAuthAccountData) 

new AuthMethodRegistrationChallengeMethodResult(state: AuthMethodRegistrationChallengeMethodResultState, data?: CustomAuthAccountData)

Parameters

state
AuthMethodRegistrationChallengeMethodResultState
data
CustomAuthAccountData

Inherited Property Details

data 

data?: CustomAuthAccountData

Property Value

CustomAuthAccountData

Inherited From AuthFlowResultBase.data

error 

error?: AuthMethodRegistrationChallengeMethodError

Property Value

AuthMethodRegistrationChallengeMethodError

Inherited From AuthFlowResultBase.error

state 

state: AuthMethodRegistrationChallengeMethodResultState

Property Value

AuthMethodRegistrationChallengeMethodResultState

Inherited From AuthFlowResultBase.state

Method Details

createWithError(unknown)

Creates an AuthMethodRegistrationChallengeMethodResult with an error.

static function createWithError(error: unknown): AuthMethodRegistrationChallengeMethodResult

Parameters

error

unknown

The error that occurred.

Returns

AuthMethodRegistrationChallengeMethodResult

The AuthMethodRegistrationChallengeMethodResult with error.

isCompleted()

Checks if the result indicates that registration is completed (fast-pass scenario).

function isCompleted(): this

Returns

this

true if registration is 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.

isVerificationRequired()

Checks if the result indicates that verification is required.

function isVerificationRequired(): this

Returns

this

true if verification is required, false otherwise.