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:er

Extends

RestClientBase

Konstruktorer

BoardsRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addBoardItem(NewBoardItem, string, number)	Lägger till ett enskilt objekt på en anslagstavla.
createBoard(CreateBoard, string)	Lägg till en ny anslagstavla för projektet.
createBoardColumn(BoardColumnCreate, string, number)	Skapar en ny kolumn på en anslagstavla.
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å en anslagstavla.
deleteBoard(string, number)	Tar bort en anslagstavla.
deleteBoardColumn(string, number, string, boolean)	Tar bort en kolumn från en anslagstavla.
deleteBoardRow(string, number, string, boolean)	Tar bort en rad från en anslagstavla.
getBoard(string, number)	Returnerar information för en anslagstavla med tanke på dess unika identifierare.
getBoardColumn(string, number, string)	Hämtar kolumndata för en anslagstavla med tanke på dess identifierare.
getBoardColumns(string, number)	Hämta kolumner på en tavla.
getBoardItem(string, number, string)	Hämtar data för ett enskilt objekt på en tavla.
getBoardItems(string, number)	Hämta objektinformation för en anslagstavla med tanke på dess identifierare.
getBoardRow(string, number, string)	Hämtar en rad med tanke på dess identifierare och bräda.
getBoardRows(string, number)	Hämta rader på en anslagstavla med tanke på dess identifierare.
getBoards(string, number, number)	Skaffa anslagstavlor.
removeBoardItem(string, number, string)	Tar bort ett objekt från en anslagstavla.
updateBoard(UpdateBoard, string, number, String)	Uppdaterar en anslagstavla.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Uppdaterar en anslagstavlakolumn.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Uppdaterar ett enskilt objekt på en anslagstavla.
updateBoardItems(BoardItemBatchOperation, string, number)	Utför en operation på en batch med artiklar.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Uppdaterar en anslagstavla.

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 anslagstavla.

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

Parametrar

item

NewBoardItem

Objekt att lägga till på tavlan.

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

Returer

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

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

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

Parametrar

postedBoard

CreateBoard

Definition av styrelse.

project

string

Projekt-ID eller projektnamn

Returer

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Skapar en ny kolumn på en anslagstavla.

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

Parametrar

boardColumn

BoardColumnCreate

Kolumn data.

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

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

Identifierare för anslagstavlan.

Returer

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Skapar en ny synkronisering för en kolumn på en anslagstavla.

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 anslagstavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

id

number

Identifierare för anslagstavlan.

Returer

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Tar bort en kolumn från en anslagstavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för kolumn.

forceRemoveItems

boolean

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

Returer

Promise<void>

deleteBoardRow(string, number, string, boolean)

Tar bort en rad från en anslagstavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för rad.

forceRemoveItems

boolean

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

Returer

Promise<void>

getBoard(string, number)

Returnerar information för en anslagstavla med tanke på dess unika identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

id

number

Nämndens unika identifierare.

Returer

Promise<BoardResponse>

getBoardColumn(string, number, string)

Hämtar kolumndata för en anslagstavla med tanke på dess identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för kolumn.

Returer

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Hämta kolumner på en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

Returer

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Hämtar data för ett enskilt objekt på en tavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för objekt.

Returer

Promise<BoardItemResponse>

getBoardItems(string, number)

Hämta objektinformation för en anslagstavla med tanke på dess identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

Returer

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

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

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för anslagstavla.

Returer

Promise<BoardRowResponse>

getBoardRows(string, number)

Hämta rader på en anslagstavla med tanke på dess identifierare.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

Returer

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Skaffa anslagstavlor.

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 få.

skip

number

Antalet anslagstavlor som ska hoppas över.

Returer

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Tar bort ett objekt från en anslagstavla.

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

Parametrar

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för anslagstavla som ska tas bort.

Returer

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Uppdaterar en anslagstavla.

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

Parametrar

updatedBoard

UpdateBoard

Nya uppgifter om anslagstavlorna.

project

string

Projekt-ID eller projektnamn

id

number

ID för anslagstavlan som ska uppdateras.

eTag

String

Styrelsens senaste ändringsdatum

Returer

Promise<BoardResponse>

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

Uppdaterar en anslagstavlakolumn.

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

Parametrar

boardColumn

BoardColumnUpdate

Kolumn data.

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Identifierare för kolumn.

eTag

String

Kolumn Senast ändrat datum

Returer

Promise<BoardColumnResponse>

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

Uppdaterar ett enskilt objekt på en anslagstavla.

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

Parametrar

updateItemDef

UpdateBoardItem

Uppdaterad artikeldata.

project

string

Projekt-ID eller projektnamn

board

number

Identifierare för anslagstavlan.

id

string

Uppdatera objekt-ID.

eTag

String

Datum för senaste ändring av objekt

Returer

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Utför en operation på en batch med artiklar.

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 anslagstavlan som innehåller objekten.

Returer

Promise<BoardItemCollectionResponse>

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

Uppdaterar en anslagstavla.

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

Identifierare för anslagstavlan.

id

string

Identifierare för rad.

eTag

String

Rad Senast ändrat datum

Returer

Promise<BoardRowResponse>