Class: DashboardService

Service for communicating with the streamer's dashboard: lets an app surface a custom event that will be displayed in the streamer's interface.

Remarks

Available everywhere via k.dashboard. You never have to instantiate this service yourself — it is created by the SDK when the app/widget starts.

Example

await k.dashboard.customEvent('Boss defeated', 'The chat beat the boss in 3 min!');

Implements

• ServiceInterface

Methods

customEvent()

customEvent(title, message?): Promise<void>;

Pushes a custom event to the streamer's dashboard (title + optional message), for example to flag a notable moment in the running app.

Parameters

title

string

The event title (short, highlighted text).

message?

string = null

An optional supplementary message.

Returns

Promise<void>

A promise that resolves once the event has been sent to the dashboard.

Default Value

null

Example

await k.dashboard.customEvent('New record', 'Score beaten: 12,480 points');