SignInResult class
- Extends
-
AuthFlowResultBase<SignInResultState, SignInError, CustomAuthAccountData>
Constructors
| Sign |
Creates a new instance of SignInResultState. |
Methods
| create |
Creates a new instance of SignInResult with an error. |
| is |
Checks if the result requires authentication method registration. |
| is |
Checks if the result is in a code required state. |
| is |
Checks if the result is in a completed state. |
| is |
Checks if the result is in a failed state. |
| is |
Checks if the result is in a password required state. |
Constructor Details
SignInResult(SignInResultState, CustomAuthAccountData)
Creates a new instance of SignInResultState.
new SignInResult(state: SignInResultState, resultData?: CustomAuthAccountData)Parameters
- state
- SignInResultState
The state of the result.
- resultData
- CustomAuthAccountData
Inherited Property Details
data
data?: CustomAuthAccountDataProperty Value
Inherited From AuthFlowResultBase.data
error
state
Method Details
createWithError(unknown)
Creates a new instance of SignInResult with an error.
static function createWithError(error: unknown): SignInResultParameters
- error
-
unknown
The error that occurred.
Returns
A new instance of SignInResult with the error set.
isAuthMethodRegistrationRequired()
Checks if the result requires authentication method registration.
function isAuthMethodRegistrationRequired(): thisReturns
this
isCodeRequired()
Checks if the result is in a code required state.
function isCodeRequired(): thisReturns
this
isCompleted()
Checks if the result is in a completed state.
function isCompleted(): thisReturns
this
isFailed()
Checks if the result is in a failed state.
function isFailed(): thisReturns
this
isPasswordRequired()
Checks if the result is in a password required state.
function isPasswordRequired(): thisReturns
this