Class FRStep

Represents a single step of an authentication tree.

Hierarchy

FRStep

Implements

AuthResponse

Index

Properties

type callbacks payload

Constructors

Methods

getCallbackOfType getCallbacksOfType setCallbackValue getDescription getHeader getStage convertCallbacks

Properties

`Readonly` type

type: Step = StepType.Step

The type of step.

callbacks

callbacks: FRCallback[] = []

The callbacks contained in this step.

payload

payload: Step

The raw payload returned by OpenAM

Constructors

constructor

new FRStep(payload: Step, callbackFactory?: FRCallbackFactory): FRStep
Parameters
- payload: Step
  
  The raw payload returned by OpenAM
- Optional callbackFactory: FRCallbackFactory
  
  A function that returns am implementation of FRCallback
Returns FRStep
- Defined in fr-auth/fr-step.ts:37

Methods

getCallbackOfType

getCallbackOfType<T>(type: CallbackType): T
Gets the first callback of the specified type in this step.
Type Parameters
- T extends FRCallback<T>
Parameters
- type: CallbackType
  
  The type of callback to find.
Returns T
- Defined in fr-auth/fr-step.ts:48

getCallbacksOfType

getCallbacksOfType<T>(type: CallbackType): T[]
Gets all callbacks of the specified type in this step.
Type Parameters
- T extends FRCallback<T>
Parameters
- type: CallbackType
  
  The type of callback to find.
Returns T[]
- Defined in fr-auth/fr-step.ts:61

setCallbackValue

setCallbackValue(type: CallbackType, value: unknown): void
Sets the value of the first callback of the specified type in this step.
Parameters
- type: CallbackType
  
  The type of callback to find.
- value: unknown
  
  The value to set for the callback.
Returns void
- Defined in fr-auth/fr-step.ts:71

getDescription

getDescription(): string
Gets the step's description.

Returns string
- Defined in fr-auth/fr-step.ts:82

getHeader

getHeader(): string
Gets the step's header.

Returns string
- Defined in fr-auth/fr-step.ts:89

getStage

getStage(): string
Gets the step's stage.

Returns string
- Defined in fr-auth/fr-step.ts:96

`Private` convertCallbacks

convertCallbacks(callbacks: Callback[], callbackFactory?: FRCallbackFactory): FRCallback[]
Parameters
- callbacks: Callback[]
- Optional callbackFactory: FRCallbackFactory
Returns FRCallback[]
- Defined in fr-auth/fr-step.ts:100