ClientWorkspaceProvider() · GoodData.UI API reference

Home > @gooddata/sdk-ui > ClientWorkspaceProvider

ClientWorkspaceProvider() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

ClientWorkspaceProvider can be used as a replacement of the WorkspaceProvider(), if you want to work with the workspace in LCM context.

It allows you to: - Use dataProduct and client identifier as a replacement of the workspace identifier. Workspace identifier is resolved and provided to the WorkspaceProvider() automatically.

Use workspace identifier to obtain dataProduct, client and segment identifiers by the useClientWorkspaceIdentifiers() hooks.

If the backend does not support clientId / dataProduct LCM provisioning, or the workspace is not provisioned via LCM, segment / client / dataProduct values will be undefined.

To read more details about LCM, see: https://help.gooddata.com/pages/viewpage.action?pageId=86796865

Signature:

export declare function ClientWorkspaceProvider(props: IClientWorkspaceProviderProps): React.JSX.Element;

Parameters

Parameter	Type	Description
props	IClientWorkspaceProviderProps

Returns:

React.JSX.Element