TfvcRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

TfvcRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

createChangeset(TfvcChangeset, string)	Создайте новый набор изменений.
getBatchedChangesets(TfvcChangesetsRequestData)	Возвращает наборы изменений для заданного списка идентификаторов наборов изменений.
getBranch(string, string, boolean, boolean)	Получите одну иерархию ветвей по заданному пути с родительскими или дочерними ветвями, как указано.
getBranches(string, boolean, boolean, boolean, boolean)	Получите коллекцию корней ветвей -- дочерних ветвей первого уровня, ветвей без родителей.
getBranchRefs(string, string, boolean, boolean)	Получение иерархий ветвей ниже указанного scopePath
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Получение набора правок Tfvc
getChangesetChanges(number, number, number)	Получение изменений Tfvc для заданного набора изменений.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Получение наборов изменений Tfvc
getChangesetWorkItems(number)	Извлекает рабочие элементы, связанные с определенным набором изменений.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Получить список элементов Tfvc
getItemsBatch(TfvcItemRequestData, string)	Пост для извлечения набора элементов с заданным списком путей или длинным путем. Позволяет указать recursionLevel и дескрипторы версии для каждого пути.
getItemsBatchZip(TfvcItemRequestData, string)	Пост для извлечения набора элементов с заданным списком путей или длинным путем. Позволяет указать recursionLevel и дескрипторы версии для каждого пути.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.
getLabel(string, TfvcLabelRequestData, string)	Получите одну глубокую этикетку.
getLabelItems(string, number, number)	Приобретайте товары под этикеткой.
getLabels(TfvcLabelRequestData, string, number, number)	Получите коллекцию поверхностных ссылок на этикетки.
getShelveset(string, TfvcShelvesetRequestData)	Получите один глубокий набор полочных шкафов.
getShelvesetChanges(string, number, number)	Получите изменения, включенные в набор отложенных изменений.
getShelvesets(TfvcShelvesetRequestData, number, number)	Возврат коллекции поверхностных ссылок на набор отложенных изменений.
getShelvesetWorkItems(string)	Получите рабочие элементы, связанные с набором отложенных изменений.
getTfvcStatistics(string, string)	Предоставляет количество файлов и несжатых байтов для коллекции/проекта в определенной области для TFVC.

Сведения о конструкторе

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Параметры

options

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

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Возвращает наборы изменений для заданного списка идентификаторов наборов изменений.

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

Параметры

changesetsRequestData

TfvcChangesetsRequestData

Список идентификаторов наборов изменений.

Возвращаемое значение

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

Идентификатор проекта или имя проекта

includeParent

boolean

Возвращает родительскую ветку, если она есть. По умолчанию: False

includeChildren

boolean

Возвращайте дочерние ветки, если они есть. По умолчанию: False

Возвращаемое значение

Promise<TfvcBranch>

getBranches(string, boolean, boolean, boolean, boolean)

Получите коллекцию корней ветвей -- дочерних ветвей первого уровня, ветвей без родителей.

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

Параметры

project

string

Идентификатор проекта или имя проекта

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

Идентификатор проекта или имя проекта

includeDeleted

boolean

Возврат удаленных веток. По умолчанию: False

includeLinks

boolean

Обратные ссылки. По умолчанию: False

Возвращаемое значение

Promise<TfvcBranchRef[]>

getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)

Получение набора правок 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>

Параметры

id

number

Набор изменений Id для получения.

project

string

Идентификатор проекта или имя проекта

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) По умолчанию: null

Возвращаемое значение

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Получение изменений Tfvc для заданного набора изменений.

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

Параметры

id

number

Идентификатор пакета изменений. По умолчанию: 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

Идентификатор проекта или имя проекта

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) По умолчанию: null

Возвращаемое значение

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Извлекает рабочие элементы, связанные с определенным набором изменений.

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

Параметры

id

number

Идентификатор пакета изменений.

Возвращаемое значение

Promise<AssociatedWorkItem[]>

getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.

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

Параметры

path

string

Путь управления версиями отдельного возвращаемого элемента.

project

string

Идентификатор проекта или имя проекта

fileName

string

Возвращаемое имя файла элемента.

download

boolean

Если значение true, создайте загружаемое вложение.

