Edit

Share via

WorkloadSettings interface

  • Reference
Package:
@ms-fabric/workload-client

An interface representing setting properties that are specific to the current workload iframe, as well as properties that can be shared across multiple workloads

Extends
WorkloadSettingsContextAgnostic

Properties

instanceId

instanceId per iframe. Once workload is initialized, an iframe is created per workload per session untill that iframe window is killed by framework at some point.

Inherited Properties

apiUri

The base URL of Fabric API in the Backend that stores the tenant metadata.
currentFormatLocale

The current user’s locale used for date and time format. The format locale is a valid BCP 47 tag. For more information about the BCP 47, please visit: https://www.rfc-editor.org/rfc/bcp/bcp47.txt Currently, the value is the same with currentLanguageLocale. In the future, we will add regional setting in user settings and this value will be aligned with regional setting and might be different from currentLanguageLocale.
currentLanguageLocale

The current user locale chosen by user. This will be replaced by feature flag overwrite or browser default language. This locale is aligned with user settings' language setting and used for language localization. For example, "en-US" for English US locale
debugSwitches

All the available debug switches. Stored as KV pair.
featureSwitches

All the available feature switches. Stored as KV pair.
isInformationProtectionSupportedForFabric

Evaluate if information protection supported for fabric
m365UserPreferredLanguage

The user preferred language chosen by user across M365 endpoints.
myFolderObjectId

If the user's workspace is a V2 workspace, also known as "My Folder", this property will return the GUID of the workspace. Otherwise, it will return undefined.
productName

productName for current workload
resourceUrl

The URL of Fabric API Resource Id
sessionId

SessionId for current logged in user's session
sharedBackendUri

The base URL of Shared Backend that stores the tenant metadata.
workloadHostApp

The application that hosts the workload. Example: 0 for Fabric Web app, 1 for Embed app.
workloadHostOrigin

The origin of Workload Host.

Property Details

instanceId

instanceId per iframe. Once workload is initialized, an iframe is created per workload per session untill that iframe window is killed by framework at some point.

instanceId: string

Property Value

string

Inherited Property Details

apiUri

The base URL of Fabric API in the Backend that stores the tenant metadata.

apiUri: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.apiUri

currentFormatLocale

The current user’s locale used for date and time format. The format locale is a valid BCP 47 tag. For more information about the BCP 47, please visit: https://www.rfc-editor.org/rfc/bcp/bcp47.txt Currently, the value is the same with currentLanguageLocale. In the future, we will add regional setting in user settings and this value will be aligned with regional setting and might be different from currentLanguageLocale.

currentFormatLocale: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.currentFormatLocale

currentLanguageLocale

The current user locale chosen by user. This will be replaced by feature flag overwrite or browser default language. This locale is aligned with user settings' language setting and used for language localization. For example, "en-US" for English US locale

currentLanguageLocale: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.currentLanguageLocale

debugSwitches

All the available debug switches. Stored as KV pair.

debugSwitches: Record<string, string>

Property Value

Record<string, string>

Inherited From WorkloadSettingsContextAgnostic.debugSwitches

featureSwitches

All the available feature switches. Stored as KV pair.

featureSwitches: Record<string, boolean>

Property Value

Record<string, boolean>

Inherited From WorkloadSettingsContextAgnostic.featureSwitches

isInformationProtectionSupportedForFabric

Evaluate if information protection supported for fabric

isInformationProtectionSupportedForFabric: boolean

Property Value

boolean

Inherited From WorkloadSettingsContextAgnostic.isInformationProtectionSupportedForFabric

m365UserPreferredLanguage

The user preferred language chosen by user across M365 endpoints.

m365UserPreferredLanguage?: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.m365UserPreferredLanguage

myFolderObjectId

If the user's workspace is a V2 workspace, also known as "My Folder", this property will return the GUID of the workspace. Otherwise, it will return undefined.

myFolderObjectId?: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.myFolderObjectId

productName

productName for current workload

productName: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.productName

resourceUrl

The URL of Fabric API Resource Id

resourceUrl: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.resourceUrl

sessionId

SessionId for current logged in user's session

sessionId: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.sessionId

sharedBackendUri

The base URL of Shared Backend that stores the tenant metadata.

sharedBackendUri: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.sharedBackendUri

workloadHostApp

The application that hosts the workload. Example: 0 for Fabric Web app, 1 for Embed app.

workloadHostApp: WorkloadHostApp

Property Value

WorkloadHostApp

Inherited From WorkloadSettingsContextAgnostic.workloadHostApp

workloadHostOrigin

The origin of Workload Host.

workloadHostOrigin: string

Property Value

string

Inherited From WorkloadSettingsContextAgnostic.workloadHostOrigin