BoardsRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna

Extends

RestClientBase

Konstruktorer

BoardsRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addBoardItem(NewBoardItem, string, number)	Lägger till ett enskilt objekt på en tavla.
createBoard(CreateBoard, string)	Lägg till en ny tavla för projektet.
createBoardColumn(BoardColumnCreate, string, number)	Skapar en ny kolumn på ett bräde.
createBoardRow(BoardRowCreate, string, number)	Skapar en ny rad på en tavla.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Skapar en ny synkronisering för en kolumn på ett bräde.
deleteBoard(string, number)	Tar bort en tavla.
deleteBoardColumn(string, number, string, boolean)	Tar bort en kolumn från en tavla.
deleteBoardRow(string, number, string, boolean)	Tar bort en rad från en tavla.
getBoard(string, number)	Returnerar information för en tavla baserat på dess unika identifierare.
getBoardColumn(string, number, string)	Hämtar kolumndata för en tavla med dess identifierare.
getBoardColumns(string, number)	Hämta kolumner i en tavla.
getBoardItem(string, number, string)	Hämtar data för en enskild styrelses objekt.
getBoardItems(string, number)	Hämta objektinformation för en tavla med dess identifierare.
getBoardRow(string, number, string)	Hämtar en rad med tanke på dess identifierare och bräde.
getBoardRows(string, number)	Hämta rader i en tavla med dess identifierare.
getBoards(string, number, number)	Hämta tavlor.
removeBoardItem(string, number, string)	Tar bort ett objekt från en tavla.
updateBoard(UpdateBoard, string, number, String)	Uppdateringar en tavla.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Uppdateringar en brädkolumn.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Uppdateringar ett enda objekt på en tavla.
updateBoardItems(BoardItemBatchOperation, string, number)	Utför en åtgärd på en batch med objekt.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Uppdateringar en brädrad.

Konstruktorinformation

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addBoardItem(NewBoardItem, string, number)

Lägger till ett enskilt objekt på en tavla.

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

Parametrar

item

NewBoardItem

Objekt som ska läggas till på tavlan.

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

Returer

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Lägg till en ny tavla för projektet.

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

Parametrar

postedBoard

CreateBoard

Styrelsedefinition.

project

string

Projekt-ID eller projektnamn

Returer

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Skapar en ny kolumn på ett bräde.

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

Parametrar

boardColumn

BoardColumnCreate

Kolumndata.

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

Returer

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Skapar en ny rad på en tavla.

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

Parametrar

boardRow

BoardRowCreate

Raddata.

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

Returer

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Skapar en ny synkronisering för en kolumn på ett bräde.

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

Parametrar

boardSync

BoardItemStateSyncCreate

project

string

Projekt-ID eller projektnamn

board

number

column

string

Returer

Promise<BoardItemStateSync>

deleteBoard(string, number)

Tar bort en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

id

number

Brädidentifierare.

Returer

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Tar bort en kolumn från en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Kolumnidentifierare.

forceRemoveItems

boolean

Booleskt värde som anger om objekt ska tvingas tas bort under kolumnborttagningen.

Returer

Promise<void>

deleteBoardRow(string, number, string, boolean)

Tar bort en rad från en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Radidentifierare.

forceRemoveItems

boolean

Booleskt värde som anger om objekt ska tvingas tas bort under radborttagningen.

Returer

Promise<void>

getBoard(string, number)

Returnerar information för en tavla baserat på dess unika identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

id

number

Styrelsens unika identifierare.

Returer

Promise<BoardResponse>

getBoardColumn(string, number, string)

Hämtar kolumndata för en tavla med dess identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Kolumnidentifierare.

Returer

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Hämta kolumner i en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

Returer

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Hämtar data för en enskild styrelses objekt.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Objektidentifierare.

Returer

Promise<BoardItemResponse>

getBoardItems(string, number)

Hämta objektinformation för en tavla med dess identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

Returer

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Hämtar en rad med tanke på dess identifierare och bräde.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Brädradsidentifierare.

Returer

Promise<BoardRowResponse>

getBoardRows(string, number)

Hämta rader i en tavla med dess identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

Returer

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Hämta tavlor.

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

Parametrar

project

string

Projekt-ID eller projektnamn

top

number

Det maximala antalet brädor att hämta.

skip

number

Antalet tavlor att hoppa över.

Returer

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Tar bort ett objekt från en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Brädobjektidentifierare att ta bort.

Returer

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Uppdateringar en tavla.

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

Parametrar

updatedBoard

UpdateBoard

Nya bräddata.

project

string

Projekt-ID eller projektnamn

id

number

ID för kortet som ska uppdateras.

eTag

String

Styrelsens senaste ändrade datum

Returer

Promise<BoardResponse>

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

Uppdateringar en brädkolumn.

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

Parametrar

boardColumn

BoardColumnUpdate

Kolumndata.

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Kolumnidentifierare.

eTag

String

Senaste ändrade kolumndatum

Returer

Promise<BoardColumnResponse>

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

Uppdateringar ett enda objekt på en tavla.

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

Parametrar

updateItemDef

UpdateBoardItem

Uppdaterade objektdata.

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Uppdatera objekt-ID.

eTag

String

Senaste ändringsdatum för objekt

Returer

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Utför en åtgärd på en batch med objekt.

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

Parametrar

batchRequest

BoardItemBatchOperation

Data som definierar batchåtgärden.

project

string

Projekt-ID eller projektnamn

board

number

ID:t för kortet som innehåller objekten.

Returer

Promise<BoardItemCollectionResponse>

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

Uppdateringar en brädrad.

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

Parametrar

boardRow

BoardRowUpdate

Raddata.

project

string

Projekt-ID eller projektnamn

board

number

Brädidentifierare.

id

string

Radidentifierare.

eTag

String

Senaste ändringsdatum för rad

Returer

Promise<BoardRowResponse>