Class FRStep

constructor

• new FRStep(payload: Step, callbackFactory?: FRCallbackFactory): FRStep

• Parameters

  • payload: Step

    The raw payload returned by OpenAM
  • OptionalcallbackFactory: FRCallbackFactory

    A function that returns am implementation of FRCallback

  Returns FRStep

Readonlytype

callbacks

payload

getCallbackOfType

• getCallbackOfType<T extends FRCallback>(type: CallbackType): T

• Gets the first callback of the specified type in this step.

  Type Parameters

  • T extends FRCallback

  Parameters

  • type: CallbackType

    The type of callback to find.

  Returns T

getCallbacksOfType

• getCallbacksOfType<T extends FRCallback>(type: CallbackType): T[]

• Gets all callbacks of the specified type in this step.

  Type Parameters

  • T extends FRCallback

  Parameters

  • type: CallbackType

    The type of callback to find.

  Returns T[]

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

getDescription

• getDescription(): undefined | string

• Gets the step's description.

  Returns undefined | string

getHeader

• getHeader(): undefined | string

• Gets the step's header.

  Returns undefined | string

getStage

• getStage(): undefined | string

• Gets the step's stage.

  Returns undefined | string