FileContainerRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

FileContainerRestClient(IVssRestClientOptions)

Yöntemler

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Başvurulan kapsayıcıda belirtilen öğeleri oluşturur.
deleteItem(number, string, string)	Bir kapsayıcıdaki belirtilen öğeleri siler.
getContainers(string, string)	Aynı kapsam içindeki virgülle ayrılmış yapıt uri listesine göre filtrelenmiş kapsayıcıları alır, belirtilmezse tüm kapsayıcıları döndürür
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Belirtilen dosya kapsayıcı nesnesini, verilen parametrelere veya HTTP Accept istek başlığına bağlı bir biçimde alır

Oluşturucu Ayrıntıları

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

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

Başvurulan kapsayıcıda belirtilen öğeleri oluşturur.

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

Parametreler

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Kapsayıcının kapsamını temsil eden bir guid. Bu genellikle proje kimliğidir.

Döndürülenler

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Bir kapsayıcıdaki belirtilen öğeleri siler.

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

Parametreler

containerId

number

Kapsayıcı Kimliği.

itemPath

string

Silinecek yol.

scope

string

Kapsayıcının kapsamını temsil eden bir guid. Bu genellikle proje kimliğidir.

Döndürülenler

Promise<void>

getContainers(string, string)

Aynı kapsam içindeki virgülle ayrılmış yapıt uri listesine göre filtrelenmiş kapsayıcıları alır, belirtilmezse tüm kapsayıcıları döndürür

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

Parametreler

scope

string

Kapsayıcının kapsamını temsil eden bir guid. Bu genellikle proje kimliğidir.

artifactUris

string

Döndürülenler

Promise<FileContainer[]>

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

Belirtilen dosya kapsayıcı nesnesini, verilen parametrelere veya HTTP Accept istek başlığına bağlı bir biçimde alır

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[]>

Parametreler

containerId

number

İstenen kapsayıcı kimliği

scope

string

Kapsayıcının kapsamını temsil eden bir guid. Bu genellikle proje kimliğidir.

itemPath

string

İlgilenilen öğeye giden yol

metadata

boolean

Doğruysa, bu, verilen itemPath için özyinelemeli olmayan bilgiler sağlamak için belirtilen herhangi bir biçim parametresini veya HTTP Accept istek üst bilgisini geçersiz kılar

format

string

Belirtilirse, bu, 'json' veya 'zip' döndürmek için HTTP Accept istek üst bilgisini geçersiz kılar. $format belirtilirse, api-version sorgu parametresi olarak da belirtilmelidir.

downloadFileName

string

Belirtilir ve JSON biçiminden farklı bir değer döndürülürse, bu indirme adı kullanılır (aksi takdirde varsayılan olarak itemPath kullanılır)

includeDownloadTickets

boolean

isShallow

boolean

true ise, verilen itemPath için yalnızca hemen alt öğeleri (dosyalar ve klasörler) döndürür. False, itemPath içindeki tüm öğeleri yinelemeli olarak döndürür.

ignoreRequestedMediaType

boolean

HTTP Accept istek üst bilgisini yoksaymak için true olarak ayarlayın. Varsayılan değer false'tur.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Döndürülen arşivdeki yapıtın belirtilen dizinine giden mutlak yolu kaydetmemek için false olarak ayarlayın. Yalnızca yapı dizinleri için çalışır. Varsayılan değer doğrudur

preferRedirect

boolean

İçerikli akışa yönlendiren yönlendirme yanıtını almak için true olarak ayarlayın. Varsayılan değer false'tur.

Döndürülenler

Promise<FileContainerItem[]>