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 utils/testSupport/TestingUtils

Classes

Functions

findControlByProperty

findControlByProperty(rootControl: IControl, property: string, value: any): any

- Defined in src/utils/testSupport/TestingUtils.ts:69
Find the control with the specified property name and value in the control tree

Parameters
- rootControl: IControl
  
  Root control
- property: string
  
  Property name
- value: any
  
  Property value
Returns any

findControlInTreeById

findControlInTreeById(rootControl: IControl, id: string): any

- Defined in src/utils/testSupport/TestingUtils.ts:59
Find the control with the specified id in the control tree

Parameters
- rootControl: IControl
  
  Root control
- id: string
  
  Control id to search for
Returns any

simpleInvoke

simpleInvoke(rootControl: Control, input: ControlInput): Promise<IControlResult>

- Defined in src/utils/testSupport/TestingUtils.ts:116
Invokes the core handling method of ControlHandler
Purpose:
- for unit-testing the handling functionality (without rendering).
Parameters
- rootControl: Control
  
  Root control
- input: ControlInput
  
  Input
Returns Promise<IControlResult>

testE2E

testE2E(handler: ControlHandler, turns: Array<string | string[] | IControlInput | TestResponseObject>): Promise<void>

- Defined in src/utils/testSupport/TestingUtils.ts:139
Tests a multi-turn script, verifying that the correct prompts are produced on each turn.
For finer-grained control, for assertions and breakpoints, use a sequence of calls to testTurn.

Each user turn comprises three entries:
1. The user utterance. This is not a functional parameter is for documentation / readability.
2. The input object for the turn. This should be synchronized with the user-utterance.
3. The expected response for the turn: prompt, set of allowed prompts or TestResponse object.
The user utterance and expected prompt can start with 'U: ' and 'A: ' to aid readability.
Parameters
- handler: ControlHandler
- turns: Array<string | string[] | IControlInput | TestResponseObject>
  
  Array of 3 entries per logical turn. [utterance, Intent]
Returns Promise<void>

testTurn

testTurn(invoker: SkillInvoker, utterance: string, input: IControlInput, expectedResponse: string | string[] | TestResponseObject): Promise<TestResponseObject>

- Defined in src/utils/testSupport/TestingUtils.ts:171
Test a single turn through the complete runtime flow

Parameters
- invoker: SkillInvoker
  
  SkillInvoker
- utterance: string
  
  Utterance. This is only for documentation / readability.
- input: IControlInput
  
  Input object
- expectedResponse: string | string[] | TestResponseObject
  
  The expected response: prompt, set of allowed prompts or TestResponse object.
Returns Promise<TestResponseObject>

waitForDebugger

waitForDebugger(): void

- Defined in src/utils/testSupport/TestingUtils.ts:47
Returns void

Module utils/testSupport/TestingUtils

Classes

Functions

Functions

findControlByProperty

Parameters

rootControl: IControl

property: string

value: any

Returns any

findControlInTreeById

Parameters

rootControl: IControl

id: string

Returns any

simpleInvoke

Parameters

rootControl: Control

input: ControlInput

Returns Promise<IControlResult>

testE2E

Parameters

handler: ControlHandler

turns: Array<string | string[] | IControlInput | TestResponseObject>

Returns Promise<void>

testTurn

Parameters

invoker: SkillInvoker

utterance: string

input: IControlInput

expectedResponse: string | string[] | TestResponseObject

Returns Promise<TestResponseObject>

waitForDebugger

Returns void