Bixby Developer Center

References

read-many

optional

Reads several items in a list to a user and asks if the user would like to choose one of the items on the current page. For more information on when to use this, read the Four Types of Hands-Free Mode topic in the Hands-Free and Multiple Devices Design Guide.

Example

input-view {
match: Answer (this) {
to-input: UpdateQuiz (action) {
from-input: Quiz (quiz) {
min (Required)
max (One)
}
}
}
message {
macro (QUIZ_UPDATE_PROMPT) {
param (quiz) {
expression (quiz)
}
}
}

render {
selection-of (action.quiz.questions[action.quiz.currentQuestion].options) {
navigation-mode {
if ($handsFree) {
read-many {
page-size (5)
list-summary {
macro (QUIZ_UPDATE_PROMPT) {
param (quiz) {
expression (quiz)
}
}
}
page-content (page) {
underflow-statement {
macro (HANDS_FREE_OPTION_UNDERFLOW_STATEMENT)
}
item-selection-question {
if (exists(page) && isFirstNavPage(page) && isLastNavPage(page)) { // There is only one page
template ("")
}
else-if (exists(page) && !isLastNavPage(page)) {
macro (HANDS_FREE_OPTION_ITEM_SELECTION_MORE_PAGES)
}
else { // Last page
macro (HANDS_FREE_OPTION_ITEM_SELECTION_LAST_PAGES)
}
}
overflow-statement {
macro (HANDS_FREE_OPTION_OVERFLOW_STATEMENT)
}
overflow-question {
macro (HANDS_FREE_OPTION_OVERFLOW_QUESTION)
}
page-marker {
if (exists(page) && !isFirstNavPage(page) && isLastNavPage(page)) {
macro (HANDS_FREE_OPTION_LAST_OPTION) {
param (page) {
expression (page)
}
}
}
}
}
}
}
}
where-each (option) {
spoken-summary {
template ("#{value(option.alias)} ... #{value(option.text)}")
}
cell-card {
slot2 {
content {
primary {
template ("[#{value(option.alias)}. ]#{value(option.text)}")
}
}
}
}
}
}
}
}

View master on GitHub

Child Keys

item-selection-question[deprecated]
optional
Asks the user to choose an option from the available list
list-summary
optional
Summarizes the list, typically by letting the user know how many options are available
overflow-question[deprecated]
optional
This key is deprecated
overflow-statement[deprecated]
optional
This key is deprecated
page-content
optional
Contains all page-related content information within a view
page-selection-question[deprecated]
optional
This key is deprecated
page-size
optional
Determines how many items per page are read in navigation-mode, if Bixby is reading multiple items at a time
underflow-statement[deprecated]
optional
This key is deprecated
with-navigation-conversation-drivers
optional
Adds system-provided "next" and "previous" conversation drivers to a list navigation