Class ChoiceCallback

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

Hierarchy (View Summary)

BaseCallback
- ChoiceCallback

Index

Constructors

Properties

Methods

getChoices getDefaultChoice getInputValue getOutputByName getOutputValue getPrompt getType setChoiceIndex setChoiceValue setInputValue

Constructors

constructor

new ChoiceCallback(payload: Callback): ChoiceCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns ChoiceCallback
Overrides BaseCallback.constructor
- Defined in journey-client/src/lib/callbacks/choice-callback.ts:18

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getChoices

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

Returns string[]
- Defined in journey-client/src/lib/callbacks/choice-callback.ts:39

getDefaultChoice

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

Returns number
- Defined in journey-client/src/lib/callbacks/choice-callback.ts:32

getInputValue

getInputValue(selector?: string | number): 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 BaseCallback.getInputValue
- Defined in journey-client/src/lib/callbacks/base-callback.ts:32

getOutputByName

getOutputByName<T>(name: string, defaultValue: T): 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 BaseCallback.getOutputByName
- Defined in journey-client/src/lib/callbacks/base-callback.ts:62

getOutputValue

getOutputValue(selector?: string | number): 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 BaseCallback.getOutputValue
- Defined in journey-client/src/lib/callbacks/base-callback.ts:52

getPrompt

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

Returns string
- Defined in journey-client/src/lib/callbacks/choice-callback.ts:25

getType

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

Returns CallbackType
Inherited from BaseCallback.getType
- Defined in journey-client/src/lib/callbacks/base-callback.ts:22

setChoiceIndex

setChoiceIndex(index: number): void
Sets the choice's answer by index position.
Parameters
- index: number
Returns void
- Defined in journey-client/src/lib/callbacks/choice-callback.ts:46

setChoiceValue

setChoiceValue(value: string): void
Sets the choice's answer by value.
Parameters
- value: string
Returns void
- Defined in journey-client/src/lib/callbacks/choice-callback.ts:57

setInputValue

setInputValue(value: unknown, selector?: string | number | RegExp): 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 BaseCallback.setInputValue
- Defined in journey-client/src/lib/callbacks/base-callback.ts:42