ListItem

Stentor API Reference

---

Stentor API Reference / stentor-models/src / ListItem

Interface: ListItem

Defined in: packages/stentor-models/src/Display/List/List.ts:73

Properties

title

title: string

Defined in: packages/stentor-models/src/Display/List/List.ts:77

Title of the list item, referred to as PrimaryText on Alexa.

---

token

token: string

Defined in: packages/stentor-models/src/Display/List/List.ts:83

Used as a reference for when the list item is selected.

This is the same as a key on Google.

---

synonyms?

optional synonyms: string[]

Defined in: packages/stentor-models/src/Display/List/List.ts:89

Synonyms can be added so the user can speak the selection instead of touching the screen.

Only supported on Google.

---

description?

optional description: string

Defined in: packages/stentor-models/src/Display/List/List.ts:93

Description text of the list item, referred to as SecondaryText on Alexa.

---

image?

optional image: ListImage

Defined in: packages/stentor-models/src/Display/List/List.ts:97

The image for the list item.

---

url?

optional url: string

Defined in: packages/stentor-models/src/Display/List/List.ts:103

URL to open when the list item is selected.

Not applicable to list type CAROUSEL or available on channels without a web browser available.

---

buttons?

optional buttons: ListButton[]

Defined in: packages/stentor-models/src/Display/List/List.ts:107

Optional list of buttons that will be displayed on the list item.