FileContainerRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends

RestClientBase

Konstruktoren

FileContainerRestClient(IVssRestClientOptions)

Methoden

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Erstellt die angegebenen Elemente im Container, auf den verwiesen wird.
deleteItem(number, string, string)	Löscht die angegebenen Elemente in einem Container.
getContainers(string, string)	Ruft Container ab, die nach einer durch Trennzeichen getrennten Liste von Artefakt-Uris innerhalb desselben Bereichs gefiltert wurden, und gibt alle Container zurück, wenn nicht angegeben wird.
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Ruft das angegebene Dateicontainerobjekt in einem Format ab, das von den angegebenen Parametern oder dem HTTP Accept-Anforderungsheader abhängt.

Details zum Konstruktor

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

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

Erstellt die angegebenen Elemente im Container, auf den verwiesen wird.

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

Parameter

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Eine GUID, die den Bereich des Containers darstellt. Dies ist häufig die Projekt-ID.

Gibt zurück

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Löscht die angegebenen Elemente in einem Container.

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

Parameter

containerId

number

Container-ID.

itemPath

string

Pfad zum Löschen.

scope

string

Eine GUID, die den Bereich des Containers darstellt. Dies ist häufig die Projekt-ID.

Gibt zurück

Promise<void>

getContainers(string, string)

Ruft Container ab, die nach einer durch Trennzeichen getrennten Liste von Artefakt-Uris innerhalb desselben Bereichs gefiltert wurden, und gibt alle Container zurück, wenn nicht angegeben wird.

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

Parameter

scope

string

Eine GUID, die den Bereich des Containers darstellt. Dies ist häufig die Projekt-ID.

artifactUris

string

Gibt zurück

Promise<FileContainer[]>

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

Ruft das angegebene Dateicontainerobjekt in einem Format ab, das von den angegebenen Parametern oder dem HTTP Accept-Anforderungsheader abhängt.

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[]>

Parameter

containerId

number

Die angeforderte Container-ID

scope

string

Eine GUID, die den Bereich des Containers darstellt. Dies ist häufig die Projekt-ID.

itemPath

string

Der Pfad zum gewünschten Element

metadata

boolean

Bei true werden alle angegebenen Formatparameter oder HTTP Accept-Anforderungsheader überschrieben, um nicht rekursive Informationen für den angegebenen itemPath bereitzustellen

format

string

Wenn angegeben, wird der HTTP Accept-Anforderungsheader überschrieben, um entweder "json" oder "zip" zurückzugeben. Wenn $format angegeben ist, sollte api-version auch als Abfrageparameter angegeben werden.

downloadFileName

string

Wenn angegeben und ein anderes Format als das JSON-Format zurückgegeben wird, wird dieser Downloadname verwendet (andernfalls wird standardmäßig itemPath verwendet)

includeDownloadTickets

boolean

isShallow

boolean

Wenn true, werden nur unmittelbare untergeordnete Elemente (Dateien und Ordner) für den angegebenen itemPath zurückgegeben. False gibt alle Elemente rekursiv innerhalb von itemPath zurück.

ignoreRequestedMediaType

boolean

Legen Sie diesen Wert auf true fest, um den HTTP Accept-Anforderungsheader zu ignorieren. Der Standardwert ist "false".

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Legen Sie diesen Wert auf false fest, um den absoluten Pfad zum angegebenen Verzeichnis des Artefakts im zurückgegebenen Archiv nicht zu speichern. Funktioniert nur für Artefaktverzeichnisse. Der Standardwert ist "true".

preferRedirect

boolean

Legen Sie diesen Wert auf true fest, um die Umleitungsantwort zu erhalten, die zum Stream mit Inhalt führt. Der Standardwert ist "false".

Gibt zurück

Promise<FileContainerItem[]>