Globals

{"Controls Framework (Major types)":{"Control":"classes/_controls_control_.control","ContainerControl":"modules/_controls_containercontrol_","ControlManager":"modules/_controls_controlmanager_","ControlInput":"classes/_controls_controlinput_.controlinput","ControlResultBuilder":"classes/_controls_controlresult_.controlresultbuilder","ControlResponseBuilder":"classes/_responsegeneration_controlresponsebuilder_.controlresponsebuilder"},"System acts":{"SystemAct":"classes/_systemacts_systemact_.systemact","InitiativeAct":"modules/_systemacts_initiativeacts_","ContentAct":"modules/_systemacts_contentacts_"},"Controls runtime":{"ControlHandler":"classes/_runtime_controlhandler_.controlhandler"},"Controls Library":{"ValueControl":"modules/_commoncontrols_valuecontrol_","ListControl":"modules/_commoncontrols_listcontrol_listcontrol_","DateControl":"modules/_commoncontrols_datecontrol_","DateRangeControl":"modules/_commoncontrols_daterangecontrol_daterangecontrol_","NumberControl":"modules/_commoncontrols_numbercontrol_numbercontrol_","QuestionnaireControl":"modules/_commoncontrols_questionnairecontrol_questionnairecontrol_","MultiValueListControl":"modules/_commoncontrols_multivaluelistcontrol_multivaluelistcontrol_"},"Interaction Model Generation":{"ControlInteractionModelGenerator":"classes/_interactionmodelgeneration_controlinteractionmodelgenerator_.controlinteractionmodelgenerator","GeneralControlIntent":"classes/_intents_generalcontrolintent_.generalcontrolintent","ValueControlIntent":"classes/_intents_valuecontrolintent_.valuecontrolintent","OrdinalControlIntent":"classes/_intents_ordinalcontrolintent_.ordinalcontrolintent","ConjunctionControlIntent":"classes/_intents_conjunctioncontrolintent_.conjunctioncontrolintent","DateRangeControlIntent":"classes/_intents_daterangecontrolintent_.daterangecontrolintent"},"Test support":{"SkillInvoker":"classes/_utils_testsupport_skillinvoker_.skillinvoker","SkillWrapper":"modules/_utils_testsupport_skillwrapper_","TestingUtils":"modules/_utils_testsupport_testingutils_"},"Utilities (selected)":{"InputUtils":"modules/_utils_inpututil_.inpututil","IntentUtils":"modules/_utils_intentutils_","Predicates":"modules/_utils_predicates_"}}

Module commonControls/multiValueListControl/MultiValueListControl

Classes

Interfaces

Type aliases

AplContent

AplContent: object

Type declaration

dataSource: object
- [key: string]: any
document: object
- [key: string]: any

AplContentFunc

AplContentFunc: function

Type declaration

- (control: MultiValueListControl, input: ControlInput): AplContent
- Parameters
  - control: MultiValueListControl
  - input: ControlInput
  Returns AplContent

AplDocumentPropNewStyle

AplDocumentPropNewStyle: AplContent | AplContentFunc

AplRenderComponentFunc

AplRenderComponentFunc: function

Type declaration

- (control: MultiValueListControl, props: MultiValueListAPLComponentProps, input: ControlInput, resultBuilder: ControlResponseBuilder): object
- Parameters
  - control: MultiValueListControl
  - props: MultiValueListAPLComponentProps
  - input: ControlInput
  - resultBuilder: ControlResponseBuilder
  Returns object
  - [key: string]: any

MultiValueListStateValue

MultiValueListStateValue: object

Type declaration

erMatch: boolean

Tracks whether the value is an Entity Resolution match.

If erMatch = true the value is a slot value ID for the slot type this.slotType. If erMatch = false the value may be an arbitrary string.
id: string

Track the slot value.

MultiValueValidationFailure

MultiValueValidationFailure: object

Type declaration

invalidValues: string[]

A list of values which fails validation.
Optional reasonCode?: undefined | string

A code representing what validation failed.
renderedReason: string

A rendered prompt fragment that can be directly included in the Response.

SlotValidationFunction

SlotValidationFunction: function

ListControl validation function

Type declaration

- (values: MultiValueListStateValue[], input: ControlInput): true | MultiValueValidationFailure | Promise<true | MultiValueValidationFailure>
- Parameters
  - values: MultiValueListStateValue[]
  - input: ControlInput
  Returns true | MultiValueValidationFailure | Promise<true | MultiValueValidationFailure>

Module commonControls/multiValueListControl/MultiValueListControl

Classes

Interfaces

Type aliases

Type aliases

AplContent

Type declaration

dataSource: object

[key: string]: any

document: object

[key: string]: any

AplContentFunc

Type declaration

Parameters

control: MultiValueListControl

input: ControlInput

Returns AplContent

AplDocumentPropNewStyle

AplRenderComponentFunc

Type declaration

Parameters

control: MultiValueListControl

props: MultiValueListAPLComponentProps

input: ControlInput

resultBuilder: ControlResponseBuilder

Returns object

[key: string]: any

MultiValueListStateValue

Type declaration

erMatch: boolean

id: string

MultiValueValidationFailure

Type declaration

invalidValues: string[]

Optional reasonCode?: undefined | string

renderedReason: string

SlotValidationFunction

Type declaration

Parameters

values: MultiValueListStateValue[]

input: ControlInput

Returns true | MultiValueValidationFailure | Promise<true | MultiValueValidationFailure>