List Widget for Voice - supports the common use case when a user needs to
interact with one of multiple items.
Parameters:
| Name | Type | Description |
|---|---|---|
violet |
Violet | the pointer to the violet instance so that we can
hook in appropriately to script resources. This plugin does expect that
the calling script defineGoal with goal name as given by the
interactionGoal method. |
dataType |
string | a string representing the type for the contents
of this widget. This widget is called by setting the list in question with
name being the same as the dataType and calling the
respondWithItems method. |
humanName |
string | what to refer to an item in this list when speaking to the user. |
humanNamePl |
string | what to refer to mutliple items in this list when speaking to the user. |
itemTextProp |
string | how to get the itemText (the main name) of a list item. |
Parameters:
| Name | Type | Description |
|---|---|---|
violet |
Violet | the pointer to the violet instance so that we can
hook in appropriately to script resources. This plugin does expect that
the calling script defineGoal with goal name as given by the
interactionGoal method. |
widgetType |
string | a string representing the type for the contents
of this widget. This widget is called by setting the list in question with
name being the same as the widgetType and calling the
respondWithItems method. |
humanName |
string | what to refer to an item in this list when speaking to the user. |
humanNamePl |
string | what to refer to mutliple items in this list when speaking to the user. |
itemTextProp |
string | how to get the itemText (the main name) of a list item. |