TfvcRestClient class
VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス
- Extends
コンストラクター
| Tfvc |
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
TfvcRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringプロパティ値
string
メソッドの詳細
createChangeset(TfvcChangeset, string)
新しい変更セットを作成します。
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>パラメーター
- changeset
- TfvcChangeset
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
変更セット ID の指定されたリストの変更セットを返します。
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>パラメーター
- changesetsRequestData
- TfvcChangesetsRequestData
変更セット ID の一覧。
戻り値
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
指定されたパスで、指定した親または子を含む単一ブランチ階層を取得します。
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>パラメーター
- path
-
string
ブランチへの完全なパス。 既定値: $/ 例: $/、$/MyProject、$/MyProject/SomeFolder。
- project
-
string
プロジェクト ID またはプロジェクト名
- includeParent
-
boolean
親ブランチがある場合は、そのブランチを返します。 既定値はFalse
- includeChildren
-
boolean
子ブランチがある場合は、そのブランチを返します。 既定値はFalse
戻り値
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
ブランチ ルートのコレクション (第 1 レベルの子、親のないブランチ) を取得します。
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- includeParent
-
boolean
親ブランチがある場合は、そのブランチを返します。 既定値はFalse
- includeChildren
-
boolean
各ルート ブランチの子ブランチを返します。 既定値はFalse
- includeDeleted
-
boolean
削除されたブランチを返します。 既定値はFalse
- includeLinks
-
boolean
リンクを返します。 既定値はFalse
戻り値
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
指定した scopePath の下にあるブランチ階層を取得する
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>パラメーター
- scopePath
-
string
ブランチへの完全なパス。 既定値: $/ 例: $/、$/MyProject、$/MyProject/SomeFolder。
- project
-
string
プロジェクト ID またはプロジェクト名
- includeDeleted
-
boolean
削除されたブランチを返します。 既定値はFalse
- includeLinks
-
boolean
リンクを返します。 既定値はFalse
戻り値
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Tfvc Changeset を取得する
function getChangeset(id: number, project?: string, maxChangeCount?: number, includeDetails?: boolean, includeWorkItems?: boolean, maxCommentLength?: number, includeSourceRename?: boolean, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangeset>パラメーター
- id
-
number
取得する変更セット ID。
- project
-
string
プロジェクト ID またはプロジェクト名
- maxChangeCount
-
number
返す変更の数 (最大 100 件の変更) 既定値: 0
- includeDetails
-
boolean
応答にポリシーの詳細とチェックノートを含めます。 既定値: false
- includeWorkItems
-
boolean
作業項目を含めます。 既定値: false
- maxCommentLength
-
number
関連する作業項目に関する詳細を応答に含めます。 既定値: null
- includeSourceRename
-
boolean
名前の変更を含めます。 既定値: false
- skip
-
number
スキップする結果の数。 既定値: null
- top
-
number
返される結果の最大数。 既定値: null
- orderby
-
string
既定では、結果は ID で降順に並べ替えられます。 ID asc を使用して、ID を昇順で並べ替えます。
- searchCriteria
- TfvcChangesetSearchCriteria
次の条件 (.itemPath、.version、.versionType、.versionOption、.author、.fromId、.toId、.fromDate、.toDate) Default: null
戻り値
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
特定の変更セットの Tfvc 変更を取得します。
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>パラメーター
- id
-
number
変更セットの ID。 既定値: null
- skip
-
number
スキップする結果の数。 既定値: null
- top
-
number
返される結果の最大数。 既定値: null
戻り値
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Tfvc 変更セットを取得する
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- maxCommentLength
-
number
関連する作業項目に関する詳細を応答に含めます。 既定値: null
- skip
-
number
スキップする結果の数。 既定値: null
- top
-
number
返される結果の最大数。 既定値: null
- orderby
-
string
既定では、結果は ID で降順に並べ替えられます。 ID asc を使用して、ID を昇順で並べ替えます。
- searchCriteria
- TfvcChangesetSearchCriteria
次の条件 (.itemPath、.version、.versionType、.versionOption、.author、.fromId、.toId、.fromDate、.toDate) Default: null
戻り値
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
特定の変更セットに関連付けられている作業項目を取得します。
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>パラメーター
- id
-
number
変更セットの ID。
戻り値
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
1 つのアイテムのアイテム メタデータやコンテンツを取得します。 download パラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 常にダウンロードとして返される zip 形式のコンテンツには適用されません。
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>パラメーター
- path
-
string
返す個々の項目のバージョン管理パス。
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
返されるアイテムのファイル名。
- download
-
boolean
true の場合は、ダウンロード可能な添付ファイルを作成します。
- scopePath
-
string
複数の項目を返すフォルダーのバージョン 管理パス。
- recursionLevel
- VersionControlRecursionType
None (アイテムのみ)、または OneLevel (フォルダーの内容)。
- versionDescriptor
- TfvcVersionDescriptor
バージョン記述子。 既定値は Null です。
- includeContent
-
boolean
json を要求するときに項目の内容を含めるには、true に設定します。 既定値は false です。
戻り値
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
1 つのアイテムのアイテム メタデータやコンテンツを取得します。 download パラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 常にダウンロードとして返される zip 形式のコンテンツには適用されません。
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>パラメーター
- path
-
string
返す個々の項目のバージョン管理パス。
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
返されるアイテムのファイル名。
- download
-
boolean
true の場合は、ダウンロード可能な添付ファイルを作成します。
- scopePath
-
string
複数の項目を返すフォルダーのバージョン 管理パス。
- recursionLevel
- VersionControlRecursionType
None (アイテムのみ)、または OneLevel (フォルダーの内容)。
- versionDescriptor
- TfvcVersionDescriptor
バージョン記述子。 既定値は Null です。
- includeContent
-
boolean
json を要求するときに項目の内容を含めるには、true に設定します。 既定値は false です。
戻り値
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Tfvc 項目の一覧を取得する
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- scopePath
-
string
複数の項目を返すフォルダーのバージョン 管理パス。
- recursionLevel
- VersionControlRecursionType
None (アイテムのみ)、または OneLevel (フォルダーの内容)。
- includeLinks
-
boolean
True を指定すると、リンクが含まれます。
- versionDescriptor
- TfvcVersionDescriptor
戻り値
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
パスの一覧または長いパスが指定された一連の項目を取得するための Post。 各パスの recursionLevel 記述子とバージョン記述子を指定できます。
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>パラメーター
- itemRequestData
- TfvcItemRequestData
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
パスの一覧または長いパスが指定された一連の項目を取得するための Post。 各パスの recursionLevel 記述子とバージョン記述子を指定できます。
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>パラメーター
- itemRequestData
- TfvcItemRequestData
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
1 つのアイテムのアイテム メタデータやコンテンツを取得します。 download パラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 常にダウンロードとして返される zip 形式のコンテンツには適用されません。
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>パラメーター
- path
-
string
返す個々の項目のバージョン管理パス。
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
返されるアイテムのファイル名。
- download
-
boolean
true の場合は、ダウンロード可能な添付ファイルを作成します。
- scopePath
-
string
複数の項目を返すフォルダーのバージョン 管理パス。
- recursionLevel
- VersionControlRecursionType
None (アイテムのみ)、または OneLevel (フォルダーの内容)。
- versionDescriptor
- TfvcVersionDescriptor
バージョン記述子。 既定値は Null です。
- includeContent
-
boolean
json を要求するときに項目の内容を含めるには、true に設定します。 既定値は false です。
戻り値
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
1 つのアイテムのアイテム メタデータやコンテンツを取得します。 download パラメーターは、コンテンツをダウンロードとして使用できるようにするか、応答でストリームとして送信するかを示します。 常にダウンロードとして返される zip 形式のコンテンツには適用されません。
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>パラメーター
- path
-
string
返す個々の項目のバージョン管理パス。
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
返されるアイテムのファイル名。
- download
-
boolean
true の場合は、ダウンロード可能な添付ファイルを作成します。
- scopePath
-
string
複数の項目を返すフォルダーのバージョン 管理パス。
- recursionLevel
- VersionControlRecursionType
None (アイテムのみ)、または OneLevel (フォルダーの内容)。
- versionDescriptor
- TfvcVersionDescriptor
バージョン記述子。 既定値は Null です。
- includeContent
-
boolean
json を要求するときに項目の内容を含めるには、true に設定します。 既定値は false です。
戻り値
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
1 つのディープ ラベルを取得します。
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>パラメーター
- labelId
-
string
ラベルの一意識別子
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<TfvcLabel>
getLabelItems(string, number, number)
ラベルの下にあるアイテムを取得します。
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>パラメーター
- labelId
-
string
ラベルの一意識別子
- top
-
number
返されるアイテムの最大数
- skip
-
number
スキップする項目の数
戻り値
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
シャロー ラベル参照のコレクションを取得します。
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>パラメーター
- requestData
- TfvcLabelRequestData
labelScope、name、owner、itemLabelFilter
- project
-
string
プロジェクト ID またはプロジェクト名
- top
-
number
返されるラベルの最大数。未定義の場合、既定値は 100 です
- skip
-
number
スキップするラベルの数
戻り値
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
1 つの深いシェルブセットを取得します。
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>パラメーター
- shelvesetId
-
string
シェルブセットの一意の ID
- requestData
- TfvcShelvesetRequestData
includeDetails、includeWorkItems、maxChangeCount、maxCommentLength
戻り値
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
シェルブセットに含まれる変更を取得します。
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>パラメーター
- shelvesetId
-
string
シェルブセットの一意の ID
- top
-
number
返される変更の最大数
- skip
-
number
スキップする変更の数
戻り値
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
シャロー シェルブセット参照のコレクションを返します。
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>パラメーター
- requestData
- TfvcShelvesetRequestData
name、owner、maxCommentLength
- top
-
number
返されるシェルブセットの最大数
- skip
-
number
スキップするシェルブセットの数
戻り値
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
シェルブセットに関連付けられている作業項目を取得します。
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>パラメーター
- shelvesetId
-
string
シェルブセットの一意の ID
戻り値
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
TFVC の特定のスコープにあるコレクション/プロジェクトのファイル数と圧縮されていないバイト数を提供します。
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- scopePath
-
string
コレクションの場合は '$/'、特定のプロジェクトの場合は '$/project'
戻り値
Promise<TfvcStatistics>