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

프로젝트 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>