IWorkspaceCustomApplicationSettingsService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service that manages the settings that applications store in a workspace.
export interface IWorkspaceCustomApplicationSettingsService
Methods
Method | Description |
|---|---|
(ALPHA) Creates a setting. | |
(ALPHA) Deletes a setting. | |
(ALPHA) Returns one setting. | |
(ALPHA) Returns the settings stored in the workspace. |
Method details
IWorkspaceCustomApplicationSettingsService.createSetting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates a setting.
createSetting(applicationName: string, content: object, id?: string): Promise<ICustomApplicationSetting>;
Parameters
Parameter | Type | Description |
|---|---|---|
applicationName | string | name of the application that owns the setting |
content | object | content of the setting |
id | string | (Optional) identifier of the setting; when not set, the backend generates one |
Returns
Promise<ICustomApplicationSetting>
IWorkspaceCustomApplicationSettingsService.deleteSetting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Deletes a setting.
deleteSetting(id: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | identifier of the setting |
Returns
Promise<void>
IWorkspaceCustomApplicationSettingsService.getSetting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns one setting.
getSetting(id: string): Promise<ICustomApplicationSetting>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | identifier of the setting |
Returns
Promise<ICustomApplicationSetting>
IWorkspaceCustomApplicationSettingsService.getSettings()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns the settings stored in the workspace.
getSettings(applicationName?: string): Promise<ICustomApplicationSetting[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
applicationName | string | (Optional) when set, returns only the settings of this application |
Returns
Promise<ICustomApplicationSetting[]>