userInteractionTriggered()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the IDashboardUserInteractionTriggered event body.
export declare function userInteractionTriggered(interactionPayloadOrType: UserInteractionPayload | BareUserInteractionType, correlationId?: string): DashboardEventBody<IDashboardUserInteractionTriggered>;
Parameters
Parameter | Type | Description |
|---|---|---|
interactionPayloadOrType | interaction payload or a type of user interaction without extra data (for convenience) | |
correlationId | string | (Optional) specify correlation id to use for this event. this can be used to correlate this event to a command that caused it. |
Returns