AuthMethodRegistrationChallengeMethodResult class
Result of challenging an authentication method for registration. Uses base state type to avoid circular dependencies.
- Extends
Constructors
| Auth |
Methods
| create |
Creates an AuthMethodRegistrationChallengeMethodResult with an error. |
| is |
Checks if the result indicates that registration is completed (fast-pass scenario). |
| is |
Checks if the result is in a failed state. |
| is |
Checks if the result indicates that verification is required. |
Constructor Details
AuthMethodRegistrationChallengeMethodResult(AuthMethodRegistrationChallengeMethodResultState, CustomAuthAccountData)
new AuthMethodRegistrationChallengeMethodResult(state: AuthMethodRegistrationChallengeMethodResultState, data?: CustomAuthAccountData)Parameters
Inherited Property Details
data
data?: CustomAuthAccountDataProperty Value
Inherited From AuthFlowResultBase.data
error
error?: AuthMethodRegistrationChallengeMethodErrorProperty Value
Inherited From AuthFlowResultBase.error
state
state: AuthMethodRegistrationChallengeMethodResultStateProperty Value
Inherited From AuthFlowResultBase.state
Method Details
createWithError(unknown)
Creates an AuthMethodRegistrationChallengeMethodResult with an error.
static function createWithError(error: unknown): AuthMethodRegistrationChallengeMethodResultParameters
- error
-
unknown
The error that occurred.
Returns
The AuthMethodRegistrationChallengeMethodResult with error.
isCompleted()
Checks if the result indicates that registration is completed (fast-pass scenario).
function isCompleted(): booleanReturns
boolean
true if registration is completed, false otherwise.
isFailed()
Checks if the result is in a failed state.
function isFailed(): booleanReturns
boolean
true if the result is failed, false otherwise.
isVerificationRequired()
Checks if the result indicates that verification is required.
function isVerificationRequired(): booleanReturns
boolean
true if verification is required, false otherwise.