BoardsRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

BoardsRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

addBoardItem(NewBoardItem, string, number)	Dodaje pojedynczy element do tablicy.
createBoard(CreateBoard, string)	Dodaj nową tablicę dla projektu.
createBoardColumn(BoardColumnCreate, string, number)	Tworzy nową kolumnę na tablicy.
createBoardRow(BoardRowCreate, string, number)	Tworzy nowy wiersz na tablicy.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Tworzy nową synchronizację dla kolumny na tablicy.
deleteBoard(string, number)	Usuwa tablicę.
deleteBoardColumn(string, number, string, boolean)	Usuwa kolumnę z tablicy.
deleteBoardRow(string, number, string, boolean)	Usuwa wiersz z tablicy.
getBoard(string, number)	Zwraca informacje dla tablicy, biorąc pod uwagę jej unikatowy identyfikator.
getBoardColumn(string, number, string)	Pobiera dane kolumn dla tablicy z danym jego identyfikatorem.
getBoardColumns(string, number)	Pobieranie kolumn na tablicy.
getBoardItem(string, number, string)	Pobiera dane dla elementu pojedynczej tablicy.
getBoardItems(string, number)	Pobierz informacje o elementach dla tablicy z danym jego identyfikatorem.
getBoardRow(string, number, string)	Pobiera wiersz z identyfikatorem i tablicą.
getBoardRows(string, number)	Pobierz wiersze na tablicy, biorąc pod uwagę jego identyfikator.
getBoards(string, number, number)	Pobierz tablice.
removeBoardItem(string, number, string)	Usuwa element z tablicy.
updateBoard(UpdateBoard, string, number, String)	Aktualizacje tablicę.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Aktualizacje kolumnę tablicy.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Aktualizacje pojedynczy element na tablicy.
updateBoardItems(BoardItemBatchOperation, string, number)	Wykonaj operację na partii elementów.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Aktualizacje wiersz tablicy.

Szczegóły konstruktora

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

addBoardItem(NewBoardItem, string, number)

Dodaje pojedynczy element do tablicy.

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

Parametry

item

NewBoardItem

Element do dodania do tablicy.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Dodaj nową tablicę dla projektu.

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

Parametry

postedBoard

CreateBoard

Definicja tablicy.

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Tworzy nową kolumnę na tablicy.

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

Parametry

boardColumn

BoardColumnCreate

Dane kolumn.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Tworzy nowy wiersz na tablicy.

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

Parametry

boardRow

BoardRowCreate

Dane wierszy.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Tworzy nową synchronizację dla kolumny na tablicy.

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

Parametry

boardSync

BoardItemStateSyncCreate

project

string

Identyfikator projektu lub nazwa projektu

board

number

column

string

Zwraca

Promise<BoardItemStateSync>

deleteBoard(string, number)

Usuwa tablicę.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

id

number

Identyfikator tablicy.

Zwraca

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Usuwa kolumnę z tablicy.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator kolumny.

forceRemoveItems

boolean

Wartość logiczna wskazująca, czy elementy mają zostać wymusić usunięcie podczas usuwania kolumny.

Zwraca

Promise<void>

deleteBoardRow(string, number, string, boolean)

Usuwa wiersz z tablicy.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator wiersza.

forceRemoveItems

boolean

Wartość logiczna wskazująca, czy elementy mają zostać wymusić usunięcie podczas usuwania wiersza.

Zwraca

Promise<void>

getBoard(string, number)

Zwraca informacje dla tablicy, biorąc pod uwagę jej unikatowy identyfikator.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

id

number

Unikatowy identyfikator tablicy.

Zwraca

Promise<BoardResponse>

getBoardColumn(string, number, string)

Pobiera dane kolumn dla tablicy z danym jego identyfikatorem.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator kolumny.

Zwraca

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Pobieranie kolumn na tablicy.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Pobiera dane dla elementu pojedynczej tablicy.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator elementu.

Zwraca

Promise<BoardItemResponse>

getBoardItems(string, number)

Pobierz informacje o elementach dla tablicy z danym jego identyfikatorem.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Pobiera wiersz z identyfikatorem i tablicą.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator wiersza tablicy.

Zwraca

Promise<BoardRowResponse>

getBoardRows(string, number)

Pobierz wiersze na tablicy, biorąc pod uwagę jego identyfikator.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Pobierz tablice.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

top

number

Maksymalna liczba tablic do pobrania.

skip

number

Liczba tablic do pominięcia.

Zwraca

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Usuwa element z tablicy.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator elementu tablicy do usunięcia.

Zwraca

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Aktualizacje tablicę.

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

Parametry

updatedBoard

UpdateBoard

Nowe dane tablicy.

project

string

Identyfikator projektu lub nazwa projektu

id

number

Identyfikator tablicy do zaktualizowania.

eTag

String

Data najnowszej zmiany tablicy

Zwraca

Promise<BoardResponse>

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

Aktualizacje kolumnę tablicy.

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

Parametry

boardColumn

BoardColumnUpdate

Dane kolumn.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator kolumny.

eTag

String

Data najnowszej zmiany kolumny

Zwraca

Promise<BoardColumnResponse>

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

Aktualizacje pojedynczy element na tablicy.

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

Parametry

updateItemDef

UpdateBoardItem

Zaktualizowane dane elementu.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Zaktualizuj identyfikator elementu.

eTag

String

Data najnowszej zmiany elementu

Zwraca

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Wykonaj operację na partii elementów.

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

Parametry

batchRequest

BoardItemBatchOperation

Dane definiujące operację wsadową.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy zawierającej elementy.

Zwraca

Promise<BoardItemCollectionResponse>

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

Aktualizacje wiersz tablicy.

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

Parametry

boardRow

BoardRowUpdate

Dane wierszy.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator wiersza.

eTag

String

Data najnowszej zmiany wiersza

Zwraca

Promise<BoardRowResponse>