API Reference › core-backend › Workspace › Workspace

Workspace Namespace

Defined in

Workspace Interface

Settings and resources that customize an application for the current session. See Workspaces

Methods

Name Description
close(): void Close this Workspace.  
findContainer(containerId: string): undefined | WorkspaceContainer search for a previously opened container.  
getCloudCache(): CloudSqlite.CloudCache Get The CloudCache for cloud-based WorkspaceContainers  
getContainer(props: WorkspaceContainer.Props): WorkspaceContainer get a WorkspaceContainer by WorkspaceContainer.Props  
getWorkspaceDb(dbAlias: string): Promise<WorkspaceDb> Get an opened WorkspaceDb from a WorkspaceDb alias.  
getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb Get an opened WorkspaceDb.  
loadSettingsDictionary(settingRsc: string, db: WorkspaceDb, priority: SettingsPriority): void Load a WorkspaceResource of type string, parse it, and add it to the current Settings for this Workspace.  
resolveContainer(containerName: string): WorkspaceContainer.Props get the properties for the supplied container name by searching for an entry with that name in a cloud/containers setting.  
resolveDatabase(databaseAlias: string): WorkspaceDb.Props & WorkspaceContainer.Alias get the properties for the supplied workspace database name by searching for an entry with that name in a workspace/databases setting.  

Properties

Name Type Description
containerDir Readonly string The directory for local WorkspaceDb files with the name ${containerId}/${dbId}.itwin-workspace.  
settings Readonly Settings The Settings for this Workspace  

Defined in

Last Updated: 16 April, 2024