IWorkspacesQueryFactory
Factory providing creating queries used to get available workspaces.
export interface IWorkspacesQueryFactory
Methods
Method | Description |
|---|---|
(ALPHA) Creates a new workspace. | |
Creates a query for workspaces available to the user currently logged in. | |
Creates a query for workspaces available to the specified user. |
Method details
IWorkspacesQueryFactory.createWorkspace()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates a new workspace.
createWorkspace(definition: IWorkspaceDefinition): Promise<IWorkspaceDescriptor>;
Parameters
Parameter | Type | Description |
|---|---|---|
definition | definition of the workspace |
Returns
Promise<IWorkspaceDescriptor>
descriptor of the created workspace
IWorkspacesQueryFactory.forCurrentUser()method
Creates a query for workspaces available to the user currently logged in.
forCurrentUser(): IWorkspacesQuery;
Returns
IWorkspacesQueryFactory.forUser()method
Creates a query for workspaces available to the specified user.
forUser(userId: string): IWorkspacesQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
userId | string | id of the user to retrieve workspaces for |
Returns