Edit

Share via

SignUpCodeRequiredState class

Package:
@azure/msal-browser

Base class for the action requried state in an authentication flow.

Extends

SignUpState<SignUpCodeRequiredStateParameters>

Constructors

SignUpCodeRequiredState(SignUpCodeRequiredStateParameters)

Methods

getCodeLength()

Gets the sent code length.
getCodeResendInterval()

Gets the interval in seconds for the code to be resent.
resendCode()

Resends the another one-time passcode for sign-up flow if the previous one hasn't been verified.
submitCode(string)

Submit one-time passcode to continue sign-up flow.

Constructor Details

SignUpCodeRequiredState(SignUpCodeRequiredStateParameters) 

new SignUpCodeRequiredState(stateParameters: SignUpCodeRequiredStateParameters)

Parameters

stateParameters

SignUpCodeRequiredStateParameters

Method Details

getCodeLength()

Gets the sent code length.

function getCodeLength(): number

Returns

number

The length of the code.

getCodeResendInterval()

Gets the interval in seconds for the code to be resent.

function getCodeResendInterval(): number

Returns

number

The interval in seconds for the code to be resent.

resendCode()

Resends the another one-time passcode for sign-up flow if the previous one hasn't been verified.

function resendCode(): Promise<SignUpResendCodeResult>

Returns

Promise<SignUpResendCodeResult>

The result of the operation.

submitCode(string)

Submit one-time passcode to continue sign-up flow.

function submitCode(code: string): Promise<SignUpSubmitCodeResult>

Parameters

code

string

The code to submit.

Returns

Promise<SignUpSubmitCodeResult>

The result of the operation.