Class ChoiceCallback

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

Hierarchy

FRCallback
- ChoiceCallback

Index

Constructors

constructor

Properties

payload

Methods

Constructors

constructor

new ChoiceCallback(payload: Callback): ChoiceCallback

Overrides FRCallback.constructor
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/choice-callback.ts:17
Parameters
- payload: Callback
  
  The raw payload returned by OpenAM
Returns ChoiceCallback

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getChoices

getChoices(): string[]

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/choice-callback.ts:42
Gets the choice's possible answers.

Returns string[]

getDefaultChoice

getDefaultChoice(): number

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/choice-callback.ts:35
Gets the choice's default answer.

Returns number

getInputValue

getInputValue(selector?: number | string): unknown

Inherited from FRCallback.getInputValue
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:35
Gets the value of the specified input element, or the first element if selector is not provided.

Parameters
- Default value selector: number | string = 0
  
  The index position or name of the desired element
Returns unknown

getOutputByName

getOutputByName<T>(name: string, defaultValue: T): T

Inherited from FRCallback.getOutputByName
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:65
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

getOutputValue

getOutputValue(selector?: number | string): unknown

Inherited from FRCallback.getOutputValue
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:55
Gets the value of the specified output element, or the first element if selector is not provided.

Parameters
- Default value selector: number | string = 0
  
  The index position or name of the desired element
Returns unknown

getPrompt

getPrompt(): string

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/choice-callback.ts:28
Gets the choice's prompt.

Returns string

getType

getType(): string

Inherited from FRCallback.getType
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:25
Gets the name of this callback type.

Returns string

setChoiceIndex

setChoiceIndex(index: number): void

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/choice-callback.ts:49
Sets the choice's answer by index position.

Parameters
- index: number
Returns void

setChoiceValue

setChoiceValue(value: string): void

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/choice-callback.ts:60
Sets the choice's answer by value.

Parameters
- value: string
Returns void

setInputValue

setInputValue(value: unknown, selector?: number | string | RegExp): void

Inherited from FRCallback.setInputValue
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:45
Sets the value of the specified input element, or the first element if selector is not provided.

Parameters
- value: unknown
- Default value selector: number | string | RegExp = 0
  
  The index position or name of the desired element
Returns void