IEffectiveSettings

Home > @gooddata/sdk-pluggable-application-model > IEffectiveSettings

IEffectiveSettings type

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.

Effective settings for the active application scope.

Signature:

export type IEffectiveSettings = IUserSettings | IUserWorkspaceSettings;

References: IUserSettings, IUserWorkspaceSettings

Remarks

  • On workspace-scoped routes this is IUserWorkspaceSettings, which the backend produces from the org → workspace → user cascade. - On organization-scoped routes this is IUserSettings, which the backend produces from the org → user cascade.

Prefer reading IPlatformContextV1.settings for feature flags, locale, theme keys and other values whose source can be overridden at the workspace level.

Read the raw IPlatformContextV1.userSettings or IPlatformContextV1.workspaceSettings only when you specifically need a field from one shape (e.g. the workspace identifier).

← IContextDeferredAuthCredentialsIHostUiModule →