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 uma placa.
createBoard(CreateBoard, string)	Adicione uma nova placa para o projeto.
createBoardColumn(BoardColumnCreate, string, number)	Cria uma nova coluna em um quadro.
createBoardRow(BoardRowCreate, string, number)	Cria uma nova linha em uma placa.
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 uma placa.
getBoard(string, number)	Retorna informações para um quadro dado seu identificador exclusivo.
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 de placa.
getBoardItems(string, number)	Obtenha informações de itens para um quadro dado seu identificador.
getBoardRow(string, number, string)	Obtém uma linha com o identificador e a placa.
getBoardRows(string, number)	Obtenha linhas em um quadro, considerando seu identificador.
getBoards(string, number, number)	Obter placas.
removeBoardItem(string, number, string)	Remove um item de uma placa.
updateBoard(UpdateBoard, string, number, String)	Atualiza um quadro.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Atualiza uma coluna de 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 de placa.

Detalhes do construtor

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

addBoardItem(NewBoardItem, string, number)

Adiciona um único item a uma placa.

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

Parâmetros

item

NewBoardItem

Item a ser adicionado ao quadro.

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

Retornos

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Adicione uma nova placa para o projeto.

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

Parâmetros

postedBoard

CreateBoard

Definição de quadro.

project

string

ID do projeto ou nome do projeto

Retornos

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 de placa.

Retornos

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Cria uma nova linha em uma placa.

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 de placa.

Retornos

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

Retornos

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 de placa.

Retornos

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 de placa.

id

string

Identificador de coluna.

forceRemoveItems

boolean

Booliano indicando se os itens devem ser forçados a serem removidos durante a exclusão da coluna.

Retornos

Promise<void>

deleteBoardRow(string, number, string, boolean)

Exclui uma linha de uma placa.

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 de placa.

id

string

Identificador de linha.

forceRemoveItems

boolean

Booliano indicando se os itens devem ser forçados a serem removidos durante a exclusão de linha.

Retornos

Promise<void>

getBoard(string, number)

Retorna informações para um quadro dado seu identificador exclusivo.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

id

number

Identificador exclusivo da placa.

Retornos

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 de placa.

id

string

Identificador de coluna.

Retornos

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 de placa.

Retornos

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Obtém dados para um único item de placa.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

id

string

Identificador de item.

Retornos

Promise<BoardItemResponse>

getBoardItems(string, number)

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

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

Retornos

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Obtém uma linha com o identificador e a placa.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

id

string

Identificador de linha de placa.

Retornos

Promise<BoardRowResponse>

getBoardRows(string, number)

Obtenha linhas em um quadro, considerando seu identificador.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

Retornos

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Obter placas.

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 serem obtidos.

skip

number

O número de placas a serem ignoradas.

Retornos

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Remove um item de uma placa.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

id

string

Identificador de item de placa a ser removido.

Retornos

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 do quadro.

project

string

ID do projeto ou nome do projeto

id

number

Id do quadro a ser atualizado.

eTag

String

Data da alteração mais recente do painel

Retornos

Promise<BoardResponse>

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

Atualiza uma coluna de 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 de placa.

id

string

Identificador de coluna.

eTag

String

Data da alteração mais recente da coluna

Retornos

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 de item atualizados.

project

string

ID do projeto ou nome do projeto

board

number

Identificador de placa.

id

string

Atualizar a ID do item.

eTag

String

Data da alteração mais recente do item

Retornos

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

A ID da placa que contém os itens.

Retornos

Promise<BoardItemCollectionResponse>

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

Atualiza uma linha de placa.

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 de placa.

id

string

Identificador de linha.

eTag

String

Data da alteração mais recente da linha

Retornos

Promise<BoardRowResponse>