IDashboardCommand
Base type for all commands.
export interface IDashboardCommand
Remarks
Commands are dispatched using dispatcher obtained by useDashboardDispatcher(). All the dispatchers are ‘contextual’ - they target backend, workspace and dashboard in depending on the Dashboard component tree from which the dispatch is done.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | (Optional) Correlation ID can be provided when creating a command. | |
| (Optional) Metadata related to processing of the command by the dashboard component. | ||
| Command type. Always starts with “GDC.DASH/CMD” |
Property details
IDashboardCommand.correlationIdproperty
Correlation ID can be provided when creating a command.
readonly correlationId?: string;
Remarks
All events emitted during the command processing will contain the same correlation ID.
If the correlation ID is not specified, a random string will be assigned.
IDashboardCommand.metaproperty
Metadata related to processing of the command by the dashboard component.
readonly meta?: CommandProcessingMeta;
Remarks
Note: this metadata is added by the dashboard component. It will be added dynamically to command right after its dispatch.
IDashboardCommand.typeproperty
Command type. Always starts with “GDC.DASH/CMD”
readonly type: DashboardCommandType;