BoardsRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by měla být použita (odvozena z) k provádění požadavků na rozhraní API VSS REST

Extends

RestClientBase

Konstruktory

BoardsRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addBoardItem(NewBoardItem, string, number)	Přidá na panel jednu položku.
createBoard(CreateBoard, string)	Přidejte novou nástěnku pro projekt.
createBoardColumn(BoardColumnCreate, string, number)	Vytvoří nový sloupec na panelu.
createBoardRow(BoardRowCreate, string, number)	Vytvoří nový řádek na panelu.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Vytvoří novou synchronizaci pro sloupec na panelu.
deleteBoard(string, number)	Odstraní nástěnku.
deleteBoardColumn(string, number, string, boolean)	Odstraní sloupec z panelu.
deleteBoardRow(string, number, string, boolean)	Odstraní řádek z nástěnky.
getBoard(string, number)	Vrátí informace o panelu na základě jeho jedinečného identifikátoru.
getBoardColumn(string, number, string)	Získá data sloupce pro desku na základě jejího identifikátoru.
getBoardColumns(string, number)	Získejte sloupce na panelu.
getBoardItem(string, number, string)	Získá data pro jednu položku desky.
getBoardItems(string, number)	Získejte informace o položkách pro nástěnku vzhledem k jejímu identifikátoru.
getBoardRow(string, number, string)	Získá řádek s daným identifikátorem a panelem.
getBoardRows(string, number)	Získejte řádky na nástěnce vzhledem k jeho identifikátoru.
getBoards(string, number, number)	Získejte desky.
removeBoardItem(string, number, string)	Odebere položku z panelu.
updateBoard(UpdateBoard, string, number, String)	Aktualizuje nástěnku.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Aktualizuje sloupec panelu.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Aktualizuje jednu položku na panelu.
updateBoardItems(BoardItemBatchOperation, string, number)	Proveďte operaci s dávkou položek.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Aktualizuje řádek panelu.

Podrobnosti konstruktoru

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addBoardItem(NewBoardItem, string, number)

Přidá na panel jednu položku.

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

Parametry

item

NewBoardItem

Položka, kterou chcete přidat na desku.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Přidejte novou nástěnku pro projekt.

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

Parametry

postedBoard

CreateBoard

Definice desky.

project

string

ID projektu nebo název projektu

Návraty

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Vytvoří nový sloupec na panelu.

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

Parametry

boardColumn

BoardColumnCreate

Data sloupce.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Vytvoří nový řádek na panelu.

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

Parametry

boardRow

BoardRowCreate

Řádková data.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Vytvoří novou synchronizaci pro sloupec na panelu.

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

Parametry

boardSync

BoardItemStateSyncCreate

project

string

ID projektu nebo název projektu

board

number

column

string

Návraty

Promise<BoardItemStateSync>

deleteBoard(string, number)

Odstraní nástěnku.

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

Parametry

project

string

ID projektu nebo název projektu

id

number

Identifikátor desky.

Návraty

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Odstraní sloupec z panelu.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor sloupce.

forceRemoveItems

boolean

Logická hodnota označující, zda mají být položky během odstranění sloupce vynuceně odstraněny.

Návraty

Promise<void>

deleteBoardRow(string, number, string, boolean)

Odstraní řádek z nástěnky.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor řádku.

forceRemoveItems

boolean

Logická hodnota, která označuje, zda mají být položky během odstraňování řádků vynuceně odstraněny.

Návraty

Promise<void>

getBoard(string, number)

Vrátí informace o panelu na základě jeho jedinečného identifikátoru.

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

Parametry

project

string

ID projektu nebo název projektu

id

number

Jedinečný identifikátor představenstva.

Návraty

Promise<BoardResponse>

getBoardColumn(string, number, string)

Získá data sloupce pro desku na základě jejího identifikátoru.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor sloupce.

Návraty

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Získejte sloupce na panelu.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Získá data pro jednu položku desky.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor položky.

Návraty

Promise<BoardItemResponse>

getBoardItems(string, number)

Získejte informace o položkách pro nástěnku vzhledem k jejímu identifikátoru.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Získá řádek s daným identifikátorem a panelem.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor řádku desky.

Návraty

Promise<BoardRowResponse>

getBoardRows(string, number)

Získejte řádky na nástěnce vzhledem k jeho identifikátoru.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Získejte desky.

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

Parametry

project

string

ID projektu nebo název projektu

top

number

Maximální počet desek k získání.

skip

number

Počet desek, které se mají přeskočit.

Návraty

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Odebere položku z panelu.

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

Parametry

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor položky desky k odstranění.

Návraty

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Aktualizuje nástěnku.

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

Parametry

updatedBoard

UpdateBoard

Nová data desky.

project

string

ID projektu nebo název projektu

id

number

ID desky, kterou chcete aktualizovat.

eTag

String

Datum poslední změny na desce

Návraty

Promise<BoardResponse>

updateBoardColumn(BoardColumnUpdate, string, number, string, String)

Aktualizuje sloupec panelu.

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

Parametry

boardColumn

BoardColumnUpdate

Data sloupce.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor sloupce.

eTag

String

Sloupec Datum poslední změny

Návraty

Promise<BoardColumnResponse>

updateBoardItem(UpdateBoardItem, string, number, string, String)

Aktualizuje jednu položku na panelu.

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

Parametry

updateItemDef

UpdateBoardItem

Aktualizovaná data položky.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Aktualizujte ID položky.

eTag

String

Položka Poslední Datum změny

Návraty

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Proveďte operaci s dávkou položek.

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

Parametry

batchRequest

BoardItemBatchOperation

Data definující dávkovou operaci.

project

string

ID projektu nebo název projektu

board

number

ID desky obsahující položky.

Návraty

Promise<BoardItemCollectionResponse>

updateBoardRow(BoardRowUpdate, string, number, string, String)

Aktualizuje řádek panelu.

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

Parametry

boardRow

BoardRowUpdate

Řádková data.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor řádku.

eTag

String

Řádek Datum poslední změny

Návraty

Promise<BoardRowResponse>