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>