BoardsRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

BoardsRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addBoardItem(NewBoardItem, string, number)	Добавляет один элемент на доску.
createBoard(CreateBoard, string)	Добавьте новую доску для проекта.
createBoardColumn(BoardColumnCreate, string, number)	Создает новый столбец на доске.
createBoardRow(BoardRowCreate, string, number)	Создает новую строку на доске.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Создает новую синхронизацию для столбца на доске.
deleteBoard(string, number)	Удаляет доску.
deleteBoardColumn(string, number, string, boolean)	Удаляет столбец с доски.
deleteBoardRow(string, number, string, boolean)	Удаляет строку с доски.
getBoard(string, number)	Возвращает сведения для доски с учетом ее уникального идентификатора.
getBoardColumn(string, number, string)	Возвращает данные столбца для доски по заданному идентификатору.
getBoardColumns(string, number)	Получение столбцов на доске.
getBoardItem(string, number, string)	Возвращает данные для элемента одной доски.
getBoardItems(string, number)	Получение сведений об элементах для доски по заданному идентификатору.
getBoardRow(string, number, string)	Возвращает строку, заданную ее идентификатором и доской.
getBoardRows(string, number)	Получение строк на доске по заданному идентификатору.
getBoards(string, number, number)	Получение досок.
removeBoardItem(string, number, string)	Удаляет элемент с доски.
updateBoard(UpdateBoard, string, number, String)	Обновления доску.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Обновления столбец доски.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Обновления один элемент на доске.
updateBoardItems(BoardItemBatchOperation, string, number)	Выполните операцию с пакетом элементов.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Обновления ряд доски.

Сведения о конструкторе

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addBoardItem(NewBoardItem, string, number)

Добавляет один элемент на доску.

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

Параметры

item

NewBoardItem

Элемент, добавляемый на доску.

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

Возвращаемое значение

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Добавьте новую доску для проекта.

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

Параметры

postedBoard

CreateBoard

Определение доски.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Создает новый столбец на доске.

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

Параметры

boardColumn

BoardColumnCreate

Данные столбца.

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

Возвращаемое значение

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Создает новую строку на доске.

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

Параметры

boardRow

BoardRowCreate

Данные строк.

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

Возвращаемое значение

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Создает новую синхронизацию для столбца на доске.

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

Параметры

boardSync

BoardItemStateSyncCreate

project

string

Идентификатор проекта или имя проекта

board

number

column

string

Возвращаемое значение

Promise<BoardItemStateSync>

deleteBoard(string, number)

Удаляет доску.

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

Параметры

project

string

Идентификатор проекта или имя проекта

id

number

Идентификатор платы.

Возвращаемое значение

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Удаляет столбец с доски.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор столбца.

forceRemoveItems

boolean

Логическое значение, указывающее, следует ли принудительно удалять элементы во время удаления столбца.

Возвращаемое значение

Promise<void>

deleteBoardRow(string, number, string, boolean)

Удаляет строку с доски.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор строки.

forceRemoveItems

boolean

Логическое значение, указывающее, следует ли принудительно удалять элементы во время удаления строки.

Возвращаемое значение

Promise<void>

getBoard(string, number)

Возвращает сведения для доски с учетом ее уникального идентификатора.

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

Параметры

project

string

Идентификатор проекта или имя проекта

id

number

Уникальный идентификатор платы.

Возвращаемое значение

Promise<BoardResponse>

getBoardColumn(string, number, string)

Возвращает данные столбца для доски по заданному идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор столбца.

Возвращаемое значение

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Получение столбцов на доске.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

Возвращаемое значение

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Возвращает данные для элемента одной доски.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор элемента.

Возвращаемое значение

Promise<BoardItemResponse>

getBoardItems(string, number)

Получение сведений об элементах для доски по заданному идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

Возвращаемое значение

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Возвращает строку, заданную ее идентификатором и доской.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор строки доски.

Возвращаемое значение

Promise<BoardRowResponse>

getBoardRows(string, number)

Получение строк на доске по заданному идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

board

number

Идентификатор платы.

Возвращаемое значение

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Получение досок.

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

Параметры

project

string

Идентификатор или имя проекта

top

number

Максимальное количество досок для получения.

skip

number

Количество пропущенных досок.

Возвращаемое значение

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Удаляет элемент с доски.

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

Параметры

project

string

Идентификатор или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор элемента доски для удаления.

Возвращаемое значение

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Обновления доску.

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

Параметры

updatedBoard

UpdateBoard

Новые данные платы.

project

string

Идентификатор или имя проекта

id

number

Идентификатор обновляемой платы.

eTag

String

Дата последнего изменения платы

Возвращаемое значение

Promise<BoardResponse>

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

Обновления столбец доски.

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

Параметры

boardColumn

BoardColumnUpdate

Данные столбца.

project

string

Идентификатор или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор столбца.

eTag

String

Дата последнего изменения столбца

Возвращаемое значение

Promise<BoardColumnResponse>

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

Обновления один элемент на доске.

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

Параметры

updateItemDef

UpdateBoardItem

Обновлены данные элемента.

project

string

Идентификатор или имя проекта

board

number

Идентификатор платы.

id

string

Обновление идентификатора элемента.

eTag

String

Дата последнего изменения элемента

Возвращаемое значение

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Выполните операцию с пакетом элементов.

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

Параметры

batchRequest

BoardItemBatchOperation

Данные, определяющие пакетную операцию.

project

string

Идентификатор или имя проекта

board

number

Идентификатор доски, содержащей элементы.

Возвращаемое значение

Promise<BoardItemCollectionResponse>

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

Обновления ряд доски.

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

Параметры

boardRow

BoardRowUpdate

Данные строк.

project

string

Идентификатор или имя проекта

board

number

Идентификатор платы.

id

string

Идентификатор строки.

eTag

String

Дата последнего изменения строки

Возвращаемое значение

Promise<BoardRowResponse>