Class: Workspace#
Workspace
beta
Hierarchy#
- Workspace
Implements#
- WorkspaceModel
- WorkspaceState
Index#
Constructors#
Properties#
Accessors#
Methods#
Constructors#
constructor#
+ new Workspace(data: WorkspaceModel): Workspace
Defined in src/common/workspace-store.ts:72
Parameters:
| Name | Type |
|---|---|
data |
WorkspaceModel |
Returns: Workspace
Properties#
[updateFromModel]#
• [updateFromModel]: (Anonymous function) & IAction = action((model: WorkspaceModel) => { Object.assign(this, model); })
Defined in src/common/workspace-store.ts:135
Optional description#
• description? : string
Implementation of WorkspaceModel.description
Defined in src/common/workspace-store.ts:54
Workspace description
observable
id#
• id: WorkspaceId
Implementation of WorkspaceModel.id
Defined in src/common/workspace-store.ts:42
Unique id for workspace
observable
Optional lastActiveClusterId#
• lastActiveClusterId? : ClusterId
Implementation of WorkspaceModel.lastActiveClusterId
Defined in src/common/workspace-store.ts:69
Last active cluster id
observable
name#
• name: string
Implementation of WorkspaceModel.name
Defined in src/common/workspace-store.ts:48
Workspace name
observable
Optional ownerRef#
• ownerRef? : string
Implementation of WorkspaceModel.ownerRef
Defined in src/common/workspace-store.ts:62
Workspace owner reference
If extension sets ownerRef then it needs to explicitly mark workspace as enabled onActivate (or when workspace is saved)
observable
Accessors#
enabled#
• get enabled(): boolean
Defined in src/common/workspace-store.ts:91
Is workspace enabled
Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.
observable
Returns: boolean
• set enabled(enabled: boolean): void
Defined in src/common/workspace-store.ts:95
Is workspace enabled
Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.
Parameters:
| Name | Type |
|---|---|
enabled |
boolean |
Returns: void
isManaged#
• get isManaged(): boolean
Defined in src/common/workspace-store.ts:102
Is workspace managed by an extension
Returns: boolean
Methods#
getState#
▸ getState(): WorkspaceState
Defined in src/common/workspace-store.ts:110
Get workspace state
Returns: WorkspaceState
pushState#
▸ pushState(state: WorkspaceState): void
Defined in src/common/workspace-store.ts:122
Push state
internal
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
state |
WorkspaceState | this.getState() | workspace state |
Returns: void
setState#
▸ setState(state: WorkspaceState): void
Defined in src/common/workspace-store.ts:131
Parameters:
| Name | Type | Description |
|---|---|---|
state |
WorkspaceState | workspace state |
Returns: void
toJSON#
▸ toJSON(): WorkspaceModel
Defined in src/common/workspace-store.ts:139
Returns: WorkspaceModel