BoardsRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Boards |
Propiedades
| RESOURCE_AREA_ID |
Métodos
Detalles del constructor
BoardsRestClient(IVssRestClientOptions)
Detalles de las propiedades
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de propiedad
string
Detalles del método
addBoardItem(NewBoardItem, string, number)
Agrega un solo elemento a un panel.
function addBoardItem(item: NewBoardItem, project: string, board: number): Promise<BoardItemResponse>Parámetros
- item
- NewBoardItem
Elemento que se va a agregar al panel.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
Devoluciones
Promise<BoardItemResponse>
createBoard(CreateBoard, string)
Agregue un nuevo panel para el proyecto.
function createBoard(postedBoard: CreateBoard, project: string): Promise<BoardResponse>Parámetros
- postedBoard
- CreateBoard
Definición del panel.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<BoardResponse>
createBoardColumn(BoardColumnCreate, string, number)
Crea una nueva columna en un panel.
function createBoardColumn(boardColumn: BoardColumnCreate, project: string, board: number): Promise<BoardColumnResponse>Parámetros
- boardColumn
- BoardColumnCreate
Datos de columna.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
Devoluciones
Promise<BoardColumnResponse>
createBoardRow(BoardRowCreate, string, number)
Crea una nueva fila en un panel.
function createBoardRow(boardRow: BoardRowCreate, project: string, board: number): Promise<BoardRowResponse>Parámetros
- boardRow
- BoardRowCreate
Datos de fila.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
Devoluciones
Promise<BoardRowResponse>
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)
Crea una nueva sincronización para una columna de un panel.
function createBoardSyncAction(boardSync: BoardItemStateSyncCreate, project: string, board: number, column: string): Promise<BoardItemStateSync>Parámetros
- boardSync
- BoardItemStateSyncCreate
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
- column
-
string
Devoluciones
Promise<BoardItemStateSync>
deleteBoard(string, number)
Elimina un panel.
function deleteBoard(project: string, id: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- id
-
number
Identificador de la placa.
Devoluciones
Promise<void>
deleteBoardColumn(string, number, string, boolean)
Elimina una columna de un panel.
function deleteBoardColumn(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
- id
-
string
Identificador de columna.
- forceRemoveItems
-
boolean
Boolean que indica si se van a forzar la eliminación de elementos durante la eliminación de columnas.
Devoluciones
Promise<void>
deleteBoardRow(string, number, string, boolean)
Elimina una fila de un panel.
function deleteBoardRow(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
- id
-
string
Identificador de fila.
- forceRemoveItems
-
boolean
Boolean que indica si los elementos se van a quitar durante la eliminación de filas.
Devoluciones
Promise<void>
getBoard(string, number)
Devuelve información de un panel según su identificador único.
function getBoard(project: string, id: number): Promise<BoardResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- id
-
number
Identificador único de la junta.
Devoluciones
Promise<BoardResponse>
getBoardColumn(string, number, string)
Obtiene los datos de columna de un panel según su identificador.
function getBoardColumn(project: string, board: number, id: string): Promise<BoardColumnResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
- id
-
string
Identificador de columna.
Devoluciones
Promise<BoardColumnResponse>
getBoardColumns(string, number)
Obtener columnas en un panel.
function getBoardColumns(project: string, board: number): Promise<BoardColumnCollectionResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
Devoluciones
Promise<BoardColumnCollectionResponse>
getBoardItem(string, number, string)
Obtiene los datos del elemento de una sola placa.
function getBoardItem(project: string, board: number, id: string): Promise<BoardItemResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
- id
-
string
Identificador de elemento.
Devoluciones
Promise<BoardItemResponse>
getBoardItems(string, number)
Obtiene información de elementos de un panel según su identificador.
function getBoardItems(project: string, board: number): Promise<BoardItemCollectionResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
Devoluciones
Promise<BoardItemCollectionResponse>
getBoardRow(string, number, string)
Obtiene una fila dada su identificador y placa.
function getBoardRow(project: string, board: number, id: string): Promise<BoardRowResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
- id
-
string
Identificador de fila del panel.
Devoluciones
Promise<BoardRowResponse>
getBoardRows(string, number)
Obtiene las filas de un panel según su identificador.
function getBoardRows(project: string, board: number): Promise<BoardRowCollectionResponse>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador de la placa.
Devoluciones
Promise<BoardRowCollectionResponse>
getBoards(string, number, number)
Obtener tableros.
function getBoards(project: string, top?: number, skip?: number): Promise<BoardReference[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- top
-
number
Número máximo de paneles que se van a obtener.
- skip
-
number
Número de paneles que se van a omitir.
Devoluciones
Promise<BoardReference[]>
removeBoardItem(string, number, string)
Quita un elemento de un panel.
function removeBoardItem(project: string, board: number, id: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador del panel.
- id
-
string
Identificador de elemento de panel que se va a quitar.
Devoluciones
Promise<void>
updateBoard(UpdateBoard, string, number, String)
Novedades un tablero.
function updateBoard(updatedBoard: UpdateBoard, project: string, id: number, eTag: String): Promise<BoardResponse>Parámetros
- updatedBoard
- UpdateBoard
Nuevos datos de placa.
- project
-
string
Id. de proyecto o nombre del proyecto
- id
-
number
Id. del panel que se va a actualizar.
- eTag
-
String
Fecha de cambio más reciente del panel
Devoluciones
Promise<BoardResponse>
updateBoardColumn(BoardColumnUpdate, string, number, string, String)
Novedades una columna de panel.
function updateBoardColumn(boardColumn: BoardColumnUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardColumnResponse>Parámetros
- boardColumn
- BoardColumnUpdate
Datos de columna.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador del panel.
- id
-
string
Identificador de columna.
- eTag
-
String
Última fecha de modificación de la columna
Devoluciones
Promise<BoardColumnResponse>
updateBoardItem(UpdateBoardItem, string, number, string, String)
Novedades un solo elemento de un panel.
function updateBoardItem(updateItemDef: UpdateBoardItem, project: string, board: number, id: string, eTag: String): Promise<BoardItemResponse>Parámetros
- updateItemDef
- UpdateBoardItem
Datos de elementos actualizados.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador del panel.
- id
-
string
Actualice el identificador del elemento.
- eTag
-
String
Fecha de cambio más reciente del elemento
Devoluciones
Promise<BoardItemResponse>
updateBoardItems(BoardItemBatchOperation, string, number)
Realice una operación en un lote de elementos.
function updateBoardItems(batchRequest: BoardItemBatchOperation, project: string, board: number): Promise<BoardItemCollectionResponse>Parámetros
- batchRequest
- BoardItemBatchOperation
Datos que definen la operación por lotes.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador del panel que contiene los elementos.
Devoluciones
Promise<BoardItemCollectionResponse>
updateBoardRow(BoardRowUpdate, string, number, string, String)
Novedades una fila de panel.
function updateBoardRow(boardRow: BoardRowUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardRowResponse>Parámetros
- boardRow
- BoardRowUpdate
Datos de fila.
- project
-
string
Id. de proyecto o nombre del proyecto
- board
-
number
Identificador del panel.
- id
-
string
Identificador de fila.
- eTag
-
String
Fecha de modificación de fila más reciente
Devoluciones
Promise<BoardRowResponse>
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de