Class ConfirmationCallback

Represents a callback used to collect a confirmation to a message.

Hierarchy (View Summary)

BaseCallback
- ConfirmationCallback

Index

Constructors

Properties

Methods

getDefaultOption getInputValue getMessageType getOptions getOptionType getOutputByName getOutputValue getPrompt getType setInputValue setOptionIndex setOptionValue

Constructors

constructor

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

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getDefaultOption

getDefaultOption(): number
Gets the index position of the confirmation's default answer.

Returns number
- Defined in journey-client/src/lib/callbacks/confirmation-callback.ts:25

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

getMessageType

getMessageType(): number
Gets the confirmation's message type.

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

getOptions

getOptions(): string[]
Gets the confirmation's possible answers.

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

getOptionType

getOptionType(): number
Gets the confirmation's option type.

Returns number
- Defined in journey-client/src/lib/callbacks/confirmation-callback.ts:46

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 confirmation's prompt.

Returns string
- Defined in journey-client/src/lib/callbacks/confirmation-callback.ts:53

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

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

setOptionIndex

setOptionIndex(index: number): void
Set option index.
Parameters
- index: number
Returns void
- Defined in journey-client/src/lib/callbacks/confirmation-callback.ts:60

setOptionValue

setOptionValue(value: string): void
Set option value.
Parameters
- value: string
Returns void
- Defined in journey-client/src/lib/callbacks/confirmation-callback.ts:71