The interface for the workspace API manager.

Hierarchy

Properties

Methods

Properties

serverSettings: ServerConnection.ISettings

The server settings used to make API requests.

Methods

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

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

    A promise that resolves if successful.

  • Remove a workspace from the server.

    Parameters

    • id: string

      The workspaces's ID.

    Returns Promise<void>

    A promise that resolves if successful.

  • 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