BoardsRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om verzoeken in te dienen bij VSS REST-api's

Uitbreiding

RestClientBase

Constructors

BoardsRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

addBoardItem(NewBoardItem, string, number)	Voegt een enkel item toe aan een bord.
createBoard(CreateBoard, string)	Voeg een nieuw bord toe voor het project.
createBoardColumn(BoardColumnCreate, string, number)	Hiermee maakt u een nieuwe kolom op een bord.
createBoardRow(BoardRowCreate, string, number)	Hiermee maakt u een nieuwe rij op een bord.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Hiermee maakt u een nieuwe synchronisatie voor een kolom op een bord.
deleteBoard(string, number)	Verwijdert een bord.
deleteBoardColumn(string, number, string, boolean)	Hiermee verwijdert u een kolom van een bord.
deleteBoardRow(string, number, string, boolean)	Verwijdert een rij van een bord.
getBoard(string, number)	Retourneert informatie voor een bord op basis van de unieke identificatiecode.
getBoardColumn(string, number, string)	Haalt kolomgegevens op voor een bord op basis van de identificatie.
getBoardColumns(string, number)	Kolommen ophalen in een bord.
getBoardItem(string, number, string)	Haalt gegevens op voor het item van een enkel bord.
getBoardItems(string, number)	Haal iteminformatie op voor een bord op basis van de identificatie.
getBoardRow(string, number, string)	Haalt een rij op met de ID en het bord.
getBoardRows(string, number)	Haal rijen op in een bord op basis van de identificatie.
getBoards(string, number, number)	Koop planken.
removeBoardItem(string, number, string)	Verwijdert een item van een bord.
updateBoard(UpdateBoard, string, number, String)	Werkt een bord bij.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Werkt een bordkolom bij.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Werkt een enkel item in een bord bij.
updateBoardItems(BoardItemBatchOperation, string, number)	Voer een bewerking uit op een batch artikelen.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Werkt een bordrij bij.

Constructordetails

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addBoardItem(NewBoardItem, string, number)

Voegt een enkel item toe aan een bord.

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

Parameters

item

NewBoardItem

Item om toe te voegen aan het bord.

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

Retouren

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Voeg een nieuw bord toe voor het project.

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

Parameters

postedBoard

CreateBoard

Definitie van bord.

project

string

Project-id of projectnaam

Retouren

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Hiermee maakt u een nieuwe kolom op een bord.

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

Parameters

boardColumn

BoardColumnCreate

Kolom gegevens.

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

Retouren

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Hiermee maakt u een nieuwe rij op een bord.

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

Parameters

boardRow

BoardRowCreate

Rij gegevens.

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

Retouren

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Hiermee maakt u een nieuwe synchronisatie voor een kolom op een bord.

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

Parameters

boardSync

BoardItemStateSyncCreate

project

string

Project-id of projectnaam

board

number

column

string

Retouren

Promise<BoardItemStateSync>

deleteBoard(string, number)

Verwijdert een bord.

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

Parameters

project

string

Project-id of projectnaam

id

number

Bord-identificatie.

Retouren

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Hiermee verwijdert u een kolom van een bord.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Kolom-ID.

forceRemoveItems

boolean

Booleaanse weergave die aangeeft of items geforceerd moeten worden verwijderd tijdens het verwijderen van de kolom.

Retouren

Promise<void>

deleteBoardRow(string, number, string, boolean)

Verwijdert een rij van een bord.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Rij-ID.

forceRemoveItems

boolean

Booleaanse weergave die aangeeft of items geforceerd moeten worden verwijderd tijdens het verwijderen van de rij.

Retouren

Promise<void>

getBoard(string, number)

Retourneert informatie voor een bord op basis van de unieke identificatiecode.

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

Parameters

project

string

Project-id of projectnaam

id

number

Unieke identificatiecode van het bestuur.

Retouren

Promise<BoardResponse>

getBoardColumn(string, number, string)

Haalt kolomgegevens op voor een bord op basis van de identificatie.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Kolom-ID.

Retouren

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Kolommen ophalen in een bord.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

Retouren

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Haalt gegevens op voor het item van een enkel bord.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Artikel-ID.

Retouren

Promise<BoardItemResponse>

getBoardItems(string, number)

Haal iteminformatie op voor een bord op basis van de identificatie.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

Retouren

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Haalt een rij op met de ID en het bord.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Identificatie van bordrijen.

Retouren

Promise<BoardRowResponse>

getBoardRows(string, number)

Haal rijen op in een bord op basis van de identificatie.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

Retouren

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Koop planken.

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

Parameters

project

string

Project-id of projectnaam

top

number

Het maximale aantal boards om te krijgen.

skip

number

Het aantal borden dat je moet overslaan.

Retouren

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Verwijdert een item van een bord.

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

Parameters

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Borditem-ID om te verwijderen.

Retouren

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Werkt een bord bij.

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

Parameters

updatedBoard

UpdateBoard

Nieuwe bordgegevens.

project

string

Project-id of projectnaam

id

number

Id van het forum om bij te werken.

eTag

String

Datum laatste wijziging van het bord

Retouren

Promise<BoardResponse>

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

Werkt een bordkolom bij.

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

Parameters

boardColumn

BoardColumnUpdate

Kolom gegevens.

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Kolom-ID.

eTag

String

Kolom Datum laatste wijziging

Retouren

Promise<BoardColumnResponse>

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

Werkt een enkel item in een bord bij.

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

Parameters

updateItemDef

UpdateBoardItem

Bijgewerkte artikelgegevens.

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Artikel-ID bijwerken.

eTag

String

Datum laatste wijziging van artikel

Retouren

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Voer een bewerking uit op een batch artikelen.

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

Parameters

batchRequest

BoardItemBatchOperation

Gegevens die de batchbewerking definiëren.

project

string

Project-id of projectnaam

board

number

De id van het bord met de items.

Retouren

Promise<BoardItemCollectionResponse>

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

Werkt een bordrij bij.

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

Parameters

boardRow

BoardRowUpdate

Rij gegevens.

project

string

Project-id of projectnaam

board

number

Bord-identificatie.

id

string

Rij-ID.

eTag

String

Rij laatst gewijzigde datum

Retouren

Promise<BoardRowResponse>