FileContainerRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding

RestClientBase

Constructors

FileContainerRestClient(IVssRestClientOptions)

Methoden

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Hiermee maakt u de opgegeven items in de container waarnaar wordt verwezen.
deleteItem(number, string, string)	Hiermee verwijdert u de opgegeven items in een container.
getContainers(string, string)	Hiermee worden containers gefilterd op basis van een door komma's gescheiden lijst met artefact-uri's binnen hetzelfde bereik, indien niet gespecificeerd, worden alle containers geretourneerd
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Hiermee haalt u het opgegeven bestandscontainerobject op in een indeling die afhankelijk is van de opgegeven parameters of de HTTP-aanvraagheader accepteren

Constructordetails

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

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

Hiermee maakt u de opgegeven items in de container waarnaar wordt verwezen.

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

Parameters

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Een gids die de reikwijdte van de container weergeeft. Dit is vaak de project-id.

Retouren

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Hiermee verwijdert u de opgegeven items in een container.

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

Parameters

containerId

number

Identiteitskaart van de container.

itemPath

string

Pad om te verwijderen.

scope

string

Een gids die de reikwijdte van de container weergeeft. Dit is vaak de project-id.

Retouren

Promise<void>

getContainers(string, string)

Hiermee worden containers gefilterd op basis van een door komma's gescheiden lijst met artefact-uri's binnen hetzelfde bereik, indien niet gespecificeerd, worden alle containers geretourneerd

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

Parameters

scope

string

Een gids die de reikwijdte van de container weergeeft. Dit is vaak de project-id.

artifactUris

string

Retouren

Promise<FileContainer[]>

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

Hiermee haalt u het opgegeven bestandscontainerobject op in een indeling die afhankelijk is van de opgegeven parameters of de HTTP-aanvraagheader accepteren

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

Parameters

containerId

number

De gevraagde container-ID

scope

string

Een gids die de reikwijdte van de container weergeeft. Dit is vaak de project-id.

itemPath

string

De weg naar het item van interesse

metadata

boolean

Als dit waar is, overschrijft dit een opgegeven indelingsparameter of HTTP Accept-aanvraagheader om niet-recursieve informatie voor het gegeven itemPath te verstrekken

format

string

Indien opgegeven, wordt de header van het HTTP-verzoek Accept overschreven om 'json' of 'zip' te retourneren. Als $format is opgegeven, moet de api-versie ook worden opgegeven als queryparameter.

downloadFileName

string

Als het is opgegeven en een ander dan het JSON-formaat retourneert, wordt deze downloadnaam gebruikt (anders is deze standaard itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Als dit waar is, worden alleen directe onderliggende items (bestanden en mappen) geretourneerd voor het gegeven itemPath. False retourneert alle items recursief binnen itemPath.

ignoreRequestedMediaType

boolean

Stel deze instelling in op true om de header van HTTP-verzoek accepteren te negeren. De standaardwaarde is vals.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Stel deze in op onwaar om het absolute pad naar de opgegeven map van het artefact in het geretourneerde archief niet op te slaan. Werkt alleen voor artefactmappen. De standaardwaarde is waar.

preferRedirect

boolean

Stel in op true om de omleidingsreactie te krijgen die naar de stream met inhoud leidt. De standaardwaarde is vals.

Retouren

Promise<FileContainerItem[]>