BoardsRestClient class

new BoardsRestClient(options: IVssRestClientOptions)

参数

static RESOURCE_AREA_ID: string

属性值

将单个项目添加到看板。

function addBoardItem(item: NewBoardItem, project: string, board: number): Promise<BoardItemResponse>

参数

返回

为项目添加新板。

function createBoard(postedBoard: CreateBoard, project: string): Promise<BoardResponse>

参数

返回

在 Board 上创建新列。

function createBoardColumn(boardColumn: BoardColumnCreate, project: string, board: number): Promise<BoardColumnResponse>

参数

返回

在板上创建新行。

function createBoardRow(boardRow: BoardRowCreate, project: string, board: number): Promise<BoardRowResponse>

参数

返回

为看板上的列创建新的同步。

function createBoardSyncAction(boardSync: BoardItemStateSyncCreate, project: string, board: number, column: string): Promise<BoardItemStateSync>

参数

返回

删除看板。

function deleteBoard(project: string, id: number): Promise<void>

参数

返回

从看板中删除列。

function deleteBoardColumn(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>

参数

返回

从看板中删除行。

function deleteBoardRow(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>

参数

返回

返回给定其唯一标识符的板的信息。

function getBoard(project: string, id: number): Promise<BoardResponse>

参数

返回

获取给定标识符的板的列数据。

function getBoardColumn(project: string, board: number, id: string): Promise<BoardColumnResponse>

参数

返回

获取板中的列。

function getBoardColumns(project: string, board: number): Promise<BoardColumnCollectionResponse>

参数

返回

获取单个 Board 项目的数据。

function getBoardItem(project: string, board: number, id: string): Promise<BoardItemResponse>

参数

返回

获取给定标识符的板的项目信息。

function getBoardItems(project: string, board: number): Promise<BoardItemCollectionResponse>

参数

返回

获取给定其标识符和 board 的行。

function getBoardRow(project: string, board: number, id: string): Promise<BoardRowResponse>

参数

返回

获取看板中给定标识符的行。

function getBoardRows(project: string, board: number): Promise<BoardRowCollectionResponse>

参数

返回

获取板。

function getBoards(project: string, top?: number, skip?: number): Promise<BoardReference[]>

参数

返回

从看板中移除项目。

function removeBoardItem(project: string, board: number, id: string): Promise<void>

参数

返回

更新看板。

function updateBoard(updatedBoard: UpdateBoard, project: string, id: number, eTag: String): Promise<BoardResponse>

参数

返回

更新看板列。

function updateBoardColumn(boardColumn: BoardColumnUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardColumnResponse>

参数

返回

更新看板中的单个项目。

function updateBoardItem(updateItemDef: UpdateBoardItem, project: string, board: number, id: string, eTag: String): Promise<BoardItemResponse>

参数

返回

对一批物料执行作。

function updateBoardItems(batchRequest: BoardItemBatchOperation, project: string, board: number): Promise<BoardItemCollectionResponse>

参数

返回

更新 Board 行。

function updateBoardRow(boardRow: BoardRowUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardRowResponse>

参数

返回