BoardsRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends

RestClientBase

Construtores

BoardsRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addBoardItem(NewBoardItem, string, number)	Adiciona um único item a um quadro.
createBoard(CreateBoard, string)	Adicione um novo quadro para o projeto.
createBoardColumn(BoardColumnCreate, string, number)	Cria uma nova coluna em um quadro.
createBoardRow(BoardRowCreate, string, number)	Cria uma nova linha em um quadro.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Cria uma nova sincronização para uma coluna em um quadro.
deleteBoard(string, number)	Exclui um quadro.
deleteBoardColumn(string, number, string, boolean)	Exclui uma coluna de um quadro.
deleteBoardRow(string, number, string, boolean)	Exclui uma linha de um quadro.
getBoard(string, number)	Devolve informações para uma placa com o seu identificador único.
getBoardColumn(string, number, string)	Obtém dados de coluna para um quadro dado seu identificador.
getBoardColumns(string, number)	Obter colunas em um quadro.
getBoardItem(string, number, string)	Obtém dados para um único item do painel.
getBoardItems(string, number)	Obter informações de itens para um quadro dado o seu identificador.
getBoardRow(string, number, string)	Obtém uma linha dada seu identificador e quadro.
getBoardRows(string, number)	Obter linhas em um quadro dado seu identificador.
getBoards(string, number, number)	Obtenha pranchas.
removeBoardItem(string, number, string)	Remove um item de um quadro.
updateBoard(UpdateBoard, string, number, String)	Atualiza um quadro.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Atualiza uma coluna do quadro.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Atualiza um único item em um quadro.
updateBoardItems(BoardItemBatchOperation, string, number)	Faça uma operação em um lote de itens.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Atualiza uma linha do quadro.

Detalhes do Construtor

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addBoardItem(NewBoardItem, string, number)

Adiciona um único item a um quadro.

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

Parâmetros

item

NewBoardItem

Item a adicionar ao quadro.

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

Devoluções

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Adicione um novo quadro para o projeto.

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

Parâmetros

postedBoard

CreateBoard

Definição do conselho.

project

string

ID do projeto ou nome do projeto

Devoluções

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Cria uma nova coluna em um quadro.

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

Parâmetros

boardColumn

BoardColumnCreate

Dados da coluna.

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

Devoluções

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Cria uma nova linha em um quadro.

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

Parâmetros

boardRow

BoardRowCreate

Dados de linha.

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

Devoluções

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Cria uma nova sincronização para uma coluna em um quadro.

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

Parâmetros

boardSync

BoardItemStateSyncCreate

project

string

ID do projeto ou nome do projeto

board

number

column

string

Devoluções

Promise<BoardItemStateSync>

deleteBoard(string, number)

Exclui um quadro.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

id

number

Identificador da placa.

Devoluções

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Exclui uma coluna de um quadro.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de coluna.

forceRemoveItems

boolean

Booleano indicando se os itens devem ser removidos à força durante a exclusão da coluna.

Devoluções

Promise<void>

deleteBoardRow(string, number, string, boolean)

Exclui uma linha de um quadro.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de linha.

forceRemoveItems

boolean

Booleano indicando se os itens devem ser removidos à força durante a exclusão da linha.

Devoluções

Promise<void>

getBoard(string, number)

Devolve informações para uma placa com o seu identificador único.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

id

number

Identificador único do Conselho.

Devoluções

Promise<BoardResponse>

getBoardColumn(string, number, string)

Obtém dados de coluna para um quadro dado seu identificador.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de coluna.

Devoluções

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Obter colunas em um quadro.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

Devoluções

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Obtém dados para um único item do painel.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador do item.

Devoluções

Promise<BoardItemResponse>

getBoardItems(string, number)

Obter informações de itens para um quadro dado o seu identificador.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

Devoluções

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Obtém uma linha dada seu identificador e quadro.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de linha da placa.

Devoluções

Promise<BoardRowResponse>

getBoardRows(string, number)

Obter linhas em um quadro dado seu identificador.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

Devoluções

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Obtenha pranchas.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

top

number

O número máximo de placas a obter.

skip

number

O número de pranchas a ignorar.

Devoluções

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Remove um item de um quadro.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de item da placa a remover.

Devoluções

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Atualiza um quadro.

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

Parâmetros

updatedBoard

UpdateBoard

Novos dados da placa.

project

string

ID do projeto ou nome do projeto

id

number

Id da placa a atualizar.

eTag

String

Data da última alteração da placa

Devoluções

Promise<BoardResponse>

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

Atualiza uma coluna do quadro.

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

Parâmetros

boardColumn

BoardColumnUpdate

Dados da coluna.

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de coluna.

eTag

String

Coluna Data da última alteração

Devoluções

Promise<BoardColumnResponse>

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

Atualiza um único item em um quadro.

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

Parâmetros

updateItemDef

UpdateBoardItem

Dados atualizados do item.

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Atualizar ID do item.

eTag

String

Data da última alteração do item

Devoluções

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Faça uma operação em um lote de itens.

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

Parâmetros

batchRequest

BoardItemBatchOperation

Dados que definem a operação em lote.

project

string

ID do projeto ou nome do projeto

board

number

O id do quadro que contém os itens.

Devoluções

Promise<BoardItemCollectionResponse>

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

Atualiza uma linha do quadro.

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

Parâmetros

boardRow

BoardRowUpdate

Dados de linha.

project

string

ID do projeto ou nome do projeto

board

number

Identificador da placa.

id

string

Identificador de linha.

eTag

String

Data da última alteração da linha

Devoluções

Promise<BoardRowResponse>