Class WorkspaceManager

The workspaces API service manager.

Hierarchy

DataConnector<IWorkspace>
- WorkspaceManager
  - IManager

Index

Constructors

constructor

Properties

serverSettings

Methods

Constructors

constructor

new WorkspaceManager(options?: IOptions): WorkspaceManager

Inherited from DataConnector.constructor
- Defined in packages/services/lib/workspace/index.d.ts:7
Create a new workspace manager.

Parameters
- Optional options: IOptions
Returns WorkspaceManager

Properties

Readonly serverSettings

serverSettings: ISettings

The server settings used to make API requests.

Methods

fetch

fetch(id: string): Promise<IWorkspace>

Overrides DataConnector.fetch
- Defined in packages/services/lib/workspace/index.d.ts:23
Fetch a workspace.

Parameters
- id: string
  
  The workspace's ID.
Returns Promise<IWorkspace>

A promise that resolves if successful.

list

list(): Promise<{ ids: string[]; values: IWorkspace[] }>

Overrides DataConnector.list
- Defined in packages/services/lib/workspace/index.d.ts:29
Fetch the list of workspace IDs that exist on the server.

Returns Promise<{ ids: string[]; values: IWorkspace[] }>

A promise that resolves if successful.

remove

remove(id: string): Promise<void>

Overrides DataConnector.remove
- Defined in packages/services/lib/workspace/index.d.ts:40
Remove a workspace from the server.

Parameters
- id: string
  
  The workspaces's ID.
Returns Promise<void>

A promise that resolves if successful.

save

save(id: string, workspace: IWorkspace): Promise<void>

Overrides DataConnector.save
- Defined in packages/services/lib/workspace/index.d.ts:50
Save a workspace.

Parameters
- id: string
  
  The workspace's ID.
- workspace: IWorkspace
  
  The workspace being saved.
Returns Promise<void>

A promise that resolves if successful.

Generated using TypeDoc