Bixby Developer Center

References

prompt

optionalvalue required

Effect that prompts the user for an input.

Example

In this snippet from the Basic Cart Transactional Capsule, if the user's search term matches more than one item, the user is prompted to choose an item from a list.

  output (SelectedItem) {
throws {

error(MultipleMatches) {
property (matches) {
type (Item)
max (Many)
}
on-catch {
//prompt for matched items, clear searchTerm
prompt (items) {
required-value (true)
single-value (true)
candidates (matches)
}
}
}
}

View 0690617 on GitHub

Child Keys

allow-other
optional
Determines if the user can choose any arbitrary valid values for the input or should only choose from the candidate values
candidates
optional
Candidate values for the input
dialog
optional
An output dialog template that should be rendered upon prompting
max[deprecated]
optional
This key is deprecated
min[deprecated]
optional
This key is deprecated
mode[deprecated]
optional
This key is deprecated
prompt-behavior
optional
A behavioral mode that modifies how the system will prompt on the input or at a prompt during plan execution time
required-value
optional
Restrict the minimum cardinality of the related input based on a boolean expression
single-value
optional
Restrict the maximum cardinality of the related input based on a boolean expression