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_"}}

Namespace InputUtil

Utilities to assist with input handling.

Functions

actionIsMatch

actionIsMatch(action: string | undefined, expectedValues: string[]): boolean

- Defined in src/utils/InputUtil.ts:204
Test if the action is defined and matches one of the provided identifiers.

Parameters
- action: string | undefined
  
  Action slot value ID
- expectedValues: string[]
  
  Action slot value IDs to match against
Returns boolean

actionIsMatchOrUndefined

actionIsMatchOrUndefined(action: string | undefined, actionIds: string[]): boolean

- Defined in src/utils/InputUtil.ts:255
Test if the action matches one of the provided identifiers, or is undefined.

Parameters
- action: string | undefined
  
  Action slot value ID
- actionIds: string[]
Returns boolean

actionIsSetOrUndefined

actionIsSetOrUndefined(action: string | undefined, expectedValues: string[]): boolean

- Defined in src/utils/InputUtil.ts:195
Test if the action matches one of the provided identifiers, or is undefined.

Parameters
- action: string | undefined
  
  Action slot value ID
- expectedValues: string[]
  
  Action slot value IDs to match against
Returns boolean

actionIsUndefined

actionIsUndefined(action: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:212
Test if the action is undefined.

Parameters
- action: string | undefined
  
  Action slot value ID
Returns boolean

feedbackIsDefined

feedbackIsDefined(feedback: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:160
Test if the feedback is defined

Parameters
- feedback: string | undefined
  
  Feedback slot value ID
Returns boolean

feedbackIsFalse

feedbackIsFalse(feedback: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:152
Test if the feedback is 'builtin_disaffirm'

Parameters
- feedback: string | undefined
  
  Feedback slot value ID
Returns boolean

feedbackIsMatchOrUndefined

feedbackIsMatchOrUndefined(feedback: string | undefined, feedbackIds: string[]): boolean

- Defined in src/utils/InputUtil.ts:177
Test if the feedback matches one of the provided identifiers, or is undefined.

Parameters
- feedback: string | undefined
  
  Feedback slot value
- feedbackIds: string[]
  
  Feedback slot value IDs to match against
Returns boolean

feedbackIsTrue

feedbackIsTrue(feedback: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:143
Test if the feedback is 'builtin_affirm'

Parameters
- feedback: string | undefined
  
  Feedback slot value ID
Returns boolean

feedbackIsUndefined

feedbackIsUndefined(feedback: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:168
Test if the feedback is undefined

Parameters
- feedback: string | undefined
  
  Feedback slot value ID
Returns boolean

getMultiValueResolution

getMultiValueResolution(input: ControlInput): MultiValueSlot[]

- Defined in src/utils/InputUtil.ts:370
Extracts the value and erMatch array list from a ValueControlIntent

Parameters
- input: ControlInput
  
  Input
Returns MultiValueSlot[]

getValueResolution

getValueResolution(input: ControlInput): object

- Defined in src/utils/InputUtil.ts:360
Extracts the value and erMatch from a ValueControlIntent

Parameters
- input: ControlInput
  
  Input
Returns object
- erMatch: boolean
- valueStr: string

isAPLUserEventWithArgs

isAPLUserEventWithArgs(input: ControlInput): boolean

- Defined in src/utils/InputUtil.ts:87
Test if the input is an Alexa.Presentation.APL.UserEvent and has arguments.

Parameters
- input: ControlInput
  
  Input
Returns boolean

isAPLUserEventWithMatchingControlId

isAPLUserEventWithMatchingControlId(input: ControlInput, controlId: string): boolean

- Defined in src/utils/InputUtil.ts:113
Test if the input is an Alexa.Presentation.APL.UserEvent with a first argument equal to the provided control ID.

Parameters
- input: ControlInput
  
  Input
- controlId: string
  
  the expected control ID
Returns boolean

isAPLUserEventWithMatchingControlIdAndArgLength

isAPLUserEventWithMatchingControlIdAndArgLength(input: ControlInput, controlId: string, argLength: number): boolean

- Defined in src/utils/InputUtil.ts:127
Test if the input is an Alexa.Presentation.APL.UserEvent with a first argument equal to the provided control ID and total argument length equal to the provided length.

Parameters
- input: ControlInput
  
  Input
- controlId: string
  
  the expected control ID
- argLength: number
  
  the expected argument length
Returns boolean

isAPLUserEventWithMatchingSourceId

isAPLUserEventWithMatchingSourceId(input: ControlInput, sourceId: string): boolean

- Defined in src/utils/InputUtil.ts:100
Test if the input is an Alexa.Presentation.APL.UserEvent with sourceId equal to the provided source ID.

Parameters
- input: ControlInput
  
  Input
- sourceId: string
Returns boolean

isBareNo

isBareNo(input: ControlInput): boolean

- Defined in src/utils/InputUtil.ts:340
Test if the input is equivalent to simply saying "no".

Parameters
- input: ControlInput
  
  Input
Returns boolean

true if the input is:
- AMAZON.NoIntent, or,
- A GeneralControlIntent with feedback = builtin_disaffirm and no other filled.

isBareYes

isBareYes(input: ControlInput): boolean

- Defined in src/utils/InputUtil.ts:314
Test if the input is equivalent to simply saying "yes".

Parameters
- input: ControlInput
  
  Input
Returns boolean

true if the input is:
- AMAZON.YesIntent, or,
- A GeneralControlIntent with feedback = builtin_affirm and no other filled.

isFallbackIntent

isFallbackIntent(input: ControlInput): boolean

- Defined in src/utils/InputUtil.ts:77
Test if the input is an AMAZON.FallbackIntent.

Parameters
- input: ControlInput
  
  Input
Returns boolean

isIntent

isIntent(input: ControlInput, expectedIntentName?: undefined | string): boolean

- Defined in src/utils/InputUtil.ts:55
Test if the input is an IntentRequest (and optionally a specific Intent).

Parameters
- input: ControlInput
  
  Input
- Optional expectedIntentName: undefined | string
  
  a specific intent name
Returns boolean

isIntentShape

isIntentShape(x: any): x

- Defined in src/utils/InputUtil.ts:29
Test and assert if an object looks like an Intent. (user-defined type guard)

Parameters
- x: any
Returns x

isLaunchRequest

isLaunchRequest(input: ControlInput): boolean

- Defined in src/utils/InputUtil.ts:37
Test if the input is a LaunchRequest.

Parameters
- input: ControlInput
  
  Input
Returns boolean

isSessionEndedRequest

isSessionEndedRequest(input: ControlInput): boolean

- Defined in src/utils/InputUtil.ts:45
Test if the input is a SessionEndedRequest.

Parameters
- input: ControlInput
  
  Input
Returns boolean

isValueControlIntent

isValueControlIntent(input: ControlInput, slotType: string): boolean

- Defined in src/utils/InputUtil.ts:66
Test if the input is a ValueControlIntent for the provided slotType.

Parameters
- input: ControlInput
  
  Input
- slotType: string
Returns boolean

slotIsUndefinedOrMatch

slotIsUndefinedOrMatch(slotValue: string | undefined, expectedValues: string[]): boolean

- Defined in src/utils/InputUtil.ts:186
Test if the slot value matches one of the provided identifiers, or is undefined.

Parameters
- slotValue: string | undefined
  
  Slot value ID
- expectedValues: string[]
  
  Slot value IDs to match against
Returns boolean

targetIsDefined

targetIsDefined(target: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:229
Test if the feedback is defined.

Parameters
- target: string | undefined
  
  Target slot value ID
Returns boolean

targetIsMatch

targetIsMatch(target: string | undefined, targetIds: string[]): boolean

- Defined in src/utils/InputUtil.ts:221
Test if the target is defined and matches one of the provided identifiers.

Parameters
- target: string | undefined
  
  Target slot value ID
- targetIds: string[]
  
  Target slot value IDs to match against
Returns boolean

targetIsMatchOrUndefined

targetIsMatchOrUndefined(target: string | undefined, targetIds: string[]): boolean

- Defined in src/utils/InputUtil.ts:246
Test if the target matches one of the provided identifiers, or is undefined.

Parameters
- target: string | undefined
  
  Target slot value ID
- targetIds: string[]
  
  Target slot value IDs to match against
Returns boolean

targetIsUndefined

targetIsUndefined(target: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:237
Test if the feedback is undefined.

Parameters
- target: string | undefined
  
  Target slot value ID
Returns boolean

valueStrDefined

valueStrDefined(value: MultiValueSlot[] | string | undefined): boolean

- Defined in src/utils/InputUtil.ts:288
Test if the value is defined.

A value of '?' is interpreted as being equal to undefined. (A value of '?' is produced by NLU when slot elicitation is used but the response cannot be understood.)

Parameters
- value: MultiValueSlot[] | string | undefined
  
  Value
Returns boolean

valueStrIsUndefined

valueStrIsUndefined(value: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:300
Test if the value is undefined.

A value of '?' is interpreted as being equal to undefined. (A value of '?' is produced by NLU when slot elicitation is used but the response cannot be understood.)

Parameters
- value: string | undefined
  
  Value
Returns boolean

valueTypeIsUndefined

valueTypeIsUndefined(valueType: string | undefined): boolean

- Defined in src/utils/InputUtil.ts:276
Test if the valueType is undefined.

Parameters
- valueType: string | undefined
  
  ValueType slot value ID
Returns boolean

valueTypeMatch

valueTypeMatch(valueType: string | undefined, expectedValueType: string | string[]): boolean

- Defined in src/utils/InputUtil.ts:264
Test if the valueType is defined and matches the provided identifier.

Parameters
- valueType: string | undefined
  
  ValueType slot value ID
- expectedValueType: string | string[]
  
  ValueType slot value ID to match against
Returns boolean

Namespace InputUtil

Functions

Functions

actionIsMatch

Parameters

action: string | undefined

expectedValues: string[]

Returns boolean

actionIsMatchOrUndefined

Parameters

action: string | undefined

actionIds: string[]

Returns boolean

actionIsSetOrUndefined

Parameters

action: string | undefined

expectedValues: string[]

Returns boolean

actionIsUndefined

Parameters

action: string | undefined

Returns boolean

feedbackIsDefined

Parameters

feedback: string | undefined

Returns boolean

feedbackIsFalse

Parameters

feedback: string | undefined

Returns boolean

feedbackIsMatchOrUndefined

Parameters

feedback: string | undefined

feedbackIds: string[]

Returns boolean

feedbackIsTrue

Parameters

feedback: string | undefined

Returns boolean

feedbackIsUndefined

Parameters

feedback: string | undefined

Returns boolean

getMultiValueResolution

Parameters

input: ControlInput

Returns MultiValueSlot[]

getValueResolution

Parameters

input: ControlInput

Returns object

erMatch: boolean

valueStr: string

isAPLUserEventWithArgs

Parameters

input: ControlInput

Returns boolean

isAPLUserEventWithMatchingControlId

Parameters

input: ControlInput

controlId: string

Returns boolean

isAPLUserEventWithMatchingControlIdAndArgLength

Parameters

input: ControlInput

controlId: string

argLength: number

Returns boolean

isAPLUserEventWithMatchingSourceId

Parameters

input: ControlInput

sourceId: string

Returns boolean

isBareNo

Parameters

input: ControlInput

Returns boolean

isBareYes

Parameters

input: ControlInput