FileContainerRestClient class
Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldéséhez (származtatásából) kell használni
- Extends
| create |
Létrehozza a megadott elemeket a hivatkozott tárolóban. |
| delete |
Törli a tárolóban megadott elemeket. |
| get |
Lekéri az ugyanazon hatókörön belüli összetevők URI-jainak vesszővel tagolt listájával szűrt tárolókat, ha nincs megadva, az összes tárolót visszaadja |
| get |
Lekéri a megadott fájltároló-objektumot a megadott paraméterektől vagy HTTP Accept request fejléctől függő formátumban |
new FileContainerRestClient(options: IVssRestClientOptions)Paraméterek
- options
- IVssRestClientOptions
Létrehozza a megadott elemeket a hivatkozott tárolóban.
function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>Paraméterek
- containerId
-
number
- scope
-
string
A tároló hatókörét jelölő guid. Ez gyakran a projekt azonosítója.
Válaszok
Promise<FileContainerItem[]>
Törli a tárolóban megadott elemeket.
function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>Paraméterek
- containerId
-
number
Tárolóazonosító.
- itemPath
-
string
A törölni kívánt elérési út.
- scope
-
string
A tároló hatókörét jelölő guid. Ez gyakran a projekt azonosítója.
Válaszok
Promise<void>
Lekéri az ugyanazon hatókörön belüli összetevők URI-jainak vesszővel tagolt listájával szűrt tárolókat, 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. 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 HTTP Accept request fejléctő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. Ez gyakran a projekt azonosítója.
- itemPath
-
string
A kívánt elem elérési útja
- metadata
-
boolean
Ha igaz, ez felülbírálja a megadott formátumparamétert vagy HTTP Accept kérelemfejlécet, hogy ne rekurzív információkat biztosítson az adott itemPath-hoz
- format
-
string
Ha meg van adva, ez felülbírálja a HTTP Accept kérelem fejlécét a "json" vagy a "zip" visszaadásához. Ha $format van megadva, akkor az api-version paramétert is meg kell adni lekérdezési paraméterként.
- downloadFileName
-
string
Ha meg van adva, és nem JSON-formátumot ad vissza, akkor a rendszer ezt a letöltési nevet fogja használni (máskülönben alapértelmezés szerint az itemPath)
- includeDownloadTickets
-
boolean
- isShallow
-
boolean
Ha igaz, csak az adott itemPath elemhez tartozó közvetlen gyermek (fájlok & mappák) értéket adja vissza. A False függvény az itemPath összes rekurzív elemét visszaadja.
- ignoreRequestedMediaType
-
boolean
Állítsa true (igaz) értékre a HTTP Accept request fejléc figyelmen kívül hagyásához. Az alapértelmezett érték a false (hamis).
- includeBlobMetadata
-
boolean
- saveAbsolutePath
-
boolean
Állítsa false (hamis) értékre, hogy ne mentse az abszolút elérési utat a visszaadott archívumban lévő összetevő megadott könyvtárába. Csak az összetevők könyvtárainál működik. Alapértelmezett érték: true (igaz).
- preferRedirect
-
boolean
Állítsa igaz értékre az átirányítási válasz lekéréséhez, amely a tartalommal rendelkező streamhez vezet. Az alapértelmezett érték a false (hamis).
Válaszok
Promise<FileContainerItem[]>