IUserSettingsService
This query service provides access to feature flags that are in effect for particular user.
export interface IUserSettingsService
Methods
Method | Description |
|---|---|
Delete the active color palette of the current user, returning to the workspace or organization color palette. | |
Delete the active theme of the current user, returning to the workspace or organization theme. | |
Asynchronously queries actual feature flags. | |
Set the active color palette for the current user. It takes precedence over the active color palette of the workspace and of the organization. | |
Set format locale for the current user | |
Set locale for the current user | |
Set metadata locale for the current user | |
Set separators for the current user | |
Set the active theme for the current user. It takes precedence over the active theme of the workspace and of the organization. |
Method details
IUserSettingsService.deleteColorPalette()method
Delete the active color palette of the current user, returning to the workspace or organization color palette.
deleteColorPalette(): Promise<void>;
Returns
Promise<void>
promise
IUserSettingsService.deleteTheme()method
Delete the active theme of the current user, returning to the workspace or organization theme.
deleteTheme(): Promise<void>;
Returns
Promise<void>
promise
IUserSettingsService.getSettings()method
Asynchronously queries actual feature flags.
getSettings(): Promise<IUserSettings>;
Returns
Promise<IUserSettings>
promise of the feature flags of the current user
IUserSettingsService.setColorPalette()method
Set the active color palette for the current user. It takes precedence over the active color palette of the workspace and of the organization.
setColorPalette(colorPalette: string | ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
colorPalette | string | ObjRef | organization color palette id, or a reference to an organization color palette (untyped or typed “colorPalette”). A user setting has no workspace, so a reference typed “workspaceColorPalette” is rejected. |
Returns
Promise<void>
promise
IUserSettingsService.setFormatLocale()method
Set format locale for the current user
setFormatLocale(locale: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
locale | string | IETF BCP 47 Code locale ID, for example “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IUserSettingsService.setLocale()method
Set locale for the current user
setLocale(locale: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
locale | string | IETF BCP 47 Code locale ID, for example “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IUserSettingsService.setMetadataLocale()method
Set metadata locale for the current user
setMetadataLocale(locale: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
locale | string | IETF BCP 47 Code locale ID, for example “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IUserSettingsService.setSeparators()method
Set separators for the current user
setSeparators(separators: ISeparators): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
separators | separators for the current user |
Returns
Promise<void>
promise
IUserSettingsService.setTheme()method
Set the active theme for the current user. It takes precedence over the active theme of the workspace and of the organization.
setTheme(theme: string | ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
theme | string | ObjRef | organization theme id, or a reference to an organization theme (untyped or typed “theme”). A user setting has no workspace, so a reference typed “workspaceTheme” is rejected. |
Returns
Promise<void>
promise