FileContainerRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

FileContainerRestClient(IVssRestClientOptions)

Metódusok

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Létrehozza a megadott elemeket a hivatkozott tárolóban.
deleteItem(number, string, string)	Törli a megadott elemeket egy tárolóban.
getContainers(string, string)	Az azonos hatókörön belüli összetevő-urik vesszővel elválasztott listája alapján szűrt tárolókat kap meg, ha nincs megadva, az összes tárolót visszaadja
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Lekéri a megadott fájltároló objektumot a megadott paraméterektől vagy a HTTP Accept kérelem fejlécétől függő formátumban

Konstruktor adatai

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Metódus adatai

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

Létrehozza a megadott elemeket a hivatkozott tárolóban.

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

Paraméterek

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

A tároló hatókörét jelölő GUID azonosító. Ez gyakran a projekt azonosítója.

Válaszok

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Törli a megadott elemeket egy tárolóban.

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

Paraméterek

containerId

number

Tárolóazonosító.

itemPath

string

A törlés elérési útja.

scope

string

A tároló hatókörét jelölő GUID azonosító. Ez gyakran a projekt azonosítója.

Válaszok

Promise<void>

getContainers(string, string)

Az azonos hatókörön belüli összetevő-urik vesszővel elválasztott listája alapján szűrt tárolókat kap meg, ha nincs megadva, az összes tárolót visszaadja

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

Paraméterek

scope

string

A tároló hatókörét jelölő GUID azonosító. Ez gyakran a projekt azonosítója.

artifactUris

string

Válaszok

Promise<FileContainer[]>

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

Lekéri a megadott fájltároló objektumot a megadott paraméterektől vagy a HTTP Accept kérelem fejlécétől függő formátumban

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

Paraméterek

containerId

number

A kért tárolóazonosító

scope

string

A tároló hatókörét jelölő GUID azonosító. Ez gyakran a projekt azonosítója.

itemPath

string

Az érdeklődésre számot tartó elem elérési útja

metadata

boolean

Ha igaz, ez felülbírálja a megadott formátumparamétereket vagy HTTP Accept kérelem fejlécét, hogy nem rekurzív információkat biztosítson az adott itemPath

format

string

Ha meg van adva, ez felülbírálja a HTTP Accept kérelem fejlécét, hogy a "json" vagy a "zip" értéket adja vissza. Ha $format meg van adva, akkor az api-version lekérdezési paraméterként is meg kell adni.

downloadFileName

string

Ha a JSON-formátumtól eltérő értéket ad meg, akkor a rendszer ezt a letöltési nevet használja (ellenkező esetben alapértelmezés szerint itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Ha igaz, akkor csak az adott itemPath közvetlen gyermekeit (files & folders) adja vissza. A false az összes elemet rekurzív módon adja vissza itemPath .

ignoreRequestedMediaType

boolean

Állítsa true (igaz) értékre a HTTP Accept kérelem fejlécének figyelmen kívül hagyásához. Az alapértelmezett érték false.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Állítsa false (hamis) értékre, ha nem szeretné menteni az összetevő megadott könyvtárának abszolút elérési útját a visszaadott archívumban. Csak műtermékkönyvtárakban működik. Alapértelmezett érték: true (igaz).

preferRedirect

boolean

Állítsa true (igaz) értékre, hogy megkapja az átirányítási választ, amely a tartalommal rendelkező streamhez vezet. Az alapértelmezett érték false.

Válaszok

Promise<FileContainerItem[]>