SettingsEditor Namespace @beta
Interface
| Name | Description |
|---|---|
| SettingsEditor.QuerySettingsContainersArgs | Arguments for queryContainers and findContainers. |
Function
| Name | Description |
|---|---|
| SettingsEditor.construct | Create a new SettingsEditor for creating new versions of SettingsDbs. |
| SettingsEditor.createEmptyDb | Create a new, empty, SettingsDb file on the local filesystem for importing settings dictionaries. |
| SettingsEditor.queryContainers | Query the BlobContainer service for all settings containers associated with a given iTwin. |
Defined in
SettingsEditor Interface
An object that permits administrators to modify the contents of settings containers. Use construct to obtain a SettingsEditor, and close when finished using it. Only one SettingsEditor may be in use at any given time. Use getContainer to edit an existing container, or createNewCloudContainer to create a new container.
Methods
| Name | Description | |
|---|---|---|
| close(): void | Closes this editor. | |
| createNewCloudContainer(args: CreateNewSettingsContainerArgs): Promise<EditableSettingsCloudContainer> | Creates a new cloud container for holding SettingsDbs, from the BlobContainer service. | |
| findContainers(args: SettingsEditor.QuerySettingsContainersArgs): Promise<EditableSettingsCloudContainer[]> | Find and open existing settings containers by querying the BlobContainer service. | |
| getContainer(args: GetWorkspaceContainerArgs): EditableSettingsCloudContainer | Retrieves a container for the editor with the specified properties and access token. | |
| getContainerAsync(props: WorkspaceContainerProps): Promise<EditableSettingsCloudContainer> | Asynchronously retrieves a container for the editor with the specified properties. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| workspace Readonly | Workspace | The workspace dedicated to this editor. |
Defined in
Last Updated: 19 March, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.