WorkloadSettingsContextAgnostic interface
An interface representing setting properties that are shared across different workloads
Properties
api |
The base URL of Fabric API in the Backend that stores the tenant metadata. |
current |
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. |
current |
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 |
debug |
All the available debug switches. Stored as KV pair. |
feature |
All the available feature switches. Stored as KV pair. |
is |
Evaluate if information protection supported for fabric |
m365User |
The user preferred language chosen by user across M365 endpoints. |
my |
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. |
product |
productName for current workload |
resource |
The URL of Fabric API Resource Id |
session |
SessionId for current logged in user's session |
shared |
The base URL of Shared Backend that stores the tenant metadata. |
workload |
The application that hosts the workload. Example: 0 for Fabric Web app, 1 for Embed app. |
workload |
The origin of Workload Host. |
Property Details
apiUri
The base URL of Fabric API in the Backend that stores the tenant metadata.
apiUri: string
Property Value
string
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
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
debugSwitches
All the available debug switches. Stored as KV pair.
debugSwitches: Record<string, string>
Property Value
Record<string, string>
featureSwitches
All the available feature switches. Stored as KV pair.
featureSwitches: Record<string, boolean>
Property Value
Record<string, boolean>
isInformationProtectionSupportedForFabric
Evaluate if information protection supported for fabric
isInformationProtectionSupportedForFabric: boolean
Property Value
boolean
m365UserPreferredLanguage
The user preferred language chosen by user across M365 endpoints.
m365UserPreferredLanguage?: string
Property Value
string
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
productName
productName for current workload
productName: string
Property Value
string
resourceUrl
The URL of Fabric API Resource Id
resourceUrl: string
Property Value
string
sessionId
SessionId for current logged in user's session
sessionId: string
Property Value
string
sharedBackendUri
The base URL of Shared Backend that stores the tenant metadata.
sharedBackendUri: string
Property Value
string
workloadHostApp
The application that hosts the workload. Example: 0 for Fabric Web app, 1 for Embed app.
workloadHostApp: WorkloadHostApp
Property Value
workloadHostOrigin
The origin of Workload Host.
workloadHostOrigin: string
Property Value
string