Interface IWorkspacesModel

The model for listing available workspaces.

interface IWorkspacesModel {
    identifiers: string[];
    isDisposed: boolean;
    refreshed: ISignal<IWorkspacesModel, void>;
    workspaces: IWorkspace[];
    create(workspaceId): Promise<void>;
    dispose(): void;
    refresh(): Promise<void>;
    remove(workspaceId): Promise<void>;
    rename(workspaceId, newName): Promise<void>;
    reset(workspaceId): Promise<void>;
    saveAs(workspaceId, newName): Promise<void>;
}

Hierarchy

Implemented by

Properties

identifiers isDisposed refreshed workspaces

Methods

create dispose refresh remove rename reset saveAs

Properties

Readonly identifiers

identifiers: string[]

The list of workspace identifiers.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

refreshed

refreshed: ISignal<IWorkspacesModel, void>

Signal emitted when the listing is refreshed.

Readonly workspaces

workspaces: IWorkspace[]

The list of available workspaces.

Methods

create

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

refresh

remove

rename

reset

saveAs

Settings

Member Visibility

Theme

On This Page

identifiersisDisposedrefreshedworkspacescreatedisposerefreshremoverenameresetsaveAs