userInteractionTriggered()
Home > @gooddata/sdk-ui-dashboard > userInteractionTriggered
userInteractionTriggered() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the DashboardUserInteractionTriggered event body.
Signature:
export declare function userInteractionTriggered(interactionPayloadOrType: UserInteractionPayload | BareUserInteractionType, correlationId?: string): DashboardEventBody<DashboardUserInteractionTriggered>;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
interactionPayloadOrType |
interaction payload or a type of a 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: