PlaybackControlRequestEvent

Stentor API Reference

---

Stentor API Reference / stentor-models/src / PlaybackControlRequestEvent

Interface: PlaybackControlRequestEvent

Defined in: packages/stentor-models/src/Events/RequestEvent.ts:31

The base structure for an Event. An event must be serializable to a string so it can be reconstructed on the other side.

Extends

• RequestEvent\<PlaybackControlRequestPayload>

Indexable

[key: string]: any

Any additional keys with which this event contains.

Properties

appId?

optional appId: string

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

Application ID

Inherited from

RequestEvent.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

RequestEvent.environment

---

platform?

optional platform: string

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

The platform serving the channel

Inherited from

RequestEvent.platform

---

channel?

optional channel: string

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

The channel provided by the platform.

Inherited from

RequestEvent.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

RequestEvent.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

RequestEvent.selectedHandler

---

isHealthCheck?

optional isHealthCheck: boolean

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

Is the event from a health check

Inherited from

RequestEvent.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

RequestEvent.isNewSession

---

payload?

optional payload: PlaybackControlRequestPayload

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

A serializable payload to associate with the event.

Inherited from

RequestEvent.payload

---

type

type: "REQUEST"

Defined in: packages/stentor-models/src/Events/RequestEvent.ts:13

The type of event which is being sent.

Inherited from

RequestEvent.type

---

name

name: "PLAYBACK_CONTROL_REQUEST"

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

The name of this event.

Overrides

RequestEvent.name