Edit

Share via

SignUpSubmitCodeResult class

Package:
@azure/msal-browser
Extends

AuthFlowResultBase<SignUpSubmitCodeResultState, SignUpSubmitCodeError, void>

Constructors

SignUpSubmitCodeResult(SignUpSubmitCodeResultState)

Creates a new instance of SignUpSubmitCodeResult.

Inherited Properties

data
error
state

Methods

createWithError(unknown)

Creates a new instance of SignUpSubmitCodeResult with an error.
isAttributesRequired()

Checks if the result is in an attributes required state.
isCompleted()

Checks if the result is in a completed state.
isFailed()

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

Checks if the result is in a password required state.

Constructor Details

SignUpSubmitCodeResult(SignUpSubmitCodeResultState)

Creates a new instance of SignUpSubmitCodeResult.

new SignUpSubmitCodeResult(state: SignUpSubmitCodeResultState)

Parameters

state
SignUpSubmitCodeResultState

The state of the result.

Inherited Property Details

data 

data?: void

Property Value

void

Inherited From AuthFlowResultBase.data

error 

error?: SignUpSubmitCodeError

Property Value

SignUpSubmitCodeError

Inherited From AuthFlowResultBase.error

state 

state: SignUpSubmitCodeResultState

Property Value

SignUpSubmitCodeResultState

Inherited From AuthFlowResultBase.state

Method Details

createWithError(unknown)

Creates a new instance of SignUpSubmitCodeResult with an error.

static function createWithError(error: unknown): SignUpSubmitCodeResult

Parameters

error

unknown

The error that occurred.

Returns

SignUpSubmitCodeResult

A new instance of SignUpSubmitCodeResult with the error set.

isAttributesRequired()

Checks if the result is in an attributes required state.

function isAttributesRequired(): this

Returns

this

isCompleted()

Checks if the result is in a completed state.

function isCompleted(): this

Returns

this

isFailed()

Checks if the result is in a failed state.

function isFailed(): this

Returns

this

isPasswordRequired()

Checks if the result is in a password required state.

function isPasswordRequired(): this

Returns

this