BoardsRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

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 panel pro projekt.
createBoardColumn(BoardColumnCreate, string, number)	Vytvoří nový sloupec na tabuli.
createBoardRow(BoardRowCreate, string, number)	Vytvoří nový řádek na tabuli.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Vytvoří novou synchronizaci pro sloupec na panelu.
deleteBoard(string, number)	Odstraní panel.
deleteBoardColumn(string, number, string, boolean)	Odstraní sloupec z panelu.
deleteBoardRow(string, number, string, boolean)	Odstraní řádek z panelu.
getBoard(string, number)	Vrátí informace pro panel s jedinečným identifikátorem.
getBoardColumn(string, number, string)	Získá data sloupce pro panel vzhledem k jeho identifikátoru.
getBoardColumns(string, number)	Získání sloupců na panelu
getBoardItem(string, number, string)	Získá data pro jednu položku panelu.
getBoardItems(string, number)	Získání informací o položkách pro panel vzhledem k jeho identifikátoru
getBoardRow(string, number, string)	Získá řádek s jeho identifikátorem a tabulí.
getBoardRows(string, number)	Získání řádků na panelu 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)	Aktualizace tabuli.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Aktualizace panelu.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Aktualizace jednu položku na tabuli.
updateBoardItems(BoardItemBatchOperation, string, number)	Proveďte operaci s dávkou položek.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Aktualizace řádek tabule.

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 panel.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

Návraty

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Přidejte novou panel pro projekt.

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

Parametry

postedBoard

CreateBoard

Definice panelu.

project

string

ID projektu nebo název projektu

Návraty

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Vytvoří nový sloupec na tabuli.

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

Parametry

boardColumn

BoardColumnCreate

Data sloupců.

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 tabuli.

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

Parametry

boardRow

BoardRowCreate

Data řádku.

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í panel.

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í, jestli mají být položky při odstraňování sloupce vynuceny.

Návraty

Promise<void>

deleteBoardRow(string, number, string, boolean)

Odstraní řádek z panelu.

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 označující, jestli se mají položky při odstraňování řádku vynutit.

Návraty

Promise<void>

getBoard(string, number)

Vrátí informace pro panel s jedinečným identifikátorem.

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

Parametry

project

string

ID projektu nebo název projektu

id

number

Jedinečný identifikátor desky.

Návraty

Promise<BoardResponse>

getBoardColumn(string, number, string)

Získá data sloupce pro panel vzhledem k jeho 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ískání sloupců 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 panelu.

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ískání informací o položkách pro panel vzhledem k jeho 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 jeho identifikátorem a tabulí.

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 panelu.

Návraty

Promise<BoardRowResponse>

getBoardRows(string, number)

Získání řádků na panelu 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 tabulí, které se mají získat.

skip

number

Počet tabulí, 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 panelu, který se má odebrat.

Návraty

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Aktualizace tabuli.

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

Parametry

updatedBoard

UpdateBoard

Nová data na panelu.

project

string

ID projektu nebo název projektu

id

number

ID panelu, který se má aktualizovat.

eTag

String

Datum poslední změny panelu

Návraty

Promise<BoardResponse>

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

Aktualizace panelu.

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

Parametry

boardColumn

BoardColumnUpdate

Data sloupců.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor sloupce.

eTag

String

Datum poslední změny sloupce

Návraty

Promise<BoardColumnResponse>

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

Aktualizace jednu položku na tabuli.

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

Parametry

updateItemDef

UpdateBoardItem

Aktualizovaná data položek.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Aktualizujte ID položky.

eTag

String

Datum poslední změny položky

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 panelu obsahujícího položky.

Návraty

Promise<BoardItemCollectionResponse>

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

Aktualizace řádek tabule.

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

Parametry

boardRow

BoardRowUpdate

Data řádku.

project

string

ID projektu nebo název projektu

board

number

Identifikátor desky.

id

string

Identifikátor řádku.

eTag

String

Datum poslední změny řádku

Návraty

Promise<BoardRowResponse>