BoardsRestClient class

套件:

azure-devops-extension-api

應該用來對 VSS REST API 提出要求的基類（衍生自）

Extends

RestClientBase

建構函式

BoardsRestClient(IVssRestClientOptions)

屬性

RESOURCE_AREA_ID

方法

addBoardItem(NewBoardItem, string, number)	將單一專案加入面板。
createBoard(CreateBoard, string)	為專案新增面板。
createBoardColumn(BoardColumnCreate, string, number)	在面板上建立新的數據行。
createBoardRow(BoardRowCreate, string, number)	在面板上建立新的數據列。
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	為面板上的數據行建立新的同步處理。
deleteBoard(string, number)	刪除面板。
deleteBoardColumn(string, number, string, boolean)	從面板刪除資料行。
deleteBoardRow(string, number, string, boolean)	從面板刪除數據列。
getBoard(string, number)	傳回面板的資訊，指定其唯一標識符。
getBoardColumn(string, number, string)	取得面板的數據行數據，指定其標識碼。
getBoardColumns(string, number)	取得面板中的數據行。
getBoardItem(string, number, string)	取得單一面板項目的數據。
getBoardItems(string, number)	取得面板的項目資訊，指定其標識碼。
getBoardRow(string, number, string)	取得指定其識別碼和面板的數據列。
getBoardRows(string, number)	取得面板中的數據列，指定其標識碼。
getBoards(string, number, number)	取得面板。
removeBoardItem(string, number, string)	從面板移除專案。
updateBoard(UpdateBoard, string, number, String)	更新面板。
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	更新面板資料行。
updateBoardItem(UpdateBoardItem, string, number, string, String)	更新面板中的單一專案。
updateBoardItems(BoardItemBatchOperation, string, number)	對一批專案執行作業。
updateBoardRow(BoardRowUpdate, string, number, string, String)	更新面板數據列。

建構函式詳細資料

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

參數

options

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

項目識別碼或項目名稱

board

number

面板標識碼。

傳回

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

為專案新增面板。

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

參數

postedBoard

CreateBoard

面板定義。

project

string

項目識別碼或項目名稱

傳回

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

在面板上建立新的數據行。

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

參數

boardColumn

BoardColumnCreate

數據行數據。

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

傳回

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

在面板上建立新的數據列。

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

參數

boardRow

BoardRowCreate

數據列數據。

project

string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

board

number

column

string

傳回

Promise<BoardItemStateSync>

deleteBoard(string, number)

刪除面板。

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

參數

project

string

項目識別碼或項目名稱

id

number

面板標識碼。

傳回

Promise<void>

deleteBoardColumn(string, number, string, boolean)

從面板刪除資料行。

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

參數

project

string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

board

number

面板標識碼。

id

string

數據列標識碼。

forceRemoveItems

boolean

布爾值，指出是否要強制移除數據列刪除期間的專案。

傳回

Promise<void>

getBoard(string, number)

傳回面板的資訊，指定其唯一標識符。

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

參數

project

string

項目識別碼或項目名稱

id

number

面板的唯一標識碼。

傳回

Promise<BoardResponse>

getBoardColumn(string, number, string)

取得面板的數據行數據，指定其標識碼。

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

參數

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

id

string

數據行標識碼。

傳回

Promise<BoardColumnResponse>

getBoardColumns(string, number)

取得面板中的數據行。

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

參數

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

傳回

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

取得單一面板項目的數據。

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

參數

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

id

string

項目標識碼。

傳回

Promise<BoardItemResponse>

getBoardItems(string, number)

取得面板的項目資訊，指定其標識碼。

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

參數

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

傳回

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

取得指定其識別碼和面板的數據列。

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

參數

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

id

string

面板數據列標識碼。

傳回

Promise<BoardRowResponse>

getBoardRows(string, number)

取得面板中的數據列，指定其標識碼。

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

參數

project

string

項目識別碼或項目名稱

board

number

面板標識碼。

傳回

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

取得面板。

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

參數

project

string

項目識別碼或項目名稱

top

number

要取得的面板數目上限。

skip

number

要略過的面板數目。

傳回

Promise<BoardReference[]>

removeBoardItem(string, number, string)

從面板移除專案。

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

參數

project

string

項目識別碼或項目名稱

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

number

要更新之面板的標識碼。

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

項目識別碼或項目名稱

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

項目識別碼或項目名稱

board

number

面板標識碼。

id

string

更新項目識別碼。

eTag

String

專案最新變更日期

傳回

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

對一批專案執行作業。

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

參數

batchRequest

BoardItemBatchOperation

定義批次作業的數據。

project

string

項目識別碼或項目名稱

board

number

包含專案之面板的識別碼。

傳回

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

項目識別碼或項目名稱

board

number

面板標識碼。

id

string

數據列標識碼。

eTag

String

數據列最新變更日期

傳回

Promise<BoardRowResponse>