FileContainerRestClient class
Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS
- Extends
Konstruktory
File |
Metody
create |
Vytvoří zadané položky v odkazovaném kontejneru. |
delete |
Odstraní zadané položky v kontejneru. |
get |
Získá kontejnery filtrované čárkami odděleným seznamem identifikátorů artefaktů v rámci stejného oboru, pokud není zadaný, vrátí všechny kontejnery. |
get |
Získá zadaný objekt kontejneru souboru ve formátu závislém na zadaných parametrech nebo hlavičce požadavku HTTP Accept. |
Podrobnosti konstruktoru
FileContainerRestClient(IVssRestClientOptions)
Podrobnosti metody
createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)
Vytvoří zadané položky v odkazovaném kontejneru.
function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>
Parametry
- containerId
-
number
- scope
-
string
Identifikátor GUID představující obor kontejneru. Často se jedná o ID projektu.
Návraty
Promise<FileContainerItem[]>
deleteItem(number, string, string)
Odstraní zadané položky v kontejneru.
function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>
Parametry
- containerId
-
number
ID kontejneru.
- itemPath
-
string
Cesta k odstranění
- scope
-
string
Identifikátor GUID představující obor kontejneru. Často se jedná o ID projektu.
Návraty
Promise<void>
getContainers(string, string)
Získá kontejnery filtrované čárkami odděleným seznamem identifikátorů artefaktů v rámci stejného oboru, pokud není zadaný, vrátí všechny kontejnery.
function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>
Parametry
- scope
-
string
Identifikátor GUID představující obor kontejneru. Často se jedná o ID projektu.
- artifactUris
-
string
Návraty
Promise<FileContainer[]>
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)
Získá zadaný objekt kontejneru souboru ve formátu závislém na zadaných parametrech nebo hlavičce požadavku 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[]>
Parametry
- containerId
-
number
Požadované ID kontejneru
- scope
-
string
Identifikátor GUID představující obor kontejneru. Často se jedná o ID projektu.
- itemPath
-
string
Cesta k položce, která vás zajímá
- metadata
-
boolean
Pokud je true, přepíše se tím jakýkoli zadaný parametr formátu nebo hlavička požadavku HTTP Accept a poskytne se nerekurzivní informace pro danou cestu k položce.
- format
-
string
Pokud je tato možnost zadaná, přepíše hlavičku požadavku HTTP Accept tak, aby vracela buď json, nebo zip. Pokud je zadána $format, měla by být jako parametr dotazu zadána také verze api-version.
- downloadFileName
-
string
Pokud je zadaný a vrací se jiný formát než JSON, použije se tento název ke stažení (jinak výchozí hodnota je itemPath).
- includeDownloadTickets
-
boolean
- isShallow
-
boolean
Pokud je true, vrátí pouze okamžité podřízené položky (soubory & složky) pro danou cestu itemPath. False vrátí všechny položky rekurzivně v itemPath.
- ignoreRequestedMediaType
-
boolean
Pokud chcete ignorovat hlavičku požadavku HTTP Accept, nastavte na hodnotu true. Výchozí hodnota je false.
- includeBlobMetadata
-
boolean
- saveAbsolutePath
-
boolean
Pokud chcete neukládat absolutní cestu k zadanému adresáři artefaktu ve vráceném archivu, nastavte na hodnotu false. Funguje jenom pro adresáře artefaktů. Platí výchozí hodnota.
- preferRedirect
-
boolean
Pokud chcete získat odpověď přesměrování, která vede ke streamu s obsahem, nastavte na hodnotu true. Výchozí hodnota je false.
Návraty
Promise<FileContainerItem[]>