Skip to main content

ChannelData

Stentor API Reference


Stentor API Reference / stentor-models/src / ChannelData

Interface: ChannelData

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:8

Channel data, all channel data extends from this object.

Properties​

id​

id: string

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:12

Unique ID of the channel.


type​

type: string

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:16

The channel type


useNLU?​

optional useNLU: string

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:25

ID of the NLU to use within app.nlu[].

If it exists, the channel will use the provided NLU at runtime to convert the raw text to an Intent.

If the value is "*", then it will pick the first available NLU within app.nlu[]


endPoint?​

optional endPoint: string

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:29

URI where the channel can be accessed.


directoryListing?​

optional directoryListing: string

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:33

URL for the directory listing


status?​

optional status: FullAppStatus

Defined in: packages/stentor-models/src/Channel/ChannelData.ts:40

The status of the app with respect to this current channel.

An example may be that an app is currently live on Alexa but being built on Google Home.