Namespaces
board
Methods and types of the `board` namespace (`client.board` / `bot.board`).
Interfaces
AddColumnData
Properties
AddExistingTaskData
Properties
CreateBoardData
Properties
CreateBoardTaskData
Properties
LinkTaskData
Properties
MoveTaskData
Properties
ReorderColumnsData
Properties
UpdateBoardData
Properties
UpdateColumnData
Properties
UpdateTaskDetailsData
Properties
Functions
default()
function default(client): {
addColumn: Promise<BoardColumn>;
addExistingTaskToBoard: Promise<Task>;
createBoard: Promise<Board>;
createBoardTask: Promise<Task>;
deleteBoard: Promise<{
deletedTaskIds: string[];
disposition: string;
message: string;
reassignedTaskIds: string[];
}>;
deleteColumn: Promise<void>;
followBoard: Promise<Board>;
getBoard: Promise<BoardWithTasks>;
getBoardTasks: Promise<Task[]>;
getProjectBoards: Promise<Board[]>;
getProjectTasks: Promise<any>;
moveTask: Promise<Task>;
removeTaskFromBoard: Promise<Task>;
reorderColumns: Promise<BoardColumn[]>;
tagBoard: Promise<Board>;
unfollowBoard: Promise<Board>;
untagBoard: Promise<Board>;
updateBoard: Promise<Board>;
updateColumn: Promise<BoardColumn>;
};Parameters
| Parameter | Type |
|---|---|
client | default |
Returns
| Name | Type | Description |
|---|---|---|
addColumn() | (boardId, data) => Promise<BoardColumn> | Add a column to a board. Appended at the end unless sortOrder is provided. |
addExistingTaskToBoard() | (boardId, data) => Promise<Task> | Attach an existing project task to a board (no new task is created). |
createBoard() | (data) => Promise<Board> | Create a new board inside a project. If columns are omitted the server seeds the standard four-column layout. |
createBoardTask() | (boardId, data) => Promise<Task> | Create a task directly on a board. When announce is supplied the server also posts a Nu reply in the named chat threaded under the given message, with this task linked via TaskRelation. |
deleteBoard() | (boardId, body?) => Promise<{ deletedTaskIds: string[]; disposition: string; message: string; reassignedTaskIds: string[]; }> | Delete a board. disposition controls what happens to its tasks: unassign (default — tasks survive boardless), delete, or reassign to another board/column. |
deleteColumn() | ( boardId, columnId, targetColumnId? ) => Promise<void> | Delete a column. If the column holds tasks, pass targetColumnId to move them; otherwise the call fails. |
followBoard() | (boardId) => Promise<Board> | Follow a board to receive notifications about its tasks. |
getBoard() | (boardId) => Promise<BoardWithTasks> | Fetch a board with its columns and tasks populated. |
getBoardTasks() | (boardId, params?) => Promise<Task[]> | List tasks on a board, optionally narrowed by column / assignee / tag / status / search. |
getProjectBoards() | (projectId, params?) => Promise<Board[]> | List boards in a project. Filters by visibility, free-text search, and tag ids. |
getProjectTasks() | (projectId, params?) => Promise<any> | List every task in a project across all boards. Use boardId: 'unassigned' to fetch only tasks not yet placed on a board. |
moveTask() | ( boardId, taskId, data ) => Promise<Task> | Move a task to a different column on the same board. |
removeTaskFromBoard() | (boardId, taskId) => Promise<Task> | Detach a task from a board. The task itself is preserved as boardless. |
reorderColumns() | (boardId, data) => Promise<BoardColumn[]> | Reorder a board's columns. The request must include every column id. |
tagBoard() | (boardId, tagId) => Promise<Board> | Attach a tag to a board. |
unfollowBoard() | (boardId) => Promise<Board> | Stop following a board. |
untagBoard() | (boardId, tagId) => Promise<Board> | Detach a tag from a board. |
updateBoard() | (boardId, data) => Promise<Board> | Update a board's metadata. Set cascade: true to opt into automatic cleanup of dependent tasks when narrowing visibility; otherwise the server returns 409 with a blockers payload. |
updateColumn() | ( boardId, columnId, data ) => Promise<BoardColumn> | Update column metadata (name, color, task-status mapping, etc.). |