FileContainerRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

FileContainerRestClient(IVssRestClientOptions)

Metodi

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Crea gli elementi specificati nel contenitore a cui si fa riferimento.
deleteItem(number, string, string)	Elimina gli elementi specificati in un contenitore.
getContainers(string, string)	Ottiene i contenitori filtrati in base a un elenco delimitato da virgole di URI di artefatti all'interno dello stesso ambito, se non specificato restituisce tutti i contenitori
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Ottiene l'oggetto contenitore di file specificato in un formato dipendente dai parametri specificati o dall'intestazione della richiesta HTTP Accept

Dettagli costruttore

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli metodo

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

Crea gli elementi specificati nel contenitore a cui si fa riferimento.

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

Parametri

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

GUID che rappresenta l'ambito del contenitore. Si tratta spesso dell'ID progetto.

Restituisce

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Elimina gli elementi specificati in un contenitore.

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

Parametri

containerId

number

ID contenitore.

itemPath

string

Percorso da eliminare.

scope

string

GUID che rappresenta l'ambito del contenitore. Si tratta spesso dell'ID progetto.

Restituisce

Promise<void>

getContainers(string, string)

Ottiene i contenitori filtrati in base a un elenco delimitato da virgole di URI di artefatti all'interno dello stesso ambito, se non specificato restituisce tutti i contenitori

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

Parametri

scope

string

GUID che rappresenta l'ambito del contenitore. Si tratta spesso dell'ID progetto.

artifactUris

string

Restituisce

Promise<FileContainer[]>

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

Ottiene l'oggetto contenitore di file specificato in un formato dipendente dai parametri specificati o dall'intestazione della richiesta 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[]>

Parametri

containerId

number

ID contenitore richiesto

scope

string

GUID che rappresenta l'ambito del contenitore. Si tratta spesso dell'ID progetto.

itemPath

string

Percorso dell'elemento di interesse

metadata

boolean

Se true, esegue l'override di qualsiasi parametro di formato specificato o intestazione della richiesta HTTP Accept per fornire informazioni non ricorsive per itemPath specificato

format

string

Se specificato, esegue l'override dell'intestazione della richiesta ACCETTA HTTP per restituire 'json' o 'zip'. Se viene specificato $format, anche api-version deve essere specificato come parametro di query.

downloadFileName

string

Se specificato e restituito diverso dal formato JSON, verrà usato questo nome di download (altrimenti per impostazione predefinita itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Se true, restituisce solo elementi figlio immediati(file & cartelle) per il valore itemPath specificato. False restituirà tutti gli elementi in modo ricorsivo all'interno di itemPath.

ignoreRequestedMediaType

boolean

Impostare su true per ignorare l'intestazione della richiesta ACCETTA HTTP. L'impostazione predefinita è false.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Impostare su false per non salvare il percorso assoluto nella directory specificata dell'artefatto nell'archivio restituito. Funziona solo per le directory degli artefatti. Il valore predefinito è true.

preferRedirect

boolean

Impostare su true per ottenere la risposta di reindirizzamento che conduce al flusso con contenuto. L'impostazione predefinita è false.

Restituisce

Promise<FileContainerItem[]>