FileContainerRestClient class
Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS
- Extends
Konstruktory
| File |
Metody
| create |
Vytvoří určené položky v odkazovaném kontejneru. |
| delete |
Odstraní určené položky v kontejneru. |
| get |
Získá kontejnery filtrované podle čárkami odděleného seznamu identifikátorů URI artefaktů ve stejném oboru, pokud není zadaný, vrátí všechny kontejnery |
| get |
Získá zadaný objekt kontejneru souborů ve formátu závislém na daných parametrech nebo hlavičce požadavku HTTP Accept |
Podrobnosti konstruktoru
FileContainerRestClient(IVssRestClientOptions)
Podrobnosti metody
createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)
Vytvoří určené 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í rozsah kontejneru. Často se jedná o ID projektu.
Návraty
Promise<FileContainerItem[]>
deleteItem(number, string, string)
Odstraní určené 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í rozsah kontejneru. Často se jedná o ID projektu.
Návraty
Promise<void>
getContainers(string, string)
Získá kontejnery filtrované podle čárkami odděleného seznamu identifikátorů URI artefaktů ve stejném 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í rozsah 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 souborů ve formátu závislém na daný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í rozsah kontejneru. Často se jedná o ID projektu.
- itemPath
-
string
Cesta k předmětu zájmu
- metadata
-
boolean
Pokud je true, přepíše se jakýkoli zadaný parametr formátu nebo hlavička požadavku HTTP Accept a poskytne se nerekurzivní informace pro danou itemPath
- format
-
string
Pokud je tato možnost zadaná, přepíše se hlavička požadavku HTTP Accept a vrátí se buď json, nebo zip. Pokud je zadáno $format, pak api-version by měl být také zadán jako parametr dotazu.
- downloadFileName
-
string
Pokud je zadán a vrací jiný formát než JSON, použije se tento název pro stahování (jinak je výchozí itemPath)
- includeDownloadTickets
-
boolean
- isShallow
-
boolean
Pokud je true, vrátí pouze bezprostřední podřízené položky (soubory a složky) pro danou cestu k položce. Hodnota false vrátí všechny položky rekurzivně v rámci objektu itemPath.
- ignoreRequestedMediaType
-
boolean
Nastavte na true, pokud chcete ignorovat hlavičku požadavku HTTP Accept. Výchozí hodnota je False.
- includeBlobMetadata
-
boolean
- saveAbsolutePath
-
boolean
Nastavte na false, pokud nechcete uložit absolutní cestu k určenému adresáři artefaktu ve vráceném archivu. Funguje pouze pro adresáře artefaktů. Výchozí hodnota je true.
- preferRedirect
-
boolean
Nastavením na hodnotu true získáte odpověď přesměrování, která vede do streamu s obsahem. Výchozí hodnota je False.
Návraty
Promise<FileContainerItem[]>