FileContainerRestClient class
Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api
- Memperluas
Konstruktor
| File |
Metode
| create |
Membuat item yang ditentukan dalam kontainer yang dirujuk. |
| delete |
Menghapus item yang ditentukan dalam kontainer. |
| get |
Mendapatkan kontainer yang difilter oleh daftar uri artefak yang dipisahkan koma dalam cakupan yang sama, jika tidak ditentukan mengembalikan semua kontainer |
| get |
Mendapatkan objek kontainer file yang ditentukan dalam format yang bergantung pada parameter yang diberikan atau header permintaan Penerimaan HTTP |
Detail Konstruktor
FileContainerRestClient(IVssRestClientOptions)
Detail Metode
createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)
Membuat item yang ditentukan dalam kontainer yang dirujuk.
function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>Parameter
- containerId
-
number
- scope
-
string
Panduan yang mewakili cakupan kontainer. Ini sering kali menjadi id proyek.
Mengembalikan
Promise<FileContainerItem[]>
deleteItem(number, string, string)
Menghapus item yang ditentukan dalam kontainer.
function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>Parameter
- containerId
-
number
Id Kontainer.
- itemPath
-
string
Jalur untuk dihapus.
- scope
-
string
Panduan yang mewakili cakupan kontainer. Ini sering kali menjadi id proyek.
Mengembalikan
Promise<void>
getContainers(string, string)
Mendapatkan kontainer yang difilter oleh daftar uri artefak yang dipisahkan koma dalam cakupan yang sama, jika tidak ditentukan mengembalikan semua kontainer
function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>Parameter
- scope
-
string
Panduan yang mewakili cakupan kontainer. Ini sering kali menjadi id proyek.
- artifactUris
-
string
Mengembalikan
Promise<FileContainer[]>
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)
Mendapatkan objek kontainer file yang ditentukan dalam format yang bergantung pada parameter yang diberikan atau header permintaan Penerimaan HTTP
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[]>Parameter
- containerId
-
number
Id kontainer yang diminta
- scope
-
string
Panduan yang mewakili cakupan kontainer. Ini sering kali menjadi id proyek.
- itemPath
-
string
Jalur ke item yang diminati
- metadata
-
boolean
Jika true, ini mengambil alih parameter format tertentu atau header permintaan Penerimaan HTTP untuk memberikan informasi non-rekursif untuk itemPath yang diberikan
- format
-
string
Jika ditentukan, ini mengambil alih header permintaan Penerimaan HTTP untuk mengembalikan 'json' atau 'zip'. Jika $format ditentukan, versi api juga harus ditentukan sebagai parameter kueri.
- downloadFileName
-
string
Jika ditentukan dan menampilkan selain format JSON, maka nama unduhan ini akan digunakan (default lain ke itemPath)
- includeDownloadTickets
-
boolean
- isShallow
-
boolean
Jika true, hanya mengembalikan turunan langsung (file & folder) untuk itemPath yang diberikan. False akan mengembalikan semua item secara rekursif dalam itemPath.
- ignoreRequestedMediaType
-
boolean
Atur ke true untuk mengabaikan header permintaan TERIMA HTTP. Defaultnya adalah false.
- includeBlobMetadata
-
boolean
- saveAbsolutePath
-
boolean
Atur ke false untuk tidak menyimpan jalur absolut ke direktori artefak yang ditentukan dalam arsip yang dikembalikan. Hanya berfungsi untuk direktori artefak. Defaultnya adalah true.
- preferRedirect
-
boolean
Atur ke true untuk mendapatkan respons pengalihan yang mengarah ke aliran dengan konten. Defaultnya adalah false.
Mengembalikan
Promise<FileContainerItem[]>