BoardsRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

BoardsRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

addBoardItem(NewBoardItem, string, number)	Panoya tek bir öğe ekler.
createBoard(CreateBoard, string)	Proje için yeni bir pano ekleyin.
createBoardColumn(BoardColumnCreate, string, number)	Panoda yeni bir sütun oluşturur.
createBoardRow(BoardRowCreate, string, number)	Panoda yeni bir satır oluşturur.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Panodaki bir sütun için yeni bir senkronizasyon oluşturur.
deleteBoard(string, number)	Bir panoyu siler.
deleteBoardColumn(string, number, string, boolean)	Panodan bir sütunu siler.
deleteBoardRow(string, number, string, boolean)	Panodan bir satırı siler.
getBoard(string, number)	Benzersiz tanımlayıcısı verilen bir pano için bilgi döndürür.
getBoardColumn(string, number, string)	Tanımlayıcısı verilen bir pano için sütun verilerini alır.
getBoardColumns(string, number)	Bir panoda sütunlar alın.
getBoardItem(string, number, string)	Tek bir panonun öğesi için veri alır.
getBoardItems(string, number)	Tanımlayıcısı verilen bir pano için öğe bilgilerini alın.
getBoardRow(string, number, string)	Tanımlayıcısı ve panosu verilen bir satırı alır.
getBoardRows(string, number)	Tanımlayıcısı verilen bir panodaki satırları alın.
getBoards(string, number, number)	Panoları alın.
removeBoardItem(string, number, string)	Panodan bir öğeyi kaldırır.
updateBoard(UpdateBoard, string, number, String)	Bir panoyu günceller.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Bir pano sütununu günceller.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Panodaki tek bir öğeyi günceller.
updateBoardItems(BoardItemBatchOperation, string, number)	Bir grup öğe üzerinde bir işlem yapın.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Pano satırını güncelleştirir.

Oluşturucu Ayrıntıları

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

addBoardItem(NewBoardItem, string, number)

Panoya tek bir öğe ekler.

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

Parametreler

item

NewBoardItem

Panoya eklenecek öğe.

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

Döndürülenler

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Proje için yeni bir pano ekleyin.

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

Parametreler

postedBoard

CreateBoard

Pano tanımı.

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Panoda yeni bir sütun oluşturur.

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

Parametreler

boardColumn

BoardColumnCreate

Sütun verileri.

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

Döndürülenler

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Panoda yeni bir satır oluşturur.

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

Parametreler

boardRow

BoardRowCreate

Satır verileri.

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

Döndürülenler

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Panodaki bir sütun için yeni bir senkronizasyon oluşturur.

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

Parametreler

boardSync

BoardItemStateSyncCreate

project

string

Proje kimliği veya proje adı

board

number

column

string

Döndürülenler

Promise<BoardItemStateSync>

deleteBoard(string, number)

Bir panoyu siler.

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

Parametreler

project

string

Proje kimliği veya proje adı

id

number

Pano tanımlayıcısı.

Döndürülenler

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Panodan bir sütunu siler.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Sütun tanımlayıcısı.

forceRemoveItems

boolean

Sütun silme işlemi sırasında öğelerin zorla kaldırılıp kaldırılmayacağını gösteren Boole.

Döndürülenler

Promise<void>

deleteBoardRow(string, number, string, boolean)

Panodan bir satırı siler.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Satır tanımlayıcısı.

forceRemoveItems

boolean

Satır silme işlemi sırasında öğelerin zorla kaldırılıp kaldırılmayacağını belirten Boolean.

Döndürülenler

Promise<void>

getBoard(string, number)

Benzersiz tanımlayıcısı verilen bir pano için bilgi döndürür.

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

Parametreler

project

string

Proje kimliği veya proje adı

id

number

Kurulun benzersiz tanımlayıcısı.

Döndürülenler

Promise<BoardResponse>

getBoardColumn(string, number, string)

Tanımlayıcısı verilen bir pano için sütun verilerini alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Sütun tanımlayıcısı.

Döndürülenler

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Bir panoda sütunlar alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

Döndürülenler

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Tek bir panonun öğesi için veri alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Öğe tanımlayıcısı.

Döndürülenler

Promise<BoardItemResponse>

getBoardItems(string, number)

Tanımlayıcısı verilen bir pano için öğe bilgilerini alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

Döndürülenler

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Tanımlayıcısı ve panosu verilen bir satırı alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Pano satırı tanımlayıcısı.

Döndürülenler

Promise<BoardRowResponse>

getBoardRows(string, number)

Tanımlayıcısı verilen bir panodaki satırları alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

Döndürülenler

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Panoları alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

top

number

Alınacak maksimum pano sayısı.

skip

number

Atlanacak pano sayısı.

Döndürülenler

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Panodan bir öğeyi kaldırır.

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

Parametreler

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Kaldırılacak Pano Öğesi tanımlayıcısı.

Döndürülenler

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Bir panoyu günceller.

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

Parametreler

updatedBoard

UpdateBoard

Yeni kart verileri.

project

string

Proje kimliği veya proje adı

id

number

Güncellenecek panonun kimliği.

eTag

String

Pano Son Değiştirilme Tarihi

Döndürülenler

Promise<BoardResponse>

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

Bir pano sütununu günceller.

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

Parametreler

boardColumn

BoardColumnUpdate

Sütun verileri.

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Sütun tanımlayıcısı.

eTag

String

En Son Değiştirilme Tarihi Sütunu

Döndürülenler

Promise<BoardColumnResponse>

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

Panodaki tek bir öğeyi günceller.

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

Parametreler

updateItemDef

UpdateBoardItem

Öğe verileri güncellendi.

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Öğe kimliğini güncelleyin.

eTag

String

Öğe Son Değiştirilme Tarihi

Döndürülenler

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Bir grup öğe üzerinde bir işlem yapın.

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

Parametreler

batchRequest

BoardItemBatchOperation

Toplu işlemi tanımlayan veriler.

project

string

Proje kimliği veya proje adı

board

number

Öğeleri içeren panonun kimliği.

Döndürülenler

Promise<BoardItemCollectionResponse>

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

Pano satırını güncelleştirir.

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

Parametreler

boardRow

BoardRowUpdate

Satır verileri.

project

string

Proje kimliği veya proje adı

board

number

Pano tanımlayıcısı.

id

string

Satır tanımlayıcısı.

eTag

String

Satır Son Değiştirilme Tarihi

Döndürülenler

Promise<BoardRowResponse>