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 MultiValueListControlAPLPropsBuiltIns

Interfaces

DefaultSelectValueAPLProps

Functions

defaultSelectValueAPLContent

defaultSelectValueAPLContent(props: DefaultSelectValueAPLProps): function

- Defined in src/commonControls/multiValueListControl/MultiValueListControlAPL.ts:63
Parameters
- props: DefaultSelectValueAPLProps
Returns function
- - (control: MultiValueListControl, input: ControlInput): AplContent
  - Parameters
    - control: MultiValueListControl
    - input: ControlInput
    Returns AplContent

multiValueListDataSourceGenerator

multiValueListDataSourceGenerator(control: MultiValueListControl, input: ControlInput, contentProps: DefaultSelectValueAPLProps): object

- Defined in src/commonControls/multiValueListControl/MultiValueListControlAPL.ts:81
The APL dataSource to use when requesting a value

Default: A TextListLayout data source to bind to an APL document. See https://developer.amazon.com/en-US/docs/alexa/alexa-presentation-language/apl-data-source.html

Parameters
- control: MultiValueListControl
- input: ControlInput
- contentProps: DefaultSelectValueAPLProps
Returns object
- choices: object
  - listItems: object[]
- general: object
  - controlId: string
  - headerSubtitle: undefined | string
  - headerTitle: undefined | string
  - selectionListSubtitle: undefined | string
  - selectionListTitle: undefined | string
- selections: object
  - listItems: object[]

multiValueListDocumentGenerator

multiValueListDocumentGenerator(control: MultiValueListControl, input: ControlInput): object

- Defined in src/commonControls/multiValueListControl/MultiValueListControlAPL.ts:133
The APL document to use when selecting a value

Default: A dual-TextListLayout document one with scrollable and clickable list and another with swipeAction to remove items from list. See https://developer.amazon.com/en-US/docs/alexa/alexa-presentation-language/apl-alexa-text-list-layout.html

Parameters
- control: MultiValueListControl
- input: ControlInput
Returns object
- import: object[]
- layouts: object
- type: string
- version: string
- graphics: object
  - cancel: object
    - height: number
    - items: object[]
    - parameters: string[]
    - type: string
    - version: string
    - width: number
- mainTemplate: object
  - items: object[]
  - parameters: string[]

Namespace MultiValueListControlAPLPropsBuiltIns

Interfaces

Functions

Functions

defaultSelectValueAPLContent

Parameters

props: DefaultSelectValueAPLProps

Returns function

Parameters

control: MultiValueListControl

input: ControlInput

Returns AplContent

multiValueListDataSourceGenerator

Parameters

control: MultiValueListControl

input: ControlInput

contentProps: DefaultSelectValueAPLProps

Returns object

choices: object

listItems: object[]

general: object

controlId: string

headerSubtitle: undefined | string

headerTitle: undefined | string

selectionListSubtitle: undefined | string

selectionListTitle: undefined | string

selections: object

listItems: object[]

multiValueListDocumentGenerator

Parameters

control: MultiValueListControl

input: ControlInput

Returns object

import: object[]

layouts: object

type: string

version: string

graphics: object

cancel: object

height: number

items: object[]

parameters: string[]

type: string

version: string

width: number

mainTemplate: object

items: object[]

parameters: string[]