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)	Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к zip-содержимому, которое всегда возвращается при скачивании.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к zip-содержимому, которое всегда возвращается при скачивании.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Получение списка элементов Tfvc
getItemsBatch(TfvcItemRequestData, string)	Публикация для получения набора элементов с заданным списком путей или длинным путем. Позволяет указать дескрипторы recursionLevel и версии для каждого пути.
getItemsBatchZip(TfvcItemRequestData, string)	Публикация для получения набора элементов с заданным списком путей или длинным путем. Позволяет указать дескрипторы recursionLevel и версии для каждого пути.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к zip-содержимому, которое всегда возвращается при скачивании.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к zip-содержимому, которое всегда возвращается при скачивании.
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

Идентификатор набора изменений для извлечения.

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 asc для сортировки по идентификатору в порядке возрастания.

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 asc для сортировки по идентификатору в порядке возрастания.

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)

Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к 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

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

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)

Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к 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

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

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)

Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к 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

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

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)

Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачиваемый или просто отправленный в виде потока. Не применяется к 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

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

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, name, owner и itemLabelFilter

project

string

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

top

number

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

skip

number

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

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

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Получите один глубокий набор стеллажей.

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

Параметры

shelvesetId

string

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

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount и maxCommentLength

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

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

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

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

Параметры

shelvesetId

string

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

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

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

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

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

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

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

Параметры

project

string

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

scopePath

string

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

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

Promise<TfvcStatistics>