FileContainerRestClient class
Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er
- Extends
Konstruktorer
| File |
Metoder
| create |
Skapar de angivna objekten i den refererade containern. |
| delete |
Tar bort de angivna objekten i en container. |
| get |
Hämtar containrar filtrerade efter en kommaavgränsad lista över artefakt-uri:er inom samma omfång, om det inte anges returneras alla containrar |
| get |
Hämtar det angivna filcontainerobjektet i ett format som är beroende av de angivna parametrarna eller HTTP-begärandehuvudet |
Konstruktorinformation
FileContainerRestClient(IVssRestClientOptions)
new FileContainerRestClient(options: IVssRestClientOptions)Parametrar
- options
- IVssRestClientOptions
Metodinformation
createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)
Skapar de angivna objekten i den refererade containern.
function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>Parametrar
- containerId
-
number
- scope
-
string
Ett GUID som representerar containerns omfång. Det här är ofta projekt-ID:t.
Returer
Promise<FileContainerItem[]>
deleteItem(number, string, string)
Tar bort de angivna objekten i en container.
function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>Parametrar
- containerId
-
number
Container-ID.
- itemPath
-
string
Sökväg att ta bort.
- scope
-
string
Ett GUID som representerar containerns omfång. Det här är ofta projekt-ID:t.
Returer
Promise<void>
getContainers(string, string)
Hämtar containrar filtrerade efter en kommaavgränsad lista över artefakt-uri:er inom samma omfång, om det inte anges returneras alla containrar
function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>Parametrar
- scope
-
string
Ett GUID som representerar containerns omfång. Det här är ofta projekt-ID:t.
- artifactUris
-
string
Returer
Promise<FileContainer[]>
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)
Hämtar det angivna filcontainerobjektet i ett format som är beroende av de angivna parametrarna eller HTTP-begärandehuvudet
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[]>Parametrar
- containerId
-
number
Det begärda container-ID:t
- scope
-
string
Ett GUID som representerar containerns omfång. Det här är ofta projekt-ID:t.
- itemPath
-
string
Sökvägen till objektet av intresse
- metadata
-
boolean
Om det är sant åsidosätter detta en angiven formatparameter eller HTTP Accept request-huvudet för att tillhandahålla icke-rekursiv information för den angivna itemPath
- format
-
string
Om detta anges åsidosätter detta http-begärandehuvudet för att returnera antingen "json" eller "zip". Om $format anges ska api-versionen också anges som en frågeparameter.
- downloadFileName
-
string
Om det anges och returneras annat än JSON-format används det här nedladdningsnamnet (annars används som standard itemPath)
- includeDownloadTickets
-
boolean
- isShallow
-
boolean
Om det är sant returneras endast omedelbara underordnade (filer & mappar) för den angivna itemPath. False returnerar alla objekt rekursivt i itemPath.
- ignoreRequestedMediaType
-
boolean
Ange till true för att ignorera http-begärandehuvudet. Standardvärdet är false.
- includeBlobMetadata
-
boolean
- saveAbsolutePath
-
boolean
Ange till false för att inte spara den absoluta sökvägen till den angivna katalogen för artefakten i det returnerade arkivet. Fungerar endast för artefaktkataloger. Standardvärdet är true.
- preferRedirect
-
boolean
Ställ in på true för att få omdirigeringssvaret som leder till strömmen med innehåll. Standardvärdet är false.
Returer
Promise<FileContainerItem[]>