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 nouvelle colonne sur un tableau.
createBoardRow(BoardRowCreate, string, number)	Crée une nouvelle ligne sur un tableau.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Crée une synchronisation pour une colonne d’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)	Renvoie des informations pour 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 identifiant.
getBoardColumns(string, number)	Obtenir des colonnes dans un tableau.
getBoardItem(string, number, string)	Obtient les données d’un seul élément du tableau.
getBoardItems(string, number)	Obtenir des informations sur les éléments d’un tableau en fonction de son identifiant.
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 identifiant.
getBoards(string, number, number)	Obtenez des planches.
removeBoardItem(string, number, string)	Supprime un élément d’un tableau.
updateBoard(UpdateBoard, string, number, String)	Met à jour un tableau.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Met à jour une colonne du tableau.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Met à jour un seul élément d’un tableau.
updateBoardItems(BoardItemBatchOperation, string, number)	Effectuer une opération sur un lot d’articles.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Met à jour une ligne du 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

Objet à ajouter au tableau.

project

string

ID de projet ou nom du projet

board

number

Identificateur du tableau.

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 conseil d’administration.

project

string

ID de projet ou nom du projet

Retours

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Crée une nouvelle 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 du tableau.

Retours

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Crée une nouvelle 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 du tableau.

Retours

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Crée une synchronisation pour une colonne d’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 du tableau.

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 du tableau.

id

string

Identificateur de colonne.

forceRemoveItems

boolean

Booléen indiquant si les éléments doivent être supprimés de force lors de 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 du tableau.

id

string

Identificateur de ligne.

forceRemoveItems

boolean

Booléen indiquant si les éléments doivent être supprimés de force lors de la suppression de ligne.

Retours

Promise<void>

getBoard(string, number)

Renvoie des informations pour 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 du conseil.

Retours

Promise<BoardResponse>

getBoardColumn(string, number, string)

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

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur du tableau.

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 du tableau.

Retours

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Obtient les données d’un seul élément du tableau.

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur du tableau.

id

string

Identificateur de l’élément.

Retours

Promise<BoardItemResponse>

getBoardItems(string, number)

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

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur du tableau.

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 du tableau.

id

string

Identificateur de ligne du tableau.

Retours

Promise<BoardRowResponse>

getBoardRows(string, number)

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

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

Paramètres

project

string

ID de projet ou nom du projet

board

number

Identificateur du tableau.

Retours

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Obtenez des planches.

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

Paramètres

project

string

ID de projet ou nom du projet

top

number

Le nombre maximum de planches à obtenir.

skip

number

Le nombre de planches à sauter.

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 du tableau.

id

string

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

Retours

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Met à jour un tableau.

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

Paramètres

updatedBoard

UpdateBoard

Nouvelles données du plateau.

project

string

ID de projet ou nom du projet

id

number

Id du tableau à mettre à jour.

eTag

String

Date de la dernière modification du conseil d’administration

Retours

Promise<BoardResponse>

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

Met à jour une colonne du 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 du tableau.

id

string

Identificateur de colonne.

eTag

String

Colonne Date de la dernière modification

Retours

Promise<BoardColumnResponse>

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

Met à jour un seul élément d’un tableau.

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

Paramètres

updateItemDef

UpdateBoardItem

Mise à jour des données de l’article.

project

string

ID de projet ou nom du projet

board

number

Identificateur du tableau.

id

string

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

eTag

String

Date de la dernière modification de l’objet

Retours

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Effectuer une opération sur un lot d’articles.

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

Paramètres

batchRequest

BoardItemBatchOperation

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

project

string

ID de projet ou nom du projet

board

number

L’identifiant du tableau contenant les éléments.

Retours

Promise<BoardItemCollectionResponse>

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

Met à jour une ligne du 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 du tableau.

id

string

Identificateur de ligne.

eTag

String

Ligne Date de la dernière modification

Retours

Promise<BoardRowResponse>