FileContainerRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends

RestClientBase

Konstruktorer

FileContainerRestClient(IVssRestClientOptions)

Metoder

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Skapar de angivna objekten i den refererade behållaren.
deleteItem(number, string, string)	Tar bort de angivna objekten i en container.
getContainers(string, string)	Hämtar containrar filtrerade efter en kommaavgränsad lista över artefakt-URI:er inom samma omfång, om inget anges returneras alla containrar
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Hämtar det angivna filcontainerobjektet i ett format som är beroende av de angivna parametrarna eller HTTP Accept-begärandehuvudet

Konstruktorinformation

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

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

Skapar de angivna objekten i den refererade behållaren.

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

Parametrar

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Ett guid som representerar containerns omfång. Detta är ofta projekt-id:t.

Returer

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Tar bort de angivna objekten i en container.

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

Parametrar

containerId

number

Behållar-ID.

itemPath

string

Sökväg som ska tas bort.

scope

string

Ett guid som representerar containerns omfång. Detta är ofta projekt-id:t.

Returer

Promise<void>

getContainers(string, string)

Hämtar containrar filtrerade efter en kommaavgränsad lista över artefakt-URI:er inom samma omfång, om inget anges returneras alla containrar

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

Parametrar

scope

string

Ett guid som representerar containerns omfång. Detta är ofta projekt-id:t.

artifactUris

string

Returer

Promise<FileContainer[]>

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

Hämtar det angivna filcontainerobjektet i ett format som är beroende av de angivna parametrarna eller HTTP Accept-begärandehuvudet

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

Parametrar

containerId

number

Det begärda container-ID:t

scope

string

Ett guid som representerar containerns omfång. Detta är ofta projekt-id:t.

itemPath

string

Sökvägen till det objekt som är av intresse

metadata

boolean

Om det är sant åsidosätter detta alla angivna formatparametrar eller HTTP Accept-begärandehuvud för att tillhandahålla icke-rekursiv information för den angivna itemPath

format

string

Om det anges åsidosätter detta begärandehuvudet för HTTP Accept för att returnera antingen "json" eller "zip". Om $format anges ska api-version också anges som en frågeparameter.

downloadFileName

string

Om det anges och returneras annat än JSON-format används det här nedladdningsnamnet (annars används itemPath som standard)

includeDownloadTickets

boolean

isShallow

boolean

Om det är sant returneras endast omedelbara underordnade objekt (filer och mappar) för den angivna itemPath. False returnerar alla objekt rekursivt inom itemPath.

ignoreRequestedMediaType

boolean

Ange till true för att ignorera begärandehuvudet för HTTP-accept. Standardvärdet är false.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Ange till false om du inte vill spara den absoluta sökvägen till den angivna katalogen för artefakten i det returnerade arkivet. Fungerar endast för artefaktkataloger. Standardvärdet är sant.

preferRedirect

boolean

Ange till true för att få omdirigeringssvaret, som leder till dataströmmen med innehåll. Standardvärdet är false.

Returer

Promise<FileContainerItem[]>