Class FRLoginFailure

Hierarchy

FRLoginFailure

Implements

AuthResponse

Index

Constructors

constructor

Properties

payload
type

Methods

Constructors

constructor

new FRLoginFailure(payload: Step): FRLoginFailure

- Defined in packages/javascript-sdk/src/fr-auth/fr-login-failure.ts:21
Parameters
- payload: Step
  
  The raw payload returned by OpenAM
Returns FRLoginFailure

Properties

payload

payload: Step

The raw payload returned by OpenAM

Readonly type

type: LoginFailure = StepType.LoginFailure

The type of step.

Methods

getCode

getCode(): number

- Defined in packages/javascript-sdk/src/fr-auth/fr-login-failure.ts:31
Gets the error code.

Returns number

getDetail

getDetail(): FailureDetail | undefined

- Defined in packages/javascript-sdk/src/fr-auth/fr-login-failure.ts:38
Gets the failure details.

Returns FailureDetail | undefined

getMessage

getMessage(): string | undefined

- Defined in packages/javascript-sdk/src/fr-auth/fr-login-failure.ts:45
Gets the failure message.

Returns string | undefined

getProcessedMessage

getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[]

- Defined in packages/javascript-sdk/src/fr-auth/fr-login-failure.ts:52
Gets processed failure message.

Parameters
- Optional messageCreator: MessageCreator
Returns ProcessedPropertyError[]

getReason

getReason(): string | undefined

- Defined in packages/javascript-sdk/src/fr-auth/fr-login-failure.ts:59
Gets the failure reason.

Returns string | undefined