IDashboardEvent

Base type for all dashboard events.

export interface IDashboardEvent<TPayload = any>

Properties

Property	Modifiers	Type	Description
correlationId?	`readonly`	string	(Optional) If this event was triggered as part of a command processing, then the prop will contain command’s correlation ID.
ctx	`readonly`	DashboardContext	Dashboard context in which the event occurred.
meta?	`readonly`	{ acceptedTimestamp: number; }	(Optional) Metadata about the event useful for logging and handling of the event.
payload?	`readonly`	TPayload	(Optional) Specify any additional data the custom event needs.
type	`readonly`	DashboardEventType	Event type. Always starts with “GDC.DASH/EVT”.

If this event was triggered as part of a command processing, then the prop will contain command’s correlation ID.

readonly correlationId?: string;

Dashboard context in which the event occurred.

readonly ctx: DashboardContext;

Metadata about the event useful for logging and handling of the event.

readonly meta?: {
        acceptedTimestamp: number;
    };

Specify any additional data the custom event needs.

readonly payload?: TPayload;

Event type. Always starts with “GDC.DASH/EVT”.

readonly type: DashboardEventType;