scopePath

string

Путь управления версиями папки для возврата нескольких элементов.

recursionLevel

VersionControlRecursionType

None (только элемент) или OneLevel (содержимое папки).

versionDescriptor

TfvcVersionDescriptor

Дескриптор версии. Значение по умолчанию — null.

includeContent

boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. По умолчанию — false.

Возвращаемое значение

Promise<TfvcItem>

getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.

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

Параметры

path

string

Путь управления версиями отдельного возвращаемого элемента.

project

string

Идентификатор проекта или имя проекта

fileName

string

Возвращаемое имя файла элемента.

download

boolean

Если значение true, создайте загружаемое вложение.

scopePath

string

Путь управления версиями папки для возврата нескольких элементов.

recursionLevel

VersionControlRecursionType

None (только элемент) или OneLevel (содержимое папки).

versionDescriptor

TfvcVersionDescriptor

Дескриптор версии. Значение по умолчанию — null.

includeContent

boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. По умолчанию — 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

Идентификатор проекта или имя проекта

scopePath

string

Путь управления версиями папки для возврата нескольких элементов.

recursionLevel

VersionControlRecursionType

None (только элемент) или OneLevel (содержимое папки).

includeLinks

boolean

Значение true для включения ссылок.

versionDescriptor

TfvcVersionDescriptor

Возвращаемое значение

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Пост для извлечения набора элементов с заданным списком путей или длинным путем. Позволяет указать recursionLevel и дескрипторы версии для каждого пути.

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

Параметры

itemRequestData

TfvcItemRequestData

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Пост для извлечения набора элементов с заданным списком путей или длинным путем. Позволяет указать recursionLevel и дескрипторы версии для каждого пути.

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

Параметры

itemRequestData

TfvcItemRequestData

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ArrayBuffer>

getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.

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

Параметры

path

string

Путь управления версиями отдельного возвращаемого элемента.

project

string

Идентификатор проекта или имя проекта

fileName

string

Возвращаемое имя файла элемента.

download

boolean

Если значение true, создайте загружаемое вложение.

scopePath

string

Путь управления версиями папки для возврата нескольких элементов.

recursionLevel

VersionControlRecursionType

None (только элемент) или OneLevel (содержимое папки).

versionDescriptor

TfvcVersionDescriptor

Дескриптор версии. Значение по умолчанию — null.

includeContent

boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. По умолчанию — false.

Возвращаемое значение

Promise<string>

getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.

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

Параметры

path

string

Путь управления версиями отдельного возвращаемого элемента.

project

string

Идентификатор проекта или имя проекта

fileName

string

Возвращаемое имя файла элемента.

download

boolean

Если значение true, создайте загружаемое вложение.

scopePath

string

Путь управления версиями папки для возврата нескольких элементов.

recursionLevel

VersionControlRecursionType

None (только элемент) или OneLevel (содержимое папки).

versionDescriptor

TfvcVersionDescriptor

Дескриптор версии. Значение по умолчанию — null.

includeContent

boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. По умолчанию — false.

Возвращаемое значение

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Получите одну глубокую этикетку.

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

Параметры

labelId

string

Уникальный идентификатор этикетки

requestData

TfvcLabelRequestData

maxItemCount

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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, имя, владелец и itemLabelFilter

project

string

Идентификатор проекта или имя проекта

top

number

Максимальное количество возвращаемых меток, по умолчанию 100, если не определено

skip

number

Количество меток для пропуска

Возвращаемое значение

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Получите один глубокий набор полочных шкафов.

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

Параметры

shelvesetId

string

Уникальный идентификатор Shelsset

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount и maxCommentLength

Возвращаемое значение

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Получите изменения, включенные в набор отложенных изменений.

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

Параметры

shelvesetId

string

Уникальный идентификатор Shelsset

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

Уникальный идентификатор Shelsset

Возвращаемое значение

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Предоставляет количество файлов и несжатых байтов для коллекции/проекта в определенной области для TFVC.

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

Параметры

project

string

Идентификатор проекта или имя проекта

scopePath

string

'$/' для коллекции, '$/project' для конкретного проекта

Возвращаемое значение

Promise<TfvcStatistics>