BoardsRestClient class

Pakiet:

azure-devops-extension-api

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

Rozszerzenie

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ę do 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 kolumny dla tablicy, biorąc pod uwagę jej identyfikator.
getBoardColumns(string, number)	Pobieranie kolumn na tablicy.
getBoardItem(string, number, string)	Pobiera dane dla pojedynczego elementu tablicy.
getBoardItems(string, number)	Uzyskaj informacje o elementach dla tablicy, biorąc pod uwagę jej identyfikator.
getBoardRow(string, number, string)	Pobiera wiersz ze względu na jego identyfikator i tablicę.
getBoardRows(string, number)	Pobierz wiersze na tablicy, biorąc pod uwagę jej identyfikator.
getBoards(string, number, number)	Zdobądź tablice.
removeBoardItem(string, number, string)	Usuwa przedmiot z tablicy.
updateBoard(UpdateBoard, string, number, String)	Aktualizuje tablicę.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Aktualizuje kolumnę tablicy.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Aktualizuje pojedynczy element na tablicy.
updateBoardItems(BoardItemBatchOperation, string, number)	Wykonaj operację na partii elementów.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Aktualizuje 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

Przedmiot do dodania do tablicy.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

Zwraca

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Dodaj nową tablicę do 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 kolumny.

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 wiersza.

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ć wymuszone 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ć wymuszone 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

Niepowtarzalny identyfikator Rady.

Zwraca

Promise<BoardResponse>

getBoardColumn(string, number, string)

Pobiera dane kolumny dla tablicy, biorąc pod uwagę jej identyfikator.

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 pojedynczego elementu 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)

Uzyskaj informacje o elementach dla tablicy, biorąc pod uwagę jej identyfikator.

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 ze względu na jego identyfikator 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ę jej 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)

Zdobądź tablice.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

top

number

Maksymalna liczba desek do zdobycia.

skip

number

Liczba desek do pominięcia.

Zwraca

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Usuwa przedmiot 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)

Aktualizuje tablicę.

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

Parametry

updatedBoard

UpdateBoard

Nowe dane płyty.

project

string

Identyfikator projektu lub nazwa projektu

id

number

Identyfikator tablicy do aktualizacji.

eTag

String

Ostatnia data zmiany tablicy

Zwraca

Promise<BoardResponse>

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

Aktualizuje kolumnę tablicy.

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

Parametry

boardColumn

BoardColumnUpdate

Dane kolumny.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator kolumny.

eTag

String

Kolumna Najpóźniejsza data zmiany

Zwraca

Promise<BoardColumnResponse>

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

Aktualizuje pojedynczy element na tablicy.

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

Parametry

updateItemDef

UpdateBoardItem

Zaktualizowano dane przedmiotu.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Zaktualizuj identyfikator elementu.

eTag

String

Ostatnia data zmiany przedmiotu

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 działanie wsadowe.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy zawierającej elementy.

Zwraca

Promise<BoardItemCollectionResponse>

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

Aktualizuje wiersz tablicy.

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

Parametry

boardRow

BoardRowUpdate

Dane wiersza.

project

string

Identyfikator projektu lub nazwa projektu

board

number

Identyfikator tablicy.

id

string

Identyfikator wiersza.

eTag

String

Najpóźniejsza data zmiany wiersza

Zwraca

Promise<BoardRowResponse>