TfvcRestClient class

new TfvcRestClient(options: IVssRestClientOptions)

参数

static RESOURCE_AREA_ID: string

属性值

创建新的变更集。

function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>

参数

返回

返回给定的变更集 ID 列表的更改集。

function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>

参数

返回

获取给定路径上的单个分支层次结构，其中指定了父级或子级。

function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>

参数

返回

获取分支根的集合 -- 一级子级，没有父级的分支。

function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>

参数

返回

获取指定 scopePath 下方的分支层次结构

function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>

参数

返回

检索 Tfvc 更改集

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>

参数

返回

检索给定更改集的 Tfvc 更改。

function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>

参数

返回

检索 Tfvc 更改集

function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>

参数

返回

检索与特定变更集关联的工作项。

function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>

参数

返回

获取单个项的项元数据和/或内容。 下载参数是指示内容应作为下载提供，还是只是作为响应中的流发送。 不适用于始终作为下载返回的压缩内容。

function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>

参数

返回

获取单个项的项元数据和/或内容。 下载参数是指示内容应作为下载提供，还是只是作为响应中的流发送。 不适用于始终作为下载返回的压缩内容。

function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

参数

返回

获取 Tfvc 项的列表

function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>

参数

返回

在给定路径列表或长路径的情况下检索一组项的帖子。 允许为每个路径指定递归Level 和版本描述符。

function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>

参数

返回

在给定路径列表或长路径的情况下检索一组项的帖子。 允许为每个路径指定递归Level 和版本描述符。

function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>

参数

返回

获取单个项的项元数据和/或内容。 下载参数是指示内容应作为下载提供，还是只是作为响应中的流发送。 不适用于始终作为下载返回的压缩内容。

function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>

参数

返回

获取单个项的项元数据和/或内容。 下载参数是指示内容应作为下载提供，还是只是作为响应中的流发送。 不适用于始终作为下载返回的压缩内容。

function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

参数

返回

获取单个深层标签。

function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>

参数

返回

获取标签下的项目。

function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>

参数

返回

获取浅表标签引用的集合。

function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>

参数

返回

获取单个深层货架集。

function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>

参数

返回

获取货架集中包含的更改。

function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>

参数

返回

返回浅架集引用的集合。

function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>

参数

返回

获取与货架集关联的工作项。

function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>

参数

返回

在 TFVC 的特定范围内为集合/项目提供文件计数和未压缩的字节数。

function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>

参数

返回