TfvcRestClient 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

TfvcRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createChangeset(TfvcChangeset, string)	Créez un nouvel ensemble de modifications.
getBatchedChangesets(TfvcChangesetsRequestData)	Renvoie des ensembles de modifications pour une liste donnée d’ID d’ensemble de modifications.
getBranch(string, string, boolean, boolean)	Obtenez une seule hiérarchie de branches au chemin d’accès donné avec des parents ou des enfants comme spécifié.
getBranches(string, boolean, boolean, boolean, boolean)	Obtenez une collection de racines de branches - des enfants de premier niveau, des branches sans parents.
getBranchRefs(string, string, boolean, boolean)	Obtenir les hiérarchies de branches en dessous du scopePath spécifié
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Récupération d’un ensemble de modifications tfvc
getChangesetChanges(number, number, number)	Récupérez les modifications Tfvc pour un ensemble de modifications donné.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Récupérer les ensembles de modifications tfvc
getChangesetWorkItems(number)	Récupère les éléments de travail associés à un ensemble de modifications particulier.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Obtenir une liste d’articles Tfvc
getItemsBatch(TfvcItemRequestData, string)	Publier pour récupérer un ensemble d’éléments à partir d’une liste de chemins d’accès ou d’un long chemin. Permet de spécifier les descripteurs recursionLevel et version pour chaque chemin.
getItemsBatchZip(TfvcItemRequestData, string)	Publier pour récupérer un ensemble d’éléments à partir d’une liste de chemins d’accès ou d’un long chemin. Permet de spécifier les descripteurs recursionLevel et version pour chaque chemin.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.
getLabel(string, TfvcLabelRequestData, string)	Obtenez une seule étiquette profonde.
getLabelItems(string, number, number)	Obtenez des articles sous une étiquette.
getLabels(TfvcLabelRequestData, string, number, number)	Obtenez une collection de références d’étiquettes peu profondes.
getShelveset(string, TfvcShelvesetRequestData)	Obtenez un seul ensemble de étagères profondes.
getShelvesetChanges(string, number, number)	Obtenez les modifications incluses dans un ensemble de réservations.
getShelvesets(TfvcShelvesetRequestData, number, number)	Renvoie une collection de références de jeux de fonds peu profonds.
getShelvesetWorkItems(string)	Obtenir des éléments de travail associés à un ensemble de réservations.
getTfvcStatistics(string, string)	Fournit le nombre de fichiers et d’octets non compressés pour une collection/un projet à une portée particulière pour TFVC.

Détails du constructeur

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createChangeset(TfvcChangeset, string)

Créez un nouvel ensemble de modifications.

function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>

Paramètres

changeset

TfvcChangeset

project

string

ID de projet ou nom du projet

Retours

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Renvoie des ensembles de modifications pour une liste donnée d’ID d’ensemble de modifications.

function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>

Paramètres

changesetsRequestData

TfvcChangesetsRequestData

Liste des ID d’ensemble de modifications.

Retours

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Obtenez une seule hiérarchie de branches au chemin d’accès donné avec des parents ou des enfants comme spécifié.

function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>

Paramètres

path

string

Chemin d’accès complet à la branche. Par défaut : $/ Exemples : $/, $/MonProjet, $/MonProjet/UnDossier.

project

string

ID de projet ou nom du projet

includeParent

boolean

Renvoie la branche parente, le cas échéant. Valeur par défaut : False

includeChildren

boolean

Retournez les branches enfants, s’il y en a. Valeur par défaut : False

Retours

Promise<TfvcBranch>

getBranches(string, boolean, boolean, boolean, boolean)

Obtenez une collection de racines de branches - des enfants de premier niveau, des branches sans parents.

function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>

Paramètres

project

string

ID de projet ou nom du projet

includeParent

boolean

Renvoie la branche parente, le cas échéant. Valeur par défaut : False

includeChildren

boolean

Renvoyez les branches enfants pour chaque branche racine. Valeur par défaut : False

includeDeleted

boolean

Retournez les branches supprimées. Valeur par défaut : False

includeLinks

boolean

Liens de retour. Valeur par défaut : False

Retours

Promise<TfvcBranch[]>

getBranchRefs(string, string, boolean, boolean)

Obtenir les hiérarchies de branches en dessous du scopePath spécifié

function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>

Paramètres

scopePath

string

