Device
Stentor API Reference / stentor-models/src / Device
Interface: Device
Defined in: packages/stentor-models/src/Device.ts:23
Describes the capability of the device where the request originated.
It also provides insight to how you can respond to the current request as it isn't always possible to return speech.
Properties
channel
channel:
string
Defined in: packages/stentor-models/src/Device.ts:29
The channel the user is on.
Deprecated
Use the channel on the request object instead
audioSupported
audioSupported:
boolean
Defined in: packages/stentor-models/src/Device.ts:33
If the device is capable of playing audio.
canPlayAudio
canPlayAudio:
boolean
Defined in: packages/stentor-models/src/Device.ts:37
If the current request can be responded to with audio.
videoSupported
videoSupported:
boolean
Defined in: packages/stentor-models/src/Device.ts:41
If the device is capable of playing video.
canPlayVideo
canPlayVideo:
boolean
Defined in: packages/stentor-models/src/Device.ts:45
If the current request can be responded to with video.
canSpeak
canSpeak:
boolean
Defined in: packages/stentor-models/src/Device.ts:50
If the device (and current request) can be responded to with speech
canThrowCard
canThrowCard:
boolean
Defined in: packages/stentor-models/src/Device.ts:54
If the device (and current request) can throw a card
canTransferCall
canTransferCall:
boolean
Defined in: packages/stentor-models/src/Device.ts:60
If the device is capable to transfer calls (usually to an live agent).
Telephony channels typically can perform this.
hasScreen
hasScreen:
boolean
Defined in: packages/stentor-models/src/Device.ts:67
If the device has a screen.
Used to determine if we can link accounts on Google or return display interfaces on Alexa.
hasWebBrowser
hasWebBrowser:
boolean
Defined in: packages/stentor-models/src/Device.ts:73
If the device has web browser capability
Google assistant app has it, hub doesn't
displayData?
optionaldisplayData:DisplayData
Defined in: packages/stentor-models/src/Device.ts:79
Display data
Used to tell a little bit more about the display type if data is available
mediaPlayerStatus?
optionalmediaPlayerStatus:MediaPlayerStatus
Defined in: packages/stentor-models/src/Device.ts:83
Some channels and devices also support media playback