BoardsRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends

RestClientBase

Konstruktoren

BoardsRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addBoardItem(NewBoardItem, string, number)	Fügt einem Board ein einzelnes Element hinzu.
createBoard(CreateBoard, string)	Fügen Sie ein neues Board für das Projekt hinzu.
createBoardColumn(BoardColumnCreate, string, number)	Erstellt eine neue Spalte auf einem Board.
createBoardRow(BoardRowCreate, string, number)	Erstellt eine neue Zeile auf einem Board.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Erstellt eine neue Synchronisierung für eine Spalte auf einem Board.
deleteBoard(string, number)	Löscht ein Board.
deleteBoardColumn(string, number, string, boolean)	Löscht eine Spalte aus einem Board.
deleteBoardRow(string, number, string, boolean)	Löscht eine Zeile aus einem Board.
getBoard(string, number)	Gibt Informationen für eine Platine aufgrund des eindeutigen Bezeichners zurück.
getBoardColumn(string, number, string)	Ruft Spaltendaten für ein Board unter Berücksichtigung des Bezeichners ab.
getBoardColumns(string, number)	Ruft Spalten in einem Board ab.
getBoardItem(string, number, string)	Ruft Daten für das Element eines einzelnen Boards ab.
getBoardItems(string, number)	Abrufen von Elementinformationen für ein Board unter Berücksichtigung des Bezeichners.
getBoardRow(string, number, string)	Ruft eine Zeile unter Berücksichtigung ihres Bezeichners und ihrer Platine ab.
getBoardRows(string, number)	Abrufen von Zeilen in einem Board unter Berücksichtigung des Bezeichners.
getBoards(string, number, number)	Holen Sie sich Boards.
removeBoardItem(string, number, string)	Entfernt ein Element aus einem Board.
updateBoard(UpdateBoard, string, number, String)	Updates ein Board.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Updates einer Tafelspalte.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Updates ein einzelnes Element in einem Board.
updateBoardItems(BoardItemBatchOperation, string, number)	Führen Sie einen Vorgang für einen Batch von Elementen aus.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Updates einer Boardzeile.

Details zum Konstruktor

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addBoardItem(NewBoardItem, string, number)

Fügt einem Board ein einzelnes Element hinzu.

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

Parameter

item

NewBoardItem

Element, das dem Board hinzugefügt werden soll.

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

Gibt zurück

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Fügen Sie ein neues Board für das Projekt hinzu.

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

Parameter

postedBoard

CreateBoard

Boarddefinition.

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Erstellt eine neue Spalte auf einem Board.

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

Parameter

boardColumn

BoardColumnCreate

Spaltendaten.

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

Gibt zurück

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Erstellt eine neue Zeile auf einem Board.

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

Parameter

boardRow

BoardRowCreate

Zeilendaten.

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

Gibt zurück

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Erstellt eine neue Synchronisierung für eine Spalte auf einem Board.

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

Parameter

boardSync

BoardItemStateSyncCreate

project

string

Projekt-ID oder Projektname

board

number

column

string

Gibt zurück

Promise<BoardItemStateSync>

deleteBoard(string, number)

Löscht ein Board.

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

Parameter

project

string

Projekt-ID oder Projektname

id

number

Boardbezeichner.

Gibt zurück

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Löscht eine Spalte aus einem Board.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

id

string

Spaltenbezeichner.

forceRemoveItems

boolean

Boolescher Wert, der angibt, ob Elemente während des Spaltenlöschvorgangs erzwungen werden sollen.

Gibt zurück

Promise<void>

deleteBoardRow(string, number, string, boolean)

Löscht eine Zeile aus einem Board.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

id

string

Zeilenbezeichner.

forceRemoveItems

boolean

Boolescher Wert, der angibt, ob Elemente beim Zeilenlöschen erzwungen werden sollen.

Gibt zurück

Promise<void>

getBoard(string, number)

Gibt Informationen für eine Platine aufgrund des eindeutigen Bezeichners zurück.

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

Parameter

project

string

Projekt-ID oder Projektname

id

number

Der eindeutige Bezeichner des Boards.

Gibt zurück

Promise<BoardResponse>

getBoardColumn(string, number, string)

Ruft Spaltendaten für ein Board unter Berücksichtigung des Bezeichners ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

id

string

Spaltenbezeichner.

Gibt zurück

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Ruft Spalten in einem Board ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

Gibt zurück

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Ruft Daten für das Element eines einzelnen Boards ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

id

string

Elementbezeichner.

Gibt zurück

Promise<BoardItemResponse>

getBoardItems(string, number)

Abrufen von Elementinformationen für ein Board unter Berücksichtigung des Bezeichners.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

Gibt zurück

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Ruft eine Zeile unter Berücksichtigung ihres Bezeichners und ihrer Platine ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

id

string

Boardzeilenbezeichner.

Gibt zurück

Promise<BoardRowResponse>

getBoardRows(string, number)

Abrufen von Zeilen in einem Board unter Berücksichtigung des Bezeichners.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Boardbezeichner.

Gibt zurück

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Holen Sie sich Boards.

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

Parameter

project

string

Projekt-ID oder Projektname

top

number

Die maximale Anzahl der abzurufenden Boards.

skip

number

Die Anzahl der zu überspringenden Boards.

Gibt zurück

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Entfernt ein Element aus einem Board.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Board-ID.

id

string

Zu entfernende Boardelementbezeichner.

Gibt zurück

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Updates ein Board.

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

Parameter

updatedBoard

UpdateBoard

Neue Boarddaten.

project

string

Projekt-ID oder Projektname

id

number

ID des zu aktualisierenden Boards.

eTag

String

Datum der letzten Änderung des Boards

Gibt zurück

Promise<BoardResponse>

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

Updates einer Tafelspalte.

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

Parameter

boardColumn

BoardColumnUpdate

Spaltendaten.

project

string

Projekt-ID oder Projektname

board

number

Board-ID.

id

string

Spaltenbezeichner.

eTag

String

Datum der letzten Änderung der Spalte

Gibt zurück

Promise<BoardColumnResponse>

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

Updates ein einzelnes Element in einem Board.

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

Parameter

updateItemDef

UpdateBoardItem

Aktualisierte Elementdaten.

project

string

Projekt-ID oder Projektname

board

number

Board-ID.

id

string

Aktualisieren Sie die Element-ID.

eTag

String

Datum der letzten Änderung des Elements

Gibt zurück

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Führen Sie einen Vorgang für einen Batch von Elementen aus.

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

Parameter

batchRequest

BoardItemBatchOperation

Daten, die den Batchvorgang definieren.

project

string

Projekt-ID oder Projektname

board

number

Die ID der Tafel, die die Elemente enthält.

Gibt zurück

Promise<BoardItemCollectionResponse>

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

Updates einer Boardzeile.

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

Parameter

boardRow

BoardRowUpdate

Zeilendaten.

project

string

Projekt-ID oder Projektname

board

number

Board-ID.

id

string

Zeilenbezeichner.

eTag

String

Datum der letzten Änderung der Zeile

Gibt zurück

Promise<BoardRowResponse>