macaroni

pick

Description:
The pick executor is used to display a list of choices to the user with a selection type experience.

Parent: execute, then, else

Value (simple form): string specifying the choices to display to the user
Value (key/value form):

• pick: string, multiline string, or sequence of string, required, specifying the choices to display to the user
• type: string, optional, specifying the type of choice picking experience, dialog (default) or menu
• title: string, optional, specifying the pick dialog box title (default is null)
• image: string, optional, specifying the name of an image to display in pick dialog box (default is null)
• timeout: time, optional, specifying the amount of time, after which the pick experience will be dismissed (default is null)
  • if timeout is null, the pick experience will not be automatically dismissed
  • if timeout has no unit, milliseconds is assumed
• default: string or integer, optional, specifying the default selection in the pick dialog experience

# simple form
- pick: (string)

# simple example
- pick: |
    Maybe
    Yes
    No

# key/value form
- pick: (string or sequence of string, required)
  type: (string, optional)
  title: (string, optional)
  image: (string, optional)
  timeout: (time, optional)
  default: (string or integer, optional)

# key/value example
- pick:
  - Maybe
  - Yes
  - No
  timeout: 5s
  default: 0

EXAMPLE:

# pick a color with the pick executor
- name: pick a color
  triggers:
  - pick a color
  execute:
  - pick:
    - red
    - green
    - blue
    message: Pick one of the following colors
    default: blue
  - speak: 'you picked {pick.text}'

Additional information:

• Only one pick menu type experience can be displayed on the screen at a time
• More than one pick dialog experience can be displayed on the screen at a time, from different command executions
• After the user choses an item from the pick experience, subsequent executors in the same execution context can access the selection:
  • {pick.text} - the text of the choice
  • {pick.index} - the index of the choice

Status: ✅ IMPLEMENTED (note: pick.index resolver is not yet implemented)