Class TwoFactorAuthPartialResponse

Partial response to processing a request for two-factor authentication with optional properties.

Hierarchy

TwoFactorAuthPartialResponse

Index

Properties

result? types? empty

Methods

fromResponse fromResult fromTypes

Properties

`Optional` `Readonly` result

result?: null | TwoFactorAuthResult

Optional result to processing a request for 2FA or null if 2FA result unknown.

`Optional` `Readonly` types

types?: null | TwoFactorAuthType[]

Optional 2FA types allowed for user or null if 2FA types unknown.

`Static` `Readonly` empty

empty: TwoFactorAuthPartialResponse = ...

Empty response with empty optional properties.

Methods

`Static` fromResponse

fromResponse(value: TwoFactorAuthResponse): TwoFactorAuthPartialResponse
Creates optional response from 2FA response.

Returns
Partial response to processing a request for two-factor authentication with optional properties.
Parameters
- value: TwoFactorAuthResponse
  
  Response to processing a request for two-factor authentication.
Returns TwoFactorAuthPartialResponse
- Defined in @tessa/application/src/session/service/twoFactorAuthPartialResponse.ts:35

`Static` fromResult

fromResult(value: null | TwoFactorAuthResult): TwoFactorAuthPartialResponse
Creates optional response from 2FA result.

Returns
Partial response to processing a request for two-factor authentication with optional properties.
Parameters
- value: null | TwoFactorAuthResult
  
  Result to processing a request for 2FA or null if 2FA result unknown.
Returns TwoFactorAuthPartialResponse
- Defined in @tessa/application/src/session/service/twoFactorAuthPartialResponse.ts:44

`Static` fromTypes

fromTypes(value: null | TwoFactorAuthType[]): TwoFactorAuthPartialResponse
Creates optional response from 2FA result.

Returns
Partial response to processing a request for two-factor authentication with optional properties.
Parameters
- value: null | TwoFactorAuthType[]
  
  2FA types allowed for user or null if 2FA types unknown.
Returns TwoFactorAuthPartialResponse
- Defined in @tessa/application/src/session/service/twoFactorAuthPartialResponse.ts:53

Generated using TypeDoc