changeSharing()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeSharing command. Dispatching this command will result in change of sharing status of dashboard. The changes will be done in-memory and also propagated to the backend.
export declare function changeSharing(newSharingProperties: ISharingApplyPayload, correlationId?: string): IChangeSharing;
Parameters
Parameter | Type | Description |
|---|---|---|
newSharingProperties | ISharingApplyPayload | new dashboard sharing properties |
correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns