Interface: WorkspaceService
Defined in: domain/contracts.ts:461
Workspace access and folder tree operations.
Methods
createFolder()
ts
createFolder(input): Promise<FolderNode>;Defined in: domain/contracts.ts:467
Creates a folder under parentId, or at the top level when omitted.
Parameters
| Parameter | Type |
|---|---|
input | { name: string; parentId?: string; } |
input.name | string |
input.parentId? | string |
Returns
Promise<FolderNode>
deleteFolder()
ts
deleteFolder(input): Promise<void>;Defined in: domain/contracts.ts:473
Deletes a folder.
Parameters
| Parameter | Type |
|---|---|
input | { folderId: string; } |
input.folderId | string |
Returns
Promise<void>
getWorkspace()
ts
getWorkspace(): Promise<WorkspaceSnapshot>;Defined in: domain/contracts.ts:463
Returns the current workspace snapshot.
Returns
Promise<WorkspaceSnapshot>
moveFolder()
ts
moveFolder(input): Promise<void>;Defined in: domain/contracts.ts:471
Moves a folder under another folder.
Parameters
| Parameter | Type |
|---|---|
input | { folderId: string; targetParentId: string; } |
input.folderId | string |
input.targetParentId | string |
Returns
Promise<void>
renameFolder()
ts
renameFolder(input): Promise<FolderNode>;Defined in: domain/contracts.ts:469
Renames a folder.
Parameters
| Parameter | Type |
|---|---|
input | { folderId: string; name: string; } |
input.folderId | string |
input.name | string |
Returns
Promise<FolderNode>
updateWorkspace()
ts
updateWorkspace(input): Promise<WorkspaceSnapshot>;Defined in: domain/contracts.ts:465
Updates the workspace with the given fields and returns the resulting snapshot.
Parameters
| Parameter | Type |
|---|---|
input | Partial<WorkspaceSnapshot> |
Returns
Promise<WorkspaceSnapshot>