Class WorkspacesModel

An implementation of a workspaces model.

Implements

IWorkspacesModel

Index

Constructors

Properties

_isDisposed _manager _poll _refreshed _workspaceData

Accessors

identifiers isDisposed refreshed workspaces

Methods

_fetchList create dispose refresh remove rename reset saveAs

Constructors

constructor

new WorkspacesModel(options): WorkspacesModel
Parameters
- options: WorkspacesModel.IOptions
Returns WorkspacesModel
- Defined in packages/workspaces/src/model.ts:20

Properties

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _manager

_manager: Workspace.IManager

`Private` _poll

_poll: Poll<any, any, "standby">

`Private` _refreshed

_refreshed: Signal<WorkspacesModel, void> = ...

`Private` _workspaceData

_workspaceData: {
ids: string[];
values: IWorkspace[];
} = ...

Type declaration

ids: string[]
values: IWorkspace[]

Accessors

identifiers

get identifiers(): string[]
The list of workspace identifiers.

Returns string[]
Implementation of IWorkspacesModel.identifiers
- Defined in packages/workspaces/src/model.ts:46

isDisposed

get isDisposed(): boolean
Get whether the model is disposed.

Returns boolean
Implementation of IWorkspacesModel.isDisposed
- Defined in packages/workspaces/src/model.ts:119

refreshed

get refreshed(): ISignal<WorkspacesModel, void>
A signal emitted when the workspaces list is refreshed.

Returns ISignal<WorkspacesModel, void>
Implementation of IWorkspacesModel.refreshed
- Defined in packages/workspaces/src/model.ts:64

workspaces

get workspaces(): IWorkspace[]
The list of available workspaces.

Returns IWorkspace[]
Implementation of IWorkspacesModel.workspaces
- Defined in packages/workspaces/src/model.ts:39

Methods

`Private` _fetchList

_fetchList(): Promise<void>
Returns Promise<void>
- Defined in packages/workspaces/src/model.ts:135

create

create(workspaceId): Promise<void>
Create an empty workspace.
Parameters
- workspaceId: string
Returns Promise<void>
Implementation of IWorkspacesModel.create
- Defined in packages/workspaces/src/model.ts:53

dispose

dispose(): void
Dispose of the resources held by the model.

Returns void
Implementation of IWorkspacesModel.dispose
- Defined in packages/workspaces/src/model.ts:126

refresh

refresh(): Promise<void>
Force a refresh of the workspaces list.

Returns Promise<void>
Implementation of IWorkspacesModel.refresh
- Defined in packages/workspaces/src/model.ts:71

remove

remove(workspaceId): Promise<void>
Remove a workspace.
Parameters
- workspaceId: string
Returns Promise<void>
Implementation of IWorkspacesModel.remove
- Defined in packages/workspaces/src/model.ts:101

rename

rename(workspaceId, newName): Promise<void>
Rename a workspace.
Parameters
- workspaceId: string
- newName: string
Returns Promise<void>
Implementation of IWorkspacesModel.rename
- Defined in packages/workspaces/src/model.ts:79

reset

reset(workspaceId): Promise<void>
Reset a workspace.
Parameters
- workspaceId: string
Returns Promise<void>
Implementation of IWorkspacesModel.reset
- Defined in packages/workspaces/src/model.ts:91

saveAs

saveAs(workspaceId, newName): Promise<void>
Save workspace under a different name.
Parameters
- workspaceId: string
- newName: string
Returns Promise<void>
Implementation of IWorkspacesModel.saveAs
- Defined in packages/workspaces/src/model.ts:109