Chemin d’accès complet à la branche. Par défaut : $/ Exemples : $/, $/MonProjet, $/MonProjet/UnDossier.

project

string

ID de projet ou nom du projet

includeDeleted

boolean

Retournez les branches supprimées. Valeur par défaut : False

includeLinks

boolean

Liens de retour. Valeur par défaut : False

Retours

Promise<TfvcBranchRef[]>

getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)

Récupération d’un ensemble de modifications tfvc

function getChangeset(id: number, project?: string, maxChangeCount?: number, includeDetails?: boolean, includeWorkItems?: boolean, maxCommentLength?: number, includeSourceRename?: boolean, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangeset>

Paramètres

id

number

Editeur d’ensemble de modifications à récupérer.

project

string

ID de projet ou nom du projet

maxChangeCount

number

Nombre de modifications à renvoyer (maximum 100 modifications) Par défaut : 0

includeDetails

boolean

Incluez les détails de la politique et les notes d’enregistrement dans la réponse. Valeur par défaut : false

includeWorkItems

boolean

Inclure les éléments de travail. Valeur par défaut : false

maxCommentLength

number

Incluez des détails sur les éléments de travail associés dans la réponse. Valeur par défaut : null

includeSourceRename

boolean

Inclure les renoms. Valeur par défaut : false

skip

number

Nombre de résultats à ignorer. Valeur par défaut : null

top

number

Le nombre maximal de résultats à renvoyer. Valeur par défaut : null

orderby

string

Par défaut, les résultats sont triés par ID par ordre décroissant. Utilisez id asc pour trier par ID dans l’ordre croissant.

searchCriteria

TfvcChangesetSearchCriteria

Critères suivants disponibles (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Par défaut : null

Retours

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Récupérez les modifications Tfvc pour un ensemble de modifications donné.

function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>

Paramètres

id

number

ID de l’ensemble de modifications. Valeur par défaut : null

skip

number

Nombre de résultats à ignorer. Valeur par défaut : null

top

number

Le nombre maximal de résultats à renvoyer. Valeur par défaut : null

Retours

Promise<PagedList<TfvcChange>>

getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)

Récupérer les ensembles de modifications tfvc

function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>

Paramètres

project

string

ID de projet ou nom du projet

maxCommentLength

number

Incluez des détails sur les éléments de travail associés dans la réponse. Valeur par défaut : null

skip

number

Nombre de résultats à ignorer. Valeur par défaut : null

top

number

Le nombre maximal de résultats à renvoyer. Valeur par défaut : null

orderby

string

Par défaut, les résultats sont triés par ID par ordre décroissant. Utilisez id asc pour trier par ID dans l’ordre croissant.

searchCriteria

TfvcChangesetSearchCriteria

Critères suivants disponibles (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Par défaut : null

Retours

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Récupère les éléments de travail associés à un ensemble de modifications particulier.

function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>

Paramètres

id

number

ID de l’ensemble de modifications.

Retours

Promise<AssociatedWorkItem[]>

getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.

function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>

Paramètres

path

string

Chemin de contrôle de version d’un article individuel à renvoyer.

project

string

ID de projet ou nom du projet

fileName

string

Nom de fichier de l’élément retourné.

download

boolean

Si la valeur est true, créez une pièce jointe téléchargeable.

scopePath

string

Chemin de contrôle de version d’un dossier pour renvoyer plusieurs éléments.

recursionLevel

VersionControlRecursionType

Aucun (uniquement l’élément) ou OneLevel (contenu d’un dossier).

versionDescriptor

TfvcVersionDescriptor

Descripteur de version. La valeur par défaut est Null.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

Retours

Promise<TfvcItem>

getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.

function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Paramètres

path

string

Chemin de contrôle de version d’un article individuel à renvoyer.

project

string

ID de projet ou nom du projet

fileName

string

Nom de fichier de l’élément retourné.

download

boolean

Si la valeur est true, créez une pièce jointe téléchargeable.

scopePath

string

Chemin de contrôle de version d’un dossier pour renvoyer plusieurs éléments.

recursionLevel

VersionControlRecursionType

Aucun (uniquement l’élément) ou OneLevel (contenu d’un dossier).

versionDescriptor

TfvcVersionDescriptor

Descripteur de version. La valeur par défaut est Null.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)

Obtenir une liste d’articles Tfvc

function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>

Paramètres

project

string

ID de projet ou nom du projet

scopePath

string

Chemin de contrôle de version d’un dossier pour renvoyer plusieurs éléments.

recursionLevel

VersionControlRecursionType

Aucun (uniquement l’élément) ou OneLevel (contenu d’un dossier).

includeLinks

boolean

True pour inclure des liens.

versionDescriptor

TfvcVersionDescriptor

Retours

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Publier pour récupérer un ensemble d’éléments à partir d’une liste de chemins d’accès ou d’un long chemin. Permet de spécifier les descripteurs recursionLevel et version pour chaque chemin.

function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>

Paramètres

itemRequestData

TfvcItemRequestData

project

string

ID de projet ou nom du projet

Retours

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Publier pour récupérer un ensemble d’éléments à partir d’une liste de chemins d’accès ou d’un long chemin. Permet de spécifier les descripteurs recursionLevel et version pour chaque chemin.

function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>

Paramètres

itemRequestData

TfvcItemRequestData

project

string

ID de projet ou nom du projet

Retours

Promise<ArrayBuffer>

getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.

function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>

Paramètres

path

string

Chemin de contrôle de version d’un article individuel à renvoyer.

project

string

ID de projet ou nom du projet

fileName

string

Nom de fichier de l’élément retourné.

download

boolean

Si la valeur est true, créez une pièce jointe téléchargeable.

scopePath

string

Chemin de contrôle de version d’un dossier pour renvoyer plusieurs éléments.

recursionLevel

VersionControlRecursionType

Aucun (uniquement l’élément) ou OneLevel (contenu d’un dossier).

versionDescriptor

TfvcVersionDescriptor

Descripteur de version. La valeur par défaut est Null.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

Retours

Promise<string>

getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.

function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Paramètres

path

string

Chemin de contrôle de version d’un article individuel à renvoyer.

project

string

ID de projet ou nom du projet

fileName

string

Nom de fichier de l’élément retourné.

download

boolean

Si la valeur est true, créez une pièce jointe téléchargeable.

scopePath

string

Chemin de contrôle de version d’un dossier pour renvoyer plusieurs éléments.

recursionLevel

VersionControlRecursionType

Aucun (uniquement l’élément) ou OneLevel (contenu d’un dossier).

versionDescriptor

TfvcVersionDescriptor

Descripteur de version. La valeur par défaut est Null.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Obtenez une seule étiquette profonde.

function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>

Paramètres

labelId

string

Identificateur unique de l’étiquette

requestData

TfvcLabelRequestData

maxItemCount

project

string

ID de projet ou nom du projet

Retours

Promise<TfvcLabel>

getLabelItems(string, number, number)

Obtenez des articles sous une étiquette.

function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>

Paramètres

labelId

string

Identificateur unique de l’étiquette

top

number

Nombre maximum d’articles à retourner

skip

number

Nombre d’articles à sauter

Retours

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

Obtenez une collection de références d’étiquettes peu profondes.

function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>

Paramètres

requestData

TfvcLabelRequestData

labelScope, nom, propriétaire et itemLabelFilter

project

string

ID de projet ou nom du projet

top

number

Nombre maximal d’étiquettes à renvoyer, par défaut à 100 lorsqu’il n’est pas défini

skip

number

Nombre d’étiquettes à sauter

Retours

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Obtenez un seul ensemble de étagères profondes.

function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>

Paramètres

shelvesetId

string

L’identifiant unique du Shelveset

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount et maxCommentLength

Retours

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Obtenez les modifications incluses dans un ensemble de réservations.

function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>

Paramètres

shelvesetId

string

L’identifiant unique du Shelveset

top

number

Nombre maximum de modifications à retourner

skip

number

Nombre de modifications à ignorer

Retours

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Renvoie une collection de références de jeux de fonds peu profonds.

function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>

Paramètres

requestData

TfvcShelvesetRequestData

name, owner et maxCommentLength

top

number

Nombre maximum d’étagères à retourner

skip

number

Nombre d’étagères à sauter

Retours

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Obtenir des éléments de travail associés à un ensemble de réservations.

function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>

Paramètres

shelvesetId

string

L’identifiant unique du Shelveset

Retours

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Fournit le nombre de fichiers et d’octets non compressés pour une collection/un projet à une portée particulière pour TFVC.

function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>

Paramètres

project

string

ID de projet ou nom du projet

scopePath

string

'$/' pour la collection, '$/project' pour un projet spécifique

Retours

Promise<TfvcStatistics>