BoardsRestClient class
应使用 (派生自) 的基类向 VSS REST API 发出请求
- Extends
构造函数
Boards |
属性
RESOURCE_AREA_ID |
方法
构造函数详细信息
BoardsRestClient(IVssRestClientOptions)
属性详细信息
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
属性值
string
方法详细信息
addBoardItem(NewBoardItem, string, number)
将单个项添加到开发板。
function addBoardItem(item: NewBoardItem, project: string, board: number): Promise<BoardItemResponse>
参数
- item
- NewBoardItem
要添加到开发板的项。
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
返回
Promise<BoardItemResponse>
createBoard(CreateBoard, string)
为项目添加新板。
function createBoard(postedBoard: CreateBoard, project: string): Promise<BoardResponse>
参数
- postedBoard
- CreateBoard
板定义。
- project
-
string
项目 ID 或项目名称
返回
Promise<BoardResponse>
createBoardColumn(BoardColumnCreate, string, number)
在板上创建新列。
function createBoardColumn(boardColumn: BoardColumnCreate, project: string, board: number): Promise<BoardColumnResponse>
参数
- boardColumn
- BoardColumnCreate
列数据。
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
返回
Promise<BoardColumnResponse>
createBoardRow(BoardRowCreate, string, number)
在板上创建新行。
function createBoardRow(boardRow: BoardRowCreate, project: string, board: number): Promise<BoardRowResponse>
参数
- boardRow
- BoardRowCreate
行数据。
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
返回
Promise<BoardRowResponse>
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)
为板上的列创建新的同步。
function createBoardSyncAction(boardSync: BoardItemStateSyncCreate, project: string, board: number, column: string): Promise<BoardItemStateSync>
参数
- boardSync
- BoardItemStateSyncCreate
- project
-
string
项目 ID 或项目名称
- board
-
number
- column
-
string
返回
Promise<BoardItemStateSync>
deleteBoard(string, number)
删除开发板。
function deleteBoard(project: string, id: number): Promise<void>
参数
- project
-
string
项目 ID 或项目名称
- id
-
number
板标识符。
返回
Promise<void>
deleteBoardColumn(string, number, string, boolean)
从开发板中删除列。
function deleteBoardColumn(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
列标识符。
- forceRemoveItems
-
boolean
指示是否在删除列期间强制删除项的布尔值。
返回
Promise<void>
deleteBoardRow(string, number, string, boolean)
从开发板中删除行。
function deleteBoardRow(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
行标识符。
- forceRemoveItems
-
boolean
指示在删除行期间是否强制删除项的布尔值。
返回
Promise<void>
getBoard(string, number)
返回给定板的唯一标识符的信息。
function getBoard(project: string, id: number): Promise<BoardResponse>
参数
- project
-
string
项目 ID 或项目名称
- id
-
number
板的唯一标识符。
返回
Promise<BoardResponse>
getBoardColumn(string, number, string)
获取给定标识符的板的列数据。
function getBoardColumn(project: string, board: number, id: string): Promise<BoardColumnResponse>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
列标识符。
返回
Promise<BoardColumnResponse>
getBoardColumns(string, number)
获取开发板中的列。
function getBoardColumns(project: string, board: number): Promise<BoardColumnCollectionResponse>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
返回
Promise<BoardColumnCollectionResponse>
getBoardItem(string, number, string)
获取单个板项的数据。
function getBoardItem(project: string, board: number, id: string): Promise<BoardItemResponse>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
项标识符。
返回
Promise<BoardItemResponse>
getBoardItems(string, number)
获取给定标识符的板的项目信息。
function getBoardItems(project: string, board: number): Promise<BoardItemCollectionResponse>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
返回
Promise<BoardItemCollectionResponse>
getBoardRow(string, number, string)
获取给定其标识符和板的行。
function getBoardRow(project: string, board: number, id: string): Promise<BoardRowResponse>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
板行标识符。
返回
Promise<BoardRowResponse>
getBoardRows(string, number)
获取给定标识符的开发板中的行。
function getBoardRows(project: string, board: number): Promise<BoardRowCollectionResponse>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
返回
Promise<BoardRowCollectionResponse>
getBoards(string, number, number)
获取版块。
function getBoards(project: string, top?: number, skip?: number): Promise<BoardReference[]>
参数
- project
-
string
项目 ID 或项目名称
- top
-
number
要获取的最大版块数。
- skip
-
number
要跳过的版块数。
返回
Promise<BoardReference[]>
removeBoardItem(string, number, string)
从开发板中删除项。
function removeBoardItem(project: string, board: number, id: string): Promise<void>
参数
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
要删除的板项标识符。
返回
Promise<void>
updateBoard(UpdateBoard, string, number, String)
汇报板。
function updateBoard(updatedBoard: UpdateBoard, project: string, id: number, eTag: String): Promise<BoardResponse>
参数
- updatedBoard
- UpdateBoard
新板数据。
- project
-
string
项目 ID 或项目名称
- id
-
number
要更新的板的 ID。
- eTag
-
String
板最新更改日期
返回
Promise<BoardResponse>
updateBoardColumn(BoardColumnUpdate, string, number, string, String)
汇报板列。
function updateBoardColumn(boardColumn: BoardColumnUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardColumnResponse>
参数
- boardColumn
- BoardColumnUpdate
列数据。
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
列标识符。
- eTag
-
String
列最新更改日期
返回
Promise<BoardColumnResponse>
updateBoardItem(UpdateBoardItem, string, number, string, String)
汇报开发板中的单个项。
function updateBoardItem(updateItemDef: UpdateBoardItem, project: string, board: number, id: string, eTag: String): Promise<BoardItemResponse>
参数
- updateItemDef
- UpdateBoardItem
更新的项目数据。
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
更新项 ID。
- eTag
-
String
项目最新更改日期
返回
Promise<BoardItemResponse>
updateBoardItems(BoardItemBatchOperation, string, number)
对一批项执行操作。
function updateBoardItems(batchRequest: BoardItemBatchOperation, project: string, board: number): Promise<BoardItemCollectionResponse>
参数
- batchRequest
- BoardItemBatchOperation
定义批处理操作的数据。
- project
-
string
项目 ID 或项目名称
- board
-
number
包含项的板的 ID。
返回
Promise<BoardItemCollectionResponse>
updateBoardRow(BoardRowUpdate, string, number, string, String)
汇报板行。
function updateBoardRow(boardRow: BoardRowUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardRowResponse>
参数
- boardRow
- BoardRowUpdate
行数据。
- project
-
string
项目 ID 或项目名称
- board
-
number
板标识符。
- id
-
string
行标识符。
- eTag
-
String
行最近更改日期
返回
Promise<BoardRowResponse>