FileContainerRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie

RestClientBase

Konstruktory

FileContainerRestClient(IVssRestClientOptions)

Metody

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Tworzy określone elementy w przywołyowanym kontenerze.
deleteItem(number, string, string)	Usuwa określone elementy w kontenerze.
getContainers(string, string)	Pobiera kontenery filtrowane według rozdzielanej przecinkami listy reguł artefaktów w tym samym zakresie, jeśli nie określono, zwraca wszystkie kontenery
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Pobiera określony obiekt kontenera plików w formacie zależnym od podanych parametrów lub nagłówka żądania akceptowania HTTP

Szczegóły konstruktora

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)

Tworzy określone elementy w przywołyowanym kontenerze.

function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>

Parametry

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Identyfikator GUID reprezentujący zakres kontenera. Jest to często identyfikator projektu.

Zwraca

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Usuwa określone elementy w kontenerze.

function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>

Parametry

containerId

number

Identyfikator kontenera.

itemPath

string

Ścieżka do usunięcia.

scope

string

Identyfikator GUID reprezentujący zakres kontenera. Jest to często identyfikator projektu.

Zwraca

Promise<void>

getContainers(string, string)

Pobiera kontenery filtrowane według rozdzielanej przecinkami listy reguł artefaktów w tym samym zakresie, jeśli nie określono, zwraca wszystkie kontenery

function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>

Parametry

scope

string

Identyfikator GUID reprezentujący zakres kontenera. Jest to często identyfikator projektu.

artifactUris

string

Zwraca

Promise<FileContainer[]>

getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)

Pobiera określony obiekt kontenera plików w formacie zależnym od podanych parametrów lub nagłówka żądania akceptowania 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[]>

Parametry

containerId

number

Żądany identyfikator kontenera

scope

string

Identyfikator GUID reprezentujący zakres kontenera. Jest to często identyfikator projektu.

itemPath

string

Ścieżka do interesującego elementu

metadata

boolean

Jeśli wartość true, spowoduje to przesłonięcia dowolnego określonego parametru formatu lub nagłówka żądania akceptowania HTTP w celu podania informacji niecyklicznych dla danej ścieżki itemPath

format

string

Jeśli zostanie określony, spowoduje to zastąpienie nagłówka żądania akceptowania HTTP w celu zwrócenia ciągu "json" lub "zip". Jeśli określono $format, należy również określić wersję interfejsu API jako parametr zapytania.

downloadFileName

string

Jeśli określono i zwracany jest inny niż format JSON, ta nazwa pobierania będzie używana (inne wartości domyślne to itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Jeśli wartość true, zwraca tylko bezpośrednie elementy podrzędne (pliki & foldery) dla danego elementu itemPath. Wartość False zwróci wszystkie elementy rekursywnie w elemencie itemPath.

ignoreRequestedMediaType

boolean

Ustaw wartość true, aby zignorować nagłówek żądania akceptowania HTTP. Wartość domyślna to false.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Ustaw wartość false, aby nie zapisywać ścieżki bezwzględnej do określonego katalogu artefaktu w zwróconym archiwum. Działa tylko w przypadku katalogów artefaktów. Wartość domyślna to true.

preferRedirect

boolean

Ustaw wartość true, aby uzyskać odpowiedź przekierowania, która prowadzi do strumienia z zawartością. Wartość domyślna to false.

Zwraca

Promise<FileContainerItem[]>