Edit

Share via

SignUpResult class

Package:
@azure/msal-browser
Extends

AuthFlowResultBase<SignUpResultState, SignUpError, void>

Constructors

SignUpResult(SignUpResultState)

Creates a new instance of SignUpResult.

Inherited Properties

data
error
state

Methods

createWithError(unknown)

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

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

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

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

Checks if the result is in a password required state.

Constructor Details

SignUpResult(SignUpResultState)

Creates a new instance of SignUpResult.

new SignUpResult(state: SignUpResultState)

Parameters

state
SignUpResultState

The state of the result.

Inherited Property Details

data 

data?: void

Property Value

void

Inherited From AuthFlowResultBase.data

error 

error?: SignUpError

Property Value

SignUpError

Inherited From AuthFlowResultBase.error

state 

state: SignUpResultState

Property Value

SignUpResultState

Inherited From AuthFlowResultBase.state

Method Details

createWithError(unknown)

Creates a new instance of SignUpResult with an error.

static function createWithError(error: unknown): SignUpResult

Parameters

error

unknown

The error that occurred.

Returns

SignUpResult

A new instance of SignUpResult with the error set.

isAttributesRequired()

Checks if the result is in an attributes required state.

function isAttributesRequired(): this

Returns

this

isCodeRequired()

Checks if the result is in a code required state.

function isCodeRequired(): 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