Event
Stentor API Reference / stentor-models/src / Event
Interface: Event\<P>
Defined in: packages/stentor-models/src/Events/Event.ts:8
The base structure for an Event. An event must be serializable to a string so it can be reconstructed on the other side.
Extended by
Type Parameters
P
P extends string | boolean | object | number | undefined = undefined
Indexable
[key: string]: any
Any additional keys with which this event contains.
Properties
name
name:
string
Defined in: packages/stentor-models/src/Events/Event.ts:12
The name of this event.
type
type:
EventType
Defined in: packages/stentor-models/src/Events/Event.ts:16
The type of event which is being sent.
appId?
optionalappId:string
Defined in: packages/stentor-models/src/Events/Event.ts:20
Application ID
environment?
optionalenvironment:string
Defined in: packages/stentor-models/src/Events/Event.ts:24
What environment we are in, for example a production or development environment.
platform?
optionalplatform:string
Defined in: packages/stentor-models/src/Events/Event.ts:28
The platform serving the channel
channel?
optionalchannel:string
Defined in: packages/stentor-models/src/Events/Event.ts:32
The channel provided by the platform.
currentHandler?
optionalcurrentHandler:string
Defined in: packages/stentor-models/src/Events/Event.ts:36
The current handler the user was in at the time of the request.
selectedHandler?
optionalselectedHandler:string
Defined in: packages/stentor-models/src/Events/Event.ts:40
The handler that was selected based on the request and the current handler.
isHealthCheck?
optionalisHealthCheck:boolean
Defined in: packages/stentor-models/src/Events/Event.ts:44
Is the event from a health check
isNewSession?
optionalisNewSession:boolean
Defined in: packages/stentor-models/src/Events/Event.ts:48
Is the event the start of a session.
payload?
optionalpayload:P
Defined in: packages/stentor-models/src/Events/Event.ts:52
A serializable payload to associate with the event.