BoardsRestClient class
Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS
- Extends
Construtores
| Boards |
Propriedades
| RESOURCE_AREA_ID |
Métodos
Detalhes do Construtor
BoardsRestClient(IVssRestClientOptions)
Detalhes de Propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor 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 de quadro.
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 quadro.
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<BoardResponse>
createBoardColumn(BoardColumnCreate, string, number)
Cria uma nova coluna num quadro.
function createBoardColumn(boardColumn: BoardColumnCreate, project: string, board: number): Promise<BoardColumnResponse>Parâmetros
- boardColumn
- BoardColumnCreate
Dados de colunas.
- project
-
string
ID do Projeto ou nome do projeto
- board
-
number
Identificador de quadro.
Devoluções
Promise<BoardColumnResponse>
createBoardRow(BoardRowCreate, string, number)
Cria uma nova linha num 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 de quadro.
Devoluções
Promise<BoardRowResponse>
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)
Cria uma nova sincronização para uma coluna num 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)
Elimina 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 quadro.
Devoluções
Promise<void>
deleteBoardColumn(string, number, string, boolean)
Elimina 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 quadro.
- id
-
string
Identificador de coluna.
- forceRemoveItems
-
boolean
Valor booleano que indica se os itens devem ser removidos à força durante a eliminação da coluna.
Devoluções
Promise<void>
deleteBoardRow(string, number, string, boolean)
Elimina 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 de quadro.
- id
-
string
Identificador de linha.
- forceRemoveItems
-
boolean
Valor booleano que indica se os itens devem ser removidos à força durante a eliminação da linha.
Devoluções
Promise<void>
getBoard(string, number)
Devolve informações para um quadro, dado o 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 do quadro.
Devoluções
Promise<BoardResponse>
getBoardColumn(string, number, string)
Obtém dados de coluna para um quadro, dado o respetivo 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 quadro.
- id
-
string
Identificador de coluna.
Devoluções
Promise<BoardColumnResponse>
getBoardColumns(string, number)
Obter colunas num quadro.
function getBoardColumns(project: string, board: number): Promise<BoardColumnCollectionResponse>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- board
-
number
Identificador de quadro.
Devoluções
Promise<BoardColumnCollectionResponse>
getBoardItem(string, number, string)
Obtém dados para um único item de quadro.
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 quadro.
- id
-
string
Identificador de itens.
Devoluções
Promise<BoardItemResponse>
getBoardItems(string, number)
Obtenha informações de itens para um quadro com o respetivo identificador.
function getBoardItems(project: string, board: number): Promise<BoardItemCollectionResponse>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- board
-
number
Identificador de quadro.
Devoluções
Promise<BoardItemCollectionResponse>
getBoardRow(string, number, string)
Obtém uma linha com o 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 de quadro.
- id
-
string
Identificador de linha de quadro.
Devoluções
Promise<BoardRowResponse>
getBoardRows(string, number)
Obtenha linhas num quadro com o respetivo identificador.
function getBoardRows(project: string, board: number): Promise<BoardRowCollectionResponse>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- board
-
number
Identificador de quadro.
Devoluções
Promise<BoardRowCollectionResponse>
getBoards(string, number, number)
Obter quadros.
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 quadros a obter.
- skip
-
number
O número de quadros 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 de quadro.
- id
-
string
Identificador de Item de Quadro a remover.
Devoluções
Promise<void>
updateBoard(UpdateBoard, string, number, String)
Atualizações 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 atualizar.
- eTag
-
String
Data da Última Alteração do Quadro
Devoluções
Promise<BoardResponse>
updateBoardColumn(BoardColumnUpdate, string, number, string, String)
Atualizações uma coluna de quadro.
function updateBoardColumn(boardColumn: BoardColumnUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardColumnResponse>Parâmetros
- boardColumn
- BoardColumnUpdate
Dados de colunas.
- project
-
string
ID do Projeto ou nome do projeto
- board
-
number
Identificador de quadro.
- id
-
string
Identificador de coluna.
- eTag
-
String
Data alterada mais recente da coluna
Devoluções
Promise<BoardColumnResponse>
updateBoardItem(UpdateBoardItem, string, number, string, String)
Atualizações um único item num quadro.
function updateBoardItem(updateItemDef: UpdateBoardItem, project: string, board: number, id: string, eTag: String): Promise<BoardItemResponse>Parâmetros
- updateItemDef
- UpdateBoardItem
Dados de itens atualizados.
- project
-
string
ID do Projeto ou nome do projeto
- board
-
number
Identificador de quadro.
- id
-
string
Atualizar o ID do item.
- eTag
-
String
Data alterada mais recente do item
Devoluções
Promise<BoardItemResponse>
updateBoardItems(BoardItemBatchOperation, string, number)
Efetue uma operação num lote de itens.
function updateBoardItems(batchRequest: BoardItemBatchOperation, project: string, board: number): Promise<BoardItemCollectionResponse>Parâmetros
- batchRequest
- BoardItemBatchOperation
Dados que definem a operação de 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ções uma linha de 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 de quadro.
- id
-
string
Identificador de linha.
- eTag
-
String
Data da Última Alteração da Linha
Devoluções
Promise<BoardRowResponse>
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários