BoardsRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

RestClientBase

Constructeurs

BoardsRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

addBoardItem(NewBoardItem, string, number)	Ajoute un seul élément à un tableau.
createBoard(CreateBoard, string)	Ajoutez un nouveau tableau pour le projet.
createBoardColumn(BoardColumnCreate, string, number)	Crée une colonne sur un tableau.
createBoardRow(BoardRowCreate, string, number)	Crée une ligne sur un tableau.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Crée une synchronisation pour une colonne sur un tableau.
deleteBoard(string, number)	Supprime un tableau.
deleteBoardColumn(string, number, string, boolean)	Supprime une colonne d’un tableau.
deleteBoardRow(string, number, string, boolean)	Supprime une ligne d’un tableau.
getBoard(string, number)	Retourne les informations d’un tableau en fonction de son identificateur unique.
getBoardColumn(string, number, string)	Obtient les données de colonne d’un tableau en fonction de son identificateur.
getBoardColumns(string, number)	Obtenir des colonnes dans un tableau.
getBoardItem(string, number, string)	Obtient des données pour l’élément d’un tableau unique.
getBoardItems(string, number)	Obtenez des informations sur les éléments d’un tableau en fonction de son identificateur.
getBoardRow(string, number, string)	Obtient une ligne en fonction de son identificateur et de son tableau.
getBoardRows(string, number)	Obtenir des lignes dans un tableau en fonction de son identificateur.
getBoards(string, number, number)	Obtenez des tableaux.
removeBoardItem(string, number, string)	Supprime un élément d’un tableau.
updateBoard(UpdateBoard, string, number, String)	Mises à jour un tableau.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Mises à jour une colonne de tableau.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Mises à jour un seul élément dans un tableau.
updateBoardItems(BoardItemBatchOperation, string, number)	Effectuez une opération sur un lot d’éléments.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Mises à jour une ligne de tableau.

Détails du constructeur

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

addBoardItem(NewBoardItem, string, number)

Ajoute un seul élément à un tableau.

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

Paramètres

item

NewBoardItem

Élément à ajouter au tableau.

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

Retours

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Ajoutez un nouveau tableau pour le projet.

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

Paramètres

postedBoard

CreateBoard

Définition du tableau d’administration.

project

string

ID de projet ou nom du projet

Retours

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Crée une colonne sur un tableau.

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

Paramètres

boardColumn

BoardColumnCreate

Données de colonne.

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

Retours

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Crée une ligne sur un tableau.

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

Paramètres

boardRow

BoardRowCreate

Données de ligne.

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

Retours

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Crée une synchronisation pour une colonne sur un tableau.

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

Paramètres

boardSync

BoardItemStateSyncCreate

project

string

ID de projet ou nom du projet

board

number

column

string

Retours

Promise<BoardItemStateSync>

deleteBoard(string, number)

Supprime un tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

id

number

Identificateur de carte.

Retours

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Supprime une colonne d’un tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur de colonne.

forceRemoveItems

boolean

Boolean indiquant si les éléments doivent être supprimés de force pendant la suppression de colonne.

Retours

Promise<void>

deleteBoardRow(string, number, string, boolean)

Supprime une ligne d’un tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur de ligne.

forceRemoveItems

boolean

Boolean indiquant si les éléments doivent être supprimés de force pendant la suppression de ligne.

Retours

Promise<void>

getBoard(string, number)

Retourne les informations d’un tableau en fonction de son identificateur unique.

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

Paramètres

project

string

ID de projet ou nom du projet

id

number

Identificateur unique de Board.

Retours

Promise<BoardResponse>

getBoardColumn(string, number, string)

Obtient les données de colonne d’un tableau en fonction de son identificateur.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur de colonne.

Retours

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Obtenir des colonnes dans un tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

Retours

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Obtient des données pour l’élément d’un tableau unique.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur d’élément.

Retours

Promise<BoardItemResponse>

getBoardItems(string, number)

Obtenez des informations sur les éléments d’un tableau en fonction de son identificateur.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

Retours

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Obtient une ligne en fonction de son identificateur et de son tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur de ligne du tableau.

Retours

Promise<BoardRowResponse>

getBoardRows(string, number)

Obtenir des lignes dans un tableau en fonction de son identificateur.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

Retours

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Obtenez des tableaux.

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

Paramètres

project

string

ID de projet ou nom du projet

top

number

Nombre maximal de tableaux à obtenir.

skip

number

Nombre de tableaux à ignorer.

Retours

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Supprime un élément d’un tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur d’élément de tableau à supprimer.

Retours

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Mises à jour un tableau.

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

Paramètres

updatedBoard

UpdateBoard

Nouvelles données de tableau.

project

string

ID de projet ou nom du projet

id

number

ID du tableau à mettre à jour.

eTag

String

Date de dernière modification du tableau

Retours

Promise<BoardResponse>

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

Mises à jour une colonne de tableau.

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

Paramètres

boardColumn

BoardColumnUpdate

Données de colonne.

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur de colonne.

eTag

String

Date de dernière modification de colonne

Retours

Promise<BoardColumnResponse>

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

Mises à jour un seul élément dans un tableau.

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

Paramètres

updateItemDef

UpdateBoardItem

Données d’élément mises à jour.

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Mettre à jour l’ID d’élément.

eTag

String

Date de dernière modification de l’élément

Retours

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Effectuez une opération sur un lot d’éléments.

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

Paramètres

batchRequest

BoardItemBatchOperation

Données définissant l’opération de traitement par lots.

project

string

ID de projet ou nom du projet

board

number

ID du tableau contenant les éléments.

Retours

Promise<BoardItemCollectionResponse>

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

Mises à jour une ligne de tableau.

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

Paramètres

boardRow

BoardRowUpdate

Données de ligne.

project

string

ID de projet ou nom du projet

board

number

Identificateur de carte.

id

string

Identificateur de ligne.

eTag

String

Date de dernière modification de ligne

Retours

Promise<BoardRowResponse>