Skip to main content

LambdaFinishEvent

Stentor API Reference

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​

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​

Event.name

appId?​

optional appId: string

Defined in: packages/stentor-models/src/Events/Event.ts:20

Application ID

Inherited from​

Event.appId

environment?​

optional environment: 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​

Event.environment

platform?​

optional platform: string

Defined in: packages/stentor-models/src/Events/Event.ts:28

The platform serving the channel

Inherited from​

Event.platform

channel?​

optional channel: string

Defined in: packages/stentor-models/src/Events/Event.ts:32

The channel provided by the platform.

Inherited from​

Event.channel

currentHandler?​

optional currentHandler: 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​

Event.currentHandler

selectedHandler?​

optional selectedHandler: 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​

Event.selectedHandler

isHealthCheck?​

optional isHealthCheck: boolean

Defined in: packages/stentor-models/src/Events/Event.ts:44

Is the event from a health check

Inherited from​

Event.isHealthCheck

isNewSession?​

optional isNewSession: boolean

Defined in: packages/stentor-models/src/Events/Event.ts:48

Is the event the start of a session.

Inherited from​

Event.isNewSession

payload?​

optional payload: string

Defined in: packages/stentor-models/src/Events/Event.ts:52

A serializable payload to associate with the event.

Inherited from​

Event.payload

type​

type: "LambdaErrorEvent" | "LambdaSuccessEvent"

Defined in: packages/stentor-models/src/Events/LambdaFinishEvent.ts:6

The type of event which is being sent.

Overrides​

Event.type