LambdaFinishEvent
Stentor API Reference / stentor-models/src / LambdaFinishEvent
Interface: LambdaFinishEvent
Defined in: packages/stentor-models/src/Events/LambdaFinishEvent.ts:5
The base structure for an Event. An event must be serializable to a string so it can be reconstructed on the other side.
Extendsβ
Event<string>
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.
Inherited fromβ
appId?β
optionalappId?:string
Defined in: packages/stentor-models/src/Events/Event.ts:20
Application ID
Inherited fromβ
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.
Inherited fromβ
platform?β
optionalplatform?:string
Defined in: packages/stentor-models/src/Events/Event.ts:28
The platform serving the channel
Inherited fromβ
channel?β
optionalchannel?:string
Defined in: packages/stentor-models/src/Events/Event.ts:32
The channel provided by the platform.
Inherited fromβ
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.
Inherited fromβ
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.
Inherited fromβ
isHealthCheck?β
optionalisHealthCheck?:boolean
Defined in: packages/stentor-models/src/Events/Event.ts:44
Is the event from a health check
Inherited fromβ
isNewSession?β
optionalisNewSession?:boolean
Defined in: packages/stentor-models/src/Events/Event.ts:48
Is the event the start of a session.
Inherited fromβ
payload?β
optionalpayload?:string
Defined in: packages/stentor-models/src/Events/Event.ts:52
A serializable payload to associate with the event.
Inherited fromβ
typeβ
type:
"LambdaErrorEvent"|"LambdaSuccessEvent"
Defined in: packages/stentor-models/src/Events/LambdaFinishEvent.ts:6
The type of event which is being sent.