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 для предоставления не рекурсивных сведений для заданного itemPath.

format

string

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

downloadFileName

string

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

includeDownloadTickets

boolean

isShallow

boolean

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

ignoreRequestedMediaType

boolean

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

includeBlobMetadata

boolean

saveAbsolutePath

boolean

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

preferRedirect

boolean

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

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

Promise<FileContainerItem[]>