BoardsRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

BoardsRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addBoardItem(NewBoardItem, string, number)	Aggiunge un singolo elemento a una lavagna.
createBoard(CreateBoard, string)	Aggiungere una nuova scheda per il progetto.
createBoardColumn(BoardColumnCreate, string, number)	Crea una nuova colonna in una scheda.
createBoardRow(BoardRowCreate, string, number)	Crea una nuova riga in una lavagna.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Crea una nuova sincronizzazione per una colonna in una scheda.
deleteBoard(string, number)	Elimina una bacheca.
deleteBoardColumn(string, number, string, boolean)	Elimina una colonna da una lavagna.
deleteBoardRow(string, number, string, boolean)	Elimina una riga da una bacheca.
getBoard(string, number)	Restituisce informazioni per una scheda in base al relativo identificatore univoco.
getBoardColumn(string, number, string)	Ottiene i dati della colonna per una scheda in base al relativo identificatore.
getBoardColumns(string, number)	Ottiene le colonne in una scheda.
getBoardItem(string, number, string)	Ottiene i dati per l'elemento di una singola scheda.
getBoardItems(string, number)	Ottenere informazioni sugli elementi per una bacheca in base al relativo identificatore.
getBoardRow(string, number, string)	Ottiene una riga in base all'identificatore e alla scheda.
getBoardRows(string, number)	Ottiene le righe in una bacheca in base all'identificatore.
getBoards(string, number, number)	Ottieni bacheche.
removeBoardItem(string, number, string)	Rimuove un elemento da una bacheca.
updateBoard(UpdateBoard, string, number, String)	Aggiornamenti una bacheca.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Aggiornamenti una colonna della scheda.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Aggiornamenti un singolo elemento in una lavagna.
updateBoardItems(BoardItemBatchOperation, string, number)	Eseguire un'operazione su un batch di elementi.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Aggiornamenti una riga della lavagna.

Dettagli costruttore

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addBoardItem(NewBoardItem, string, number)

Aggiunge un singolo elemento a una lavagna.

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

Parametri

item

NewBoardItem

Elemento da aggiungere alla scheda.

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

Restituisce

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Aggiungere una nuova scheda per il progetto.

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

Parametri

postedBoard

CreateBoard

Definizione della bacheca.

project

string

ID progetto o nome del progetto

Restituisce

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Crea una nuova colonna in una scheda.

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

Parametri

boardColumn

BoardColumnCreate

Dati di colonna.

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

Restituisce

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Crea una nuova riga in una lavagna.

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

Parametri

boardRow

BoardRowCreate

Dati di riga.

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

Restituisce

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Crea una nuova sincronizzazione per una colonna in una scheda.

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

Parametri

boardSync

BoardItemStateSyncCreate

project

string

ID progetto o nome del progetto

board

number

column

string

Restituisce

Promise<BoardItemStateSync>

deleteBoard(string, number)

Elimina una bacheca.

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

Parametri

project

string

ID progetto o nome del progetto

id

number

Identificatore della scheda.

Restituisce

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Elimina una colonna da una lavagna.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore di colonna.

forceRemoveItems

boolean

Valore booleano che indica se gli elementi devono essere rimossi durante l'eliminazione della colonna.

Restituisce

Promise<void>

deleteBoardRow(string, number, string, boolean)

Elimina una riga da una bacheca.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore di riga.

forceRemoveItems

boolean

Valore booleano che indica se gli elementi devono essere rimossi durante l'eliminazione della riga.

Restituisce

Promise<void>

getBoard(string, number)

Restituisce informazioni per una scheda in base al relativo identificatore univoco.

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

Parametri

project

string

ID progetto o nome del progetto

id

number

Identificatore univoco della bacheca.

Restituisce

Promise<BoardResponse>

getBoardColumn(string, number, string)

Ottiene i dati della colonna per una scheda in base al relativo identificatore.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore di colonna.

Restituisce

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Ottiene le colonne in una scheda.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

Restituisce

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Ottiene i dati per l'elemento di una singola scheda.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore dell'elemento.

Restituisce

Promise<BoardItemResponse>

getBoardItems(string, number)

Ottenere informazioni sugli elementi per una bacheca in base al relativo identificatore.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

Restituisce

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Ottiene una riga in base all'identificatore e alla scheda.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore di riga della scheda.

Restituisce

Promise<BoardRowResponse>

getBoardRows(string, number)

Ottiene le righe in una bacheca in base all'identificatore.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

Restituisce

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Ottieni bacheche.

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

Parametri

project

string

ID progetto o nome del progetto

top

number

Numero massimo di schede da ottenere.

skip

number

Numero di bacheche da ignorare.

Restituisce

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Rimuove un elemento da una bacheca.

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

Parametri

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore dell'elemento della bacheca da rimuovere.

Restituisce

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Aggiornamenti una bacheca.

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

Parametri

updatedBoard

UpdateBoard

Nuovi dati della bacheca.

project

string

ID progetto o nome del progetto

id

number

ID della scheda da aggiornare.

eTag

String

Data ultima modifica scheda

Restituisce

Promise<BoardResponse>

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

Aggiornamenti una colonna della scheda.

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

Parametri

boardColumn

BoardColumnUpdate

Dati di colonna.

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore di colonna.

eTag

String

Data ultima modifica colonna

Restituisce

Promise<BoardColumnResponse>

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

Aggiornamenti un singolo elemento in una lavagna.

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

Parametri

updateItemDef

UpdateBoardItem

Dati degli elementi aggiornati.

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Aggiornare l'ID elemento.

eTag

String

Data ultima modifica dell'elemento

Restituisce

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Eseguire un'operazione su un batch di elementi.

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

Parametri

batchRequest

BoardItemBatchOperation

Dati che definiscono l'operazione batch.

project

string

ID progetto o nome del progetto

board

number

ID della scheda contenente gli elementi.

Restituisce

Promise<BoardItemCollectionResponse>

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

Aggiornamenti una riga della lavagna.

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

Parametri

boardRow

BoardRowUpdate

Dati di riga.

project

string

ID progetto o nome del progetto

board

number

Identificatore della scheda.

id

string

Identificatore di riga.

eTag

String

Data ultima modifica riga

Restituisce

Promise<BoardRowResponse>