Class ConfirmationCallback

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

Hierarchy (view full)

FRCallback
- ConfirmationCallback

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

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 fr-auth/callbacks/confirmation-callback.ts:28

getMessageType

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

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

getOptions

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

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

getOptionType

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

Returns number
- Defined in fr-auth/callbacks/confirmation-callback.ts:49

getPrompt

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

Returns string
- Defined in fr-auth/callbacks/confirmation-callback.ts:56

setOptionIndex

setOptionIndex(index): void
Set option index.
Parameters
- index: number
Returns void
- Defined in fr-auth/callbacks/confirmation-callback.ts:63

setOptionValue

setOptionValue(value): void
Set option value.
Parameters
- value: string
Returns void
- Defined in fr-auth/callbacks/confirmation-callback.ts:73

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