BoardsRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Extends

RestClientBase

Konstruktor

BoardsRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

addBoardItem(NewBoardItem, string, number)	Menambahkan satu item ke papan.
createBoard(CreateBoard, string)	Tambahkan papan baru untuk proyek.
createBoardColumn(BoardColumnCreate, string, number)	Membuat kolom baru di papan.
createBoardRow(BoardRowCreate, string, number)	Membuat baris baru di papan.
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)	Membuat sinkronisasi baru untuk kolom di papan.
deleteBoard(string, number)	Menghapus papan.
deleteBoardColumn(string, number, string, boolean)	Menghapus kolom dari papan.
deleteBoardRow(string, number, string, boolean)	Menghapus baris dari papan.
getBoard(string, number)	Mengembalikan informasi untuk papan yang diberikan pengidentifikasi uniknya.
getBoardColumn(string, number, string)	Mendapatkan data kolom untuk papan yang diberikan pengidentifikasinya.
getBoardColumns(string, number)	Mendapatkan kolom di papan.
getBoardItem(string, number, string)	Mendapatkan data untuk satu item papan.
getBoardItems(string, number)	Dapatkan informasi item untuk papan yang diberikan pengidentifikasinya.
getBoardRow(string, number, string)	Mendapatkan baris yang diberikan pengidentifikasi dan papannya.
getBoardRows(string, number)	Dapatkan baris di papan yang diberikan pengidentifikasinya.
getBoards(string, number, number)	Dapatkan papan.
removeBoardItem(string, number, string)	Menghapus item dari papan.
updateBoard(UpdateBoard, string, number, String)	Updates papan.
updateBoardColumn(BoardColumnUpdate, string, number, string, String)	Updates kolom papan.
updateBoardItem(UpdateBoardItem, string, number, string, String)	Updates satu item dalam papan.
updateBoardItems(BoardItemBatchOperation, string, number)	Lakukan operasi pada batch item.
updateBoardRow(BoardRowUpdate, string, number, string, String)	Updates baris papan.

Detail Konstruktor

BoardsRestClient(IVssRestClientOptions)

new BoardsRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addBoardItem(NewBoardItem, string, number)

Menambahkan satu item ke papan.

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

Parameter

item

NewBoardItem

Item yang akan ditambahkan ke papan.

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

Mengembalikan

Promise<BoardItemResponse>

createBoard(CreateBoard, string)

Tambahkan papan baru untuk proyek.

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

Parameter

postedBoard

CreateBoard

Definisi papan.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<BoardResponse>

createBoardColumn(BoardColumnCreate, string, number)

Membuat kolom baru di papan.

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

Parameter

boardColumn

BoardColumnCreate

Data kolom.

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

Mengembalikan

Promise<BoardColumnResponse>

createBoardRow(BoardRowCreate, string, number)

Membuat baris baru di papan.

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

Parameter

boardRow

BoardRowCreate

Data baris.

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

Mengembalikan

Promise<BoardRowResponse>

createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)

Membuat sinkronisasi baru untuk kolom di papan.

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

Parameter

boardSync

BoardItemStateSyncCreate

project

string

ID proyek atau nama proyek

board

number

column

string

Mengembalikan

Promise<BoardItemStateSync>

deleteBoard(string, number)

Menghapus papan.

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

Parameter

project

string

ID proyek atau nama proyek

id

number

Pengidentifikasi papan.

Mengembalikan

Promise<void>

deleteBoardColumn(string, number, string, boolean)

Menghapus kolom dari papan.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi kolom.

forceRemoveItems

boolean

Boolean menunjukkan apakah item akan dihapus secara paksa selama penghapusan kolom.

Mengembalikan

Promise<void>

deleteBoardRow(string, number, string, boolean)

Menghapus baris dari papan.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi baris.

forceRemoveItems

boolean

Boolean menunjukkan apakah item akan dihapus secara paksa selama penghapusan baris.

Mengembalikan

Promise<void>

getBoard(string, number)

Mengembalikan informasi untuk papan yang diberikan pengidentifikasi uniknya.

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

Parameter

project

string

ID proyek atau nama proyek

id

number

Pengidentifikasi unik papan.

Mengembalikan

Promise<BoardResponse>

getBoardColumn(string, number, string)

Mendapatkan data kolom untuk papan yang diberikan pengidentifikasinya.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi kolom.

Mengembalikan

Promise<BoardColumnResponse>

getBoardColumns(string, number)

Mendapatkan kolom di papan.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

Mengembalikan

Promise<BoardColumnCollectionResponse>

getBoardItem(string, number, string)

Mendapatkan data untuk satu item papan.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi item.

Mengembalikan

Promise<BoardItemResponse>

getBoardItems(string, number)

Dapatkan informasi item untuk papan yang diberikan pengidentifikasinya.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

Mengembalikan

Promise<BoardItemCollectionResponse>

getBoardRow(string, number, string)

Mendapatkan baris yang diberikan pengidentifikasi dan papannya.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi baris papan.

Mengembalikan

Promise<BoardRowResponse>

getBoardRows(string, number)

Dapatkan baris di papan yang diberikan pengidentifikasinya.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

Mengembalikan

Promise<BoardRowCollectionResponse>

getBoards(string, number, number)

Dapatkan papan.

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

Parameter

project

string

ID proyek atau nama proyek

top

number

Jumlah maksimum papan yang akan didapatkan.

skip

number

Jumlah papan yang akan dilewati.

Mengembalikan

Promise<BoardReference[]>

removeBoardItem(string, number, string)

Menghapus item dari papan.

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

Parameter

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi Item Papan untuk dihapus.

Mengembalikan

Promise<void>

updateBoard(UpdateBoard, string, number, String)

Updates papan.

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

Parameter

updatedBoard

UpdateBoard

Data papan baru.

project

string

ID proyek atau nama proyek

id

number

Id papan yang akan diperbarui.

eTag

String

Tanggal Perubahan Papan Terbaru

Mengembalikan

Promise<BoardResponse>

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

Updates kolom papan.

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

Parameter

boardColumn

BoardColumnUpdate

Data kolom.

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi kolom.

eTag

String

Kolom Tanggal Diubah Terbaru

Mengembalikan

Promise<BoardColumnResponse>

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

Updates satu item dalam papan.

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

Parameter

updateItemDef

UpdateBoardItem

Data item yang diperbarui.

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Memperbarui id item.

eTag

String

Item Tanggal Diubah Terbaru

Mengembalikan

Promise<BoardItemResponse>

updateBoardItems(BoardItemBatchOperation, string, number)

Lakukan operasi pada batch item.

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

Parameter

batchRequest

BoardItemBatchOperation

Data yang menentukan operasi batch.

project

string

ID proyek atau nama proyek

board

number

Id papan yang berisi item.

Mengembalikan

Promise<BoardItemCollectionResponse>

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

Updates baris papan.

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

Parameter

boardRow

BoardRowUpdate

Data baris.

project

string

ID proyek atau nama proyek

board

number

Pengidentifikasi papan.

id

string

Pengidentifikasi baris.

eTag

String

Tanggal Diubah Baris Terbaru

Mengembalikan

Promise<BoardRowResponse>