Class ChoiceCallback

Represents a callback used to collect an answer to a choice.

Hierarchy (view full)

FRCallback
- ChoiceCallback

Index

Constructors

Properties

Methods

getPrompt getDefaultChoice getChoices setChoiceIndex setChoiceValue getType getInputValue setInputValue getOutputValue getOutputByName

Constructors

constructor

new ChoiceCallback(payload): ChoiceCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns ChoiceCallback
Overrides FRCallback.constructor
- Defined in fr-auth/callbacks/choice-callback.ts:21

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getPrompt

getPrompt(): string
Gets the choice's prompt.

Returns string
- Defined in fr-auth/callbacks/choice-callback.ts:28

getDefaultChoice

getDefaultChoice(): number
Gets the choice's default answer.

Returns number
- Defined in fr-auth/callbacks/choice-callback.ts:35

getChoices

getChoices(): string[]
Gets the choice's possible answers.

Returns string[]
- Defined in fr-auth/callbacks/choice-callback.ts:42

setChoiceIndex

setChoiceIndex(index): void
Sets the choice's answer by index position.
Parameters
- index: number
Returns void
- Defined in fr-auth/callbacks/choice-callback.ts:49

setChoiceValue

setChoiceValue(value): void
Sets the choice's answer by value.
Parameters
- value: string
Returns void
- Defined in fr-auth/callbacks/choice-callback.ts:60

getType

getType(): CallbackType
Gets the name of this callback type.

Returns CallbackType
Inherited from FRCallback.getType
- Defined in fr-auth/callbacks/index.ts:26

getInputValue

getInputValue(selector?): unknown
Gets the value of the specified input element, or the first element if selector is not provided.
Parameters
- selector: string | number = 0
  The index position or name of the desired element
Returns unknown
Inherited from FRCallback.getInputValue
- Defined in fr-auth/callbacks/index.ts:36

setInputValue

setInputValue(value, selector?): void
Sets the value of the specified input element, or the first element if selector is not provided.
Parameters
- value: unknown
- selector: string | number | RegExp = 0
  The index position or name of the desired element
Returns void
Inherited from FRCallback.setInputValue
- Defined in fr-auth/callbacks/index.ts:46

getOutputValue

getOutputValue(selector?): unknown
Gets the value of the specified output element, or the first element if selector is not provided.
Parameters
- selector: string | number = 0
  The index position or name of the desired element
Returns unknown
Inherited from FRCallback.getOutputValue
- Defined in fr-auth/callbacks/index.ts:56

getOutputByName

getOutputByName<T>(name, defaultValue): T
Gets the value of the first output element with the specified name or the specified default value.
Type Parameters
- T
Parameters
- name: string
  The name of the desired element
- defaultValue: T
Returns T
Inherited from FRCallback.getOutputByName
- Defined in fr-auth/callbacks/index.ts:66