Class FRLoginFailure

Base interface for all types of authentication step responses.

Hierarchy

FRLoginFailure

Implements

AuthResponse

Index

Properties

Constructors

Methods

getCode getDetail getMessage getProcessedMessage getReason

Properties

`Readonly` type

type: LoginFailure = StepType.LoginFailure

The type of step.

payload

payload: Step

The raw payload returned by OpenAM

Constructors

constructor

new FRLoginFailure(payload: Step): FRLoginFailure
Parameters
- payload: Step
  
  The raw payload returned by OpenAM
Returns FRLoginFailure
- Defined in fr-auth/fr-login-failure.ts:26

Methods

getCode

getCode(): number
Gets the error code.

Returns number
- Defined in fr-auth/fr-login-failure.ts:31

getDetail

getDetail(): FailureDetail
Gets the failure details.

Returns FailureDetail
- Defined in fr-auth/fr-login-failure.ts:38

getMessage

getMessage(): string
Gets the failure message.

Returns string
- Defined in fr-auth/fr-login-failure.ts:45

getProcessedMessage

getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[]
Gets processed failure message.
Parameters
- Optional messageCreator: MessageCreator
Returns ProcessedPropertyError[]
- Defined in fr-auth/fr-login-failure.ts:52

getReason

getReason(): string
Gets the failure reason.

Returns string
- Defined in fr-auth/fr-login-failure.ts:59

src