BoardsRestClient class
VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス
- Extends
コンストラクター
| Boards |
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
BoardsRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringプロパティ値
string
メソッドの詳細
addBoardItem(NewBoardItem, string, number)
ボードに 1 つの項目を追加します。
function addBoardItem(item: NewBoardItem, project: string, board: number): Promise<BoardItemResponse>パラメーター
- item
- NewBoardItem
ボードに追加する項目。
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
戻り値
Promise<BoardItemResponse>
createBoard(CreateBoard, string)
プロジェクトの新しいボードを追加します。
function createBoard(postedBoard: CreateBoard, project: string): Promise<BoardResponse>パラメーター
- postedBoard
- CreateBoard
ボード定義。
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<BoardResponse>
createBoardColumn(BoardColumnCreate, string, number)
ボード上に新しい列を作成します。
function createBoardColumn(boardColumn: BoardColumnCreate, project: string, board: number): Promise<BoardColumnResponse>パラメーター
- boardColumn
- BoardColumnCreate
列データ。
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
戻り値
Promise<BoardColumnResponse>
createBoardRow(BoardRowCreate, string, number)
ボード上に新しい行を作成します。
function createBoardRow(boardRow: BoardRowCreate, project: string, board: number): Promise<BoardRowResponse>パラメーター
- boardRow
- BoardRowCreate
行データ。
- project
-
string
プロジェクト ID またはプロジェクト名
- 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
プロジェクト ID またはプロジェクト名
- board
-
number
- column
-
string
戻り値
Promise<BoardItemStateSync>
deleteBoard(string, number)
ボードを削除します。
function deleteBoard(project: string, id: number): Promise<void>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- id
-
number
ボード識別子。
戻り値
Promise<void>
deleteBoardColumn(string, number, string, boolean)
ボードから列を削除します。
function deleteBoardColumn(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- 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
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
行識別子。
- forceRemoveItems
-
boolean
行の削除中に項目を強制的に削除するかどうかを示すブール値。
戻り値
Promise<void>
getBoard(string, number)
一意の識別子を指定してボードの情報を返します。
function getBoard(project: string, id: number): Promise<BoardResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- id
-
number
ボードの一意識別子。
戻り値
Promise<BoardResponse>
getBoardColumn(string, number, string)
識別子が指定されたボードの列データを取得します。
function getBoardColumn(project: string, board: number, id: string): Promise<BoardColumnResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
列識別子。
戻り値
Promise<BoardColumnResponse>
getBoardColumns(string, number)
ボード内の列を取得します。
function getBoardColumns(project: string, board: number): Promise<BoardColumnCollectionResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
戻り値
Promise<BoardColumnCollectionResponse>
getBoardItem(string, number, string)
1 つのボードの項目のデータを取得します。
function getBoardItem(project: string, board: number, id: string): Promise<BoardItemResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
アイテム識別子。
戻り値
Promise<BoardItemResponse>
getBoardItems(string, number)
ボードの識別子を指定して、ボードのアイテム情報を取得します。
function getBoardItems(project: string, board: number): Promise<BoardItemCollectionResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
戻り値
Promise<BoardItemCollectionResponse>
getBoardRow(string, number, string)
識別子とボードを指定して行を取得します。
function getBoardRow(project: string, board: number, id: string): Promise<BoardRowResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
ボード行識別子。
戻り値
Promise<BoardRowResponse>
getBoardRows(string, number)
識別子が指定されたボード内の行を取得します。
function getBoardRows(project: string, board: number): Promise<BoardRowCollectionResponse>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
戻り値
Promise<BoardRowCollectionResponse>
getBoards(string, number, number)
ボードを取得します。
function getBoards(project: string, top?: number, skip?: number): Promise<BoardReference[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- top
-
number
取得するボードの最大数。
- skip
-
number
スキップするボードの数。
戻り値
Promise<BoardReference[]>
removeBoardItem(string, number, string)
ボードから項目を削除します。
function removeBoardItem(project: string, board: number, id: string): Promise<void>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- 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 またはプロジェクト名
- id
-
number
更新するボードの ID。
- 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
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
列識別子。
- eTag
-
String
列の最新の変更日
戻り値
Promise<BoardColumnResponse>
updateBoardItem(UpdateBoardItem, string, number, string, String)
ボード内の 1 つの項目を更新します。
function updateBoardItem(updateItemDef: UpdateBoardItem, project: string, board: number, id: string, eTag: String): Promise<BoardItemResponse>パラメーター
- updateItemDef
- UpdateBoardItem
アイテム データを更新しました。
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
アイテム ID を更新します。
- eTag
-
String
アイテムの最新の変更日
戻り値
Promise<BoardItemResponse>
updateBoardItems(BoardItemBatchOperation, string, number)
項目のバッチに対して操作を実行します。
function updateBoardItems(batchRequest: BoardItemBatchOperation, project: string, board: number): Promise<BoardItemCollectionResponse>パラメーター
- batchRequest
- BoardItemBatchOperation
バッチ操作を定義するデータ。
- project
-
string
プロジェクト ID またはプロジェクト名
- board
-
number
項目を含むボードの ID。
戻り値
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
プロジェクト ID またはプロジェクト名
- board
-
number
ボード識別子。
- id
-
string
行識別子。
- eTag
-
String
行の最新の変更日
戻り値
Promise<BoardRowResponse>