Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkspaceManager<U, V>

The workspaces API service manager. A namespace for WorkspaceManager statics.

Type parameters

  • U

  • V

Hierarchy

Implements

Index

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Properties

serverSettings

serverSettings: ISettings

The server settings used to make API requests.

Methods

fetch

  • Fetch a workspace.

    Parameters

    • id: string

      The workspaces's ID.

    Returns Promise<IWorkspace>

    A promise that resolves if successful.

list

  • list(): Promise<object>

  • Fetch the list of workspace IDs that exist on the server.

    Returns Promise<object>

    A promise that resolves if successful.

remove

  • remove(id: string): Promise<void>

  • 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>

  • 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