BoardsRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldéséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

BoardsRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

addBoardItem(NewBoardItem, string, number)	Egyetlen elemet ad hozzá egy táblához.
createBoard(CreateBoard, string)	Adjon hozzá egy új táblát a projekthez.
createBoardColumn(BoardColumnCreate, string, number)	Új oszlopot hoz létre egy táblán.
createBoardRow(BoardRowCreate, string, number)	Új sort hoz létre egy táblán.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Új szinkronizálást hoz létre egy tábla egyik oszlopához.
deleteBoard(string, number)	Törli a táblát.
deleteBoardColumn(string, number, string, boolean)	Oszlop törlése egy táblából.
deleteBoardRow(string, number, string, boolean)	Töröl egy sort egy táblából.
getBoard(string, number)	Egy tábla adatait adja vissza az egyedi azonosítójának megadva.
getBoardColumn(string, number, string)	Lekéri egy tábla oszlopadatait az azonosítójának megadva.
getBoardColumns(string, number)	Oszlopok lekérése egy táblában.
getBoardItem(string, number, string)	Egyetlen tábla elemének adatait kapja meg.
getBoardItems(string, number)	Egy tábla elemadatainak lekérése az azonosítójuk alapján.
getBoardRow(string, number, string)	Lekér egy sort az azonosító és a tábla alapján.
getBoardRows(string, number)	Sorok lekérése egy táblában az azonosítójuk alapján.
getBoards(string, number, number)	Szerezd meg a táblákat.
removeBoardItem(string, number, string)	Eltávolít egy elemet egy táblából.
updateBoard(UpdateBoard, string, number, String)	Frissítések egy táblát.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Frissítések egy táblaoszlopot.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Frissítések egyetlen elem egy táblában.
updateBoardItems(BoardItemBatchOperation, string, number)	Műveletet hajt végre egy elemkötegen.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Frissítések egy táblasort.

Konstruktor adatai

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

addBoardItem(NewBoardItem, string, number)

Egyetlen elemet ad hozzá egy táblához.

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

Paraméterek

item

NewBoardItem

A táblához hozzáadni kívánt elem.

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

Válaszok

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Adjon hozzá egy új táblát a projekthez.

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

Paraméterek

postedBoard

CreateBoard

Tábladefiníció.

project

string

Projektazonosító vagy projektnév

Válaszok

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Új oszlopot hoz létre egy táblán.

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

Paraméterek

boardColumn

BoardColumnCreate

Oszlopadatok.

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

Válaszok

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Új sort hoz létre egy táblán.

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

Paraméterek

boardRow

BoardRowCreate

Soradatok.

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

Válaszok

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Új szinkronizálást hoz létre egy tábla egyik oszlopához.

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

Paraméterek

boardSync

BoardItemStateSyncCreate

project

string

Projektazonosító vagy projektnév

board

number

column

string

Válaszok

Promise<BoardItemStateSync>

deleteBoard(string, number)

Törli a táblát.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

id

number

Táblaazonosító.

Válaszok

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Oszlop törlése egy táblából.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Oszlopazonosító.

forceRemoveItems

boolean

Logikai érték, amely azt jelzi, hogy az elemeket kényszerítetten el kell-e távolítani az oszlop törlése során.

Válaszok

Promise<void>

deleteBoardRow(string, number, string, boolean)

Töröl egy sort egy táblából.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Sorazonosító.

forceRemoveItems

boolean

Logikai érték, amely azt jelzi, hogy az elemeket kényszerítetten el kell-e távolítani a sor törlése során.

Válaszok

Promise<void>

getBoard(string, number)

Egy tábla adatait adja vissza az egyedi azonosítójának megadva.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

id

number

A tábla egyedi azonosítója.

Válaszok

Promise<BoardResponse>

getBoardColumn(string, number, string)

Lekéri egy tábla oszlopadatait az azonosítójának megadva.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Oszlopazonosító.

Válaszok

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Oszlopok lekérése egy táblában.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

Válaszok

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Egyetlen tábla elemének adatait kapja meg.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Elemazonosító.

Válaszok

Promise<BoardItemResponse>

getBoardItems(string, number)

Egy tábla elemadatainak lekérése az azonosítójuk alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

Válaszok

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Lekér egy sort az azonosító és a tábla alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Táblasor azonosítója.

Válaszok

Promise<BoardRowResponse>

getBoardRows(string, number)

Sorok lekérése egy táblában az azonosítójuk alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

Válaszok

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Szerezd meg a táblákat.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

top

number

A lekérhető táblák maximális száma.

skip

number

A kihagyandó táblák száma.

Válaszok

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Eltávolít egy elemet egy táblából.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Eltávolítandó táblaelem-azonosító.

Válaszok

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Frissítések egy táblát.

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

Paraméterek

updatedBoard

UpdateBoard

Új táblaadatok.

project

string

Projektazonosító vagy projektnév

id

number

A frissítendő tábla azonosítója.

eTag

String

Board Latest Changed Date

Válaszok

Promise<BoardResponse>

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

Frissítések egy táblaoszlopot.

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

Paraméterek

boardColumn

BoardColumnUpdate

Oszlopadatok.

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Oszlopazonosító.

eTag

String

Oszlop legutóbbi módosított dátuma

Válaszok

Promise<BoardColumnResponse>

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

Frissítések egyetlen elem egy táblában.

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

Paraméterek

updateItemDef

UpdateBoardItem

Elemadatok frissítve.

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Elemazonosító frissítése.

eTag

String

Elem legutóbbi módosítási dátuma

Válaszok

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Műveletet hajt végre egy elemkötegen.

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

Paraméterek

batchRequest

BoardItemBatchOperation

A kötegműveletet meghatározó adatok.

project

string

Projektazonosító vagy projektnév

board

number

Az elemeket tartalmazó tábla azonosítója.

Válaszok

Promise<BoardItemCollectionResponse>

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

Frissítések egy táblasort.

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

Paraméterek

boardRow

BoardRowUpdate

Soradatok.

project

string

Projektazonosító vagy projektnév

board

number

Táblaazonosító.

id

string

Sorazonosító.

eTag

String

A sor legutóbbi módosítási dátuma

Válaszok

Promise<BoardRowResponse>