FileContainerRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

FileContainerRestClient(IVssRestClientOptions)

Méthodes

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	Crée les éléments spécifiés dans le conteneur référencé.
deleteItem(number, string, string)	Supprime les éléments spécifiés dans un conteneur.
getContainers(string, string)	Obtient les conteneurs filtrés par une liste séparée par des virgules d’URI d’artefact dans la même étendue, si ce n’est pas spécifié, retourne tous les conteneurs
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	Obtient l’objet conteneur de fichiers spécifié dans un format dépendant des paramètres donnés ou de l’en-tête de demande HTTP Accept

Détails du constructeur

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

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

Crée les éléments spécifiés dans le conteneur référencé.

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

Paramètres

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

Guid représentant l’étendue du conteneur. Il s’agit souvent de l’ID de projet.

Retours

Promise<FileContainerItem[]>

deleteItem(number, string, string)

Supprime les éléments spécifiés dans un conteneur.

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

Paramètres

containerId

number

ID de conteneur.

itemPath

string

Chemin d’accès à supprimer.

scope

string

Guid représentant l’étendue du conteneur. Il s’agit souvent de l’ID de projet.

Retours

Promise<void>

getContainers(string, string)

Obtient les conteneurs filtrés par une liste séparée par des virgules d’URI d’artefact dans la même étendue, si ce n’est pas spécifié, retourne tous les conteneurs

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

Paramètres

scope

string

Guid représentant l’étendue du conteneur. Il s’agit souvent de l’ID de projet.

artifactUris

string

Retours

Promise<FileContainer[]>

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

Obtient l’objet conteneur de fichiers spécifié dans un format dépendant des paramètres donnés ou de l’en-tête de demande HTTP Accept

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ètres

containerId

number

ID de conteneur demandé

scope

string

Guid représentant l’étendue du conteneur. Il s’agit souvent de l’ID de projet.

itemPath

string

Chemin d’accès à l’élément d’intérêt

metadata

boolean

Si la valeur est true, cela remplace tout paramètre de format spécifié ou l’en-tête de requête HTTP Accept pour fournir des informations non récursives pour l’élémentPath donné

format

string

S’il est spécifié, cela remplace l’en-tête de requête Accept HTTP pour renvoyer « json » ou « zip ». Si $format est spécifié, la version de l’API doit également être spécifiée en tant que paramètre de requête.

downloadFileName

string

Si spécifié et retourné autre que le format JSON, ce nom de téléchargement sera utilisé (sinon, par défaut, itemPath)

includeDownloadTickets

boolean

isShallow

boolean

Si la valeur est true, retourne uniquement des enfants immédiats (fichiers & dossiers) pour l’élémentPath donné. False retourne tous les éléments de manière récursive dans itemPath.

ignoreRequestedMediaType

boolean

Définissez la valeur true pour ignorer l’en-tête de demande d’acceptation HTTP. La valeur par défaut est false.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

Définissez la valeur false pour ne pas enregistrer le chemin absolu dans le répertoire spécifié de l’artefact dans l’archive retournée. Fonctionne uniquement pour les répertoires d’artefacts. La valeur par défaut est true.

preferRedirect

boolean

Définissez la valeur true pour obtenir la réponse de redirection qui conduit au flux avec du contenu. La valeur par défaut est false.

Retours

Promise<FileContainerItem[]>