WorkspaceBuilderinterface
An object describing a builder user to create workspaces
5 Methods
addColumn()⚓︎
(definition?: BoxDefinition) => BoxBuilder
Adds a new column to the calling workspace. Returns the new column.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | x | x |
addGroup()⚓︎
(definition?: BoxDefinition) => BoxBuilder
Adds a new group to the calling workspace. Returns the new group.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | x | x |
addRow()⚓︎
(definition?: BoxDefinition) => BoxBuilder
Adds a new row to the calling workspace. Returns the new row.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | x | x |
addWindow()⚓︎
(definition: WorkspaceWindowDefinition) => WorkspaceBuilder
Adds a new window to the calling workspace. Returns the calling workspace.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | WorkspaceWindowDefinition | x |
create()⚓︎
(config?: WorkspaceCreateConfig) => Promise<Workspace>
Creates a new workspace using the builder as a blueprint for structure and contents.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| config⚓︎ | WorkspaceCreateConfig | x | An object containing workspace creating options. |