BoardsRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

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>