BoardsRestClient class

Paket:

azure-devops-extension-api

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

Extends

RestClientBase

Konstruktoren

BoardsRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addBoardItem(NewBoardItem, string, number)	Fügt einer Tafel 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 einer Tafel.
createBoardRow(BoardRowCreate, string, number)	Erstellt eine neue Zeile auf einer Tafel.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Erstellt eine neue Synchronisierung für eine Spalte auf einer Tafel.
deleteBoard(string, number)	Löscht eine Tafel.
deleteBoardColumn(string, number, string, boolean)	Löscht eine Spalte aus einer Tafel.
deleteBoardRow(string, number, string, boolean)	Löscht eine Zeile aus einer Tafel.
getBoard(string, number)	Gibt Informationen für eine Tafel zurück, die ihren eindeutigen Bezeichner erhält.
getBoardColumn(string, number, string)	Ruft Spaltendaten für eine Tafel mit dem Bezeichner ab.
getBoardColumns(string, number)	Abrufen von Spalten in einer Tafel.
getBoardItem(string, number, string)	Ruft Daten für das Element einer einzelnen Tafel ab.
getBoardItems(string, number)	Abrufen von Elementinformationen für eine Tafel anhand des Bezeichners.
getBoardRow(string, number, string)	Ruft eine Zeile mit dem Bezeichner und der Tafel ab.
getBoardRows(string, number)	Dient zum Abrufen von Zeilen in einer Tafel mit dem Bezeichner.
getBoards(string, number, number)	Holen Sie sich Boards.
removeBoardItem(string, number, string)	Entfernt ein Element aus einer Tafel.
updateBoard(UpdateBoard, string, number, String)	Aktualisiert eine Tafel.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Aktualisiert eine Tafelspalte.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Aktualisiert ein einzelnes Element in einer Tafel.
updateBoardItems(BoardItemBatchOperation, string, number)	Führen Sie einen Vorgang für eine Reihe von Elementen aus.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Aktualisiert eine Tafelzeile.

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 einer Tafel ein einzelnes Element hinzu.

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

Parameter

item

NewBoardItem

Element, das der Tafel hinzugefügt werden soll.

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

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 einer Tafel.

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

Parameter

boardColumn

BoardColumnCreate

Spaltendaten.

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

Gibt zurück

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Erstellt eine neue Zeile auf einer Tafel.

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

Parameter

boardRow

BoardRowCreate

Zeilendaten.

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

Gibt zurück

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Erstellt eine neue Synchronisierung für eine Spalte auf einer Tafel.

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 eine Tafel.

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

Parameter

project

string

Projekt-ID oder Projektname

id

number

Tafelbezeichner.

Gibt zurück

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Löscht eine Spalte aus einer Tafel.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Spaltenbezeichner.

forceRemoveItems

boolean

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

Gibt zurück

Promise<void>

deleteBoardRow(string, number, string, boolean)

Löscht eine Zeile aus einer Tafel.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Zeilenbezeichner.

forceRemoveItems

boolean

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

Gibt zurück

Promise<void>

getBoard(string, number)

Gibt Informationen für eine Tafel zurück, die ihren eindeutigen Bezeichner erhält.

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

Parameter

project

string

Projekt-ID oder Projektname

id

number

Eindeutiger Bezeichner des Board.

Gibt zurück

Promise<BoardResponse>

getBoardColumn(string, number, string)

Ruft Spaltendaten für eine Tafel mit dem Bezeichner ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Spaltenbezeichner.

Gibt zurück

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Abrufen von Spalten in einer Tafel.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

Gibt zurück

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Ruft Daten für das Element einer einzelnen Tafel ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Elementbezeichner.

Gibt zurück

Promise<BoardItemResponse>

getBoardItems(string, number)

Abrufen von Elementinformationen für eine Tafel anhand des Bezeichners.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

Gibt zurück

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Ruft eine Zeile mit dem Bezeichner und der Tafel ab.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Tafelzeilenbezeichner.

Gibt zurück

Promise<BoardRowResponse>

getBoardRows(string, number)

Dient zum Abrufen von Zeilen in einer Tafel mit dem Bezeichner.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

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 von Boards, die abgerufen werden sollen.

skip

number

Die Anzahl der zu überspringenden Boards.

Gibt zurück

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Entfernt ein Element aus einer Tafel.

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

Parameter

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Zu entfernende Tafelelement-ID.

Gibt zurück

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Aktualisiert eine Tafel.

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 der Tafel

Gibt zurück

Promise<BoardResponse>

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

Aktualisiert eine 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

Tafelbezeichner.

id

string

Spaltenbezeichner.

eTag

String

Datum der letzten Änderung der Spalte

Gibt zurück

Promise<BoardColumnResponse>

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

Aktualisiert ein einzelnes Element in einer Tafel.

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

Parameter

updateItemDef

UpdateBoardItem

Elementdaten aktualisiert.

project

string

Projekt-ID oder Projektname

board

number

Tafelbezeichner.

id

string

Element-ID aktualisieren.

eTag

String

Datum der letzten Änderung des Elements

Gibt zurück

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Führen Sie einen Vorgang für eine Reihe 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)

Aktualisiert eine Tafelzeile.

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

Tafelbezeichner.

id

string

Zeilenbezeichner.

eTag

String

Datum der letzten Änderung der Zeile

Gibt zurück

Promise<BoardRowResponse>