FileContainerRestClient class

Пакет:

azure-devops-extension-api

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

Extends

RestClientBase

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

FileContainerRestClient(IVssRestClientOptions)

Методы

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Создает указанные элементы в контейнере, на который ссылается ссылка.
deleteItem(number, string, string)	Удаляет указанные элементы в контейнере.
getContainers(string, string)	Возвращает контейнеры, отфильтрованные разделенным запятыми списком URI артефактов в одной области, если не указано, возвращает все контейнеры.
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Возвращает указанный объект контейнера файлов в формате, зависящей от заданных параметров или заголовка запроса HTTP Accept

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

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)

Создает указанные элементы в контейнере, на который ссылается ссылка.

function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>

Параметры

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Guid, представляющий область действия контейнера. Это часто идентификатор проекта.

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

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Удаляет указанные элементы в контейнере.

function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>

Параметры

containerId

number

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

itemPath

string

Путь к удалению.

scope

string

Guid, представляющий область действия контейнера. Это часто идентификатор проекта.

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

Promise<void>

getContainers(string, string)

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

function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>

Параметры

scope

string

Guid, представляющий область действия контейнера. Это часто идентификатор проекта.

artifactUris

string

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

Promise<FileContainer[]>

getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)

Возвращает указанный объект контейнера файлов в формате, зависящей от заданных параметров или заголовка запроса HTTP Accept

function getItems(containerId: number, scope?: string, itemPath?: string, metadata?: boolean, format?: string, downloadFileName?: string, includeDownloadTickets?: boolean, isShallow?: boolean, ignoreRequestedMediaType?: boolean, includeBlobMetadata?: boolean, saveAbsolutePath?: boolean, preferRedirect?: boolean): Promise<FileContainerItem[]>

Параметры

containerId

number

Запрошенный идентификатор контейнера

scope

string

Guid, представляющий область действия контейнера. Это часто идентификатор проекта.

itemPath

string

Путь к интересующим элементу

metadata

boolean

Если значение true, это переопределяет любой указанный параметр формата или заголовок запроса HTTP Accept, чтобы предоставить не рекурсивные сведения для заданного элементаPath

format

string

Если задано, это переопределяет заголовок запроса HTTP Accept, чтобы вернуть json или zip. Если указан $format, то в качестве параметра запроса также следует указать версию API.

downloadFileName

string

Если указано и возвращается, отличный от формата JSON, будет использоваться это имя скачивания (в противном случае используется значение itemPath по умолчанию).

includeDownloadTickets

boolean

isShallow

boolean

Если значение true, возвращает только непосредственные дочерние (файлы & папки) для данного элементаPath. False возвращает все элементы рекурсивно в itemPath.

ignoreRequestedMediaType

boolean

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

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Задайте значение false, чтобы не сохранить абсолютный путь к указанному каталогу артефакта в возвращенном архиве. Работает только для каталогов артефактов. Значение по умолчанию — true.

preferRedirect

boolean

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

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

Promise<FileContainerItem[]>