TfvcRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes aux 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)	Retourne des ensembles de modifications pour une liste donnée d’ID d’ensemble de modifications.
getBranch(string, string, boolean, boolean)	Obtenez une hiérarchie de branche unique au niveau du chemin donné avec les parents ou les enfants comme spécifié.
getBranches(string, boolean, boolean, boolean, boolean)	Obtenez une collection de racines de branche : enfants de premier niveau, branches sans parents.
getBranchRefs(string, string, boolean, boolean)	Obtenir les hiérarchies de branche sous le scopePath spécifié
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Récupérer un ensemble de modifications Tfvc
getChangesetChanges(number, number, number)	Récupérer les modifications Tfvc pour un ensemble de modifications donné.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Récupérer des 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)	Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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)	Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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 la liste des éléments Tfvc
getItemsBatch(TfvcItemRequestData, string)	Post pour récupérer un ensemble d’éléments en fonction d’une liste de chemins ou d’un chemin long. Permet de spécifier les descripteurs recursionLevel et de version pour chaque chemin d’accès.
getItemsBatchZip(TfvcItemRequestData, string)	Post pour récupérer un ensemble d’éléments en fonction d’une liste de chemins ou d’un chemin long. Permet de spécifier les descripteurs recursionLevel et de version pour chaque chemin d’accès.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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)	Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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)	Obtenir des éléments sous une étiquette.
getLabels(TfvcLabelRequestData, string, number, number)	Obtenez une collection de références d’étiquettes superficielles.
getShelveset(string, TfvcShelvesetRequestData)	Obtenez un seul ensemble de étagères profond.
getShelvesetChanges(string, number, number)	Obtenir les modifications incluses dans un ensemble d’étagères.
getShelvesets(TfvcShelvesetRequestData, number, number)	Retourne une collection de références de jeu d’étagères peu profondes.
getShelvesetWorkItems(string)	Obtenir des éléments de travail associés à un jeu d’étagères.
getTfvcStatistics(string, string)	Fournit le nombre de fichiers et les octets non compressés pour une collection/un projet dans une étendue 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)

Retourne 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 hiérarchie de branche unique au niveau du chemin donné avec les parents ou les 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. Valeur par défaut : $/ Exemples : $/, $/MyProject, $/MyProject/SomeFolder.

project

string

ID de projet ou nom du projet

includeParent

boolean

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

includeChildren

boolean

Retourne des branches enfants, le cas échéant. Valeur par défaut : False

Retours

Promise<TfvcBranch>

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

Obtenez une collection de racines de branche : enfants de premier niveau, 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

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

includeChildren

boolean

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

includeDeleted

boolean

Retourne 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 branche sous le 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. Valeur par défaut : $/ Exemples : $/, $/MyProject, $/MyProject/SomeFolder.

project

string

ID de projet ou nom du projet

includeDeleted

boolean

Retourne 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érer 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

Id de l’ensemble de modifications à récupérer.

project

string

ID de projet ou nom du projet

maxChangeCount

number

Nombre de modifications à retourner (maximum 100 modifications) Valeur par défaut : 0

includeDetails

boolean

Incluez les détails de la stratégie et les notes de case activée dans la réponse. Par défaut : false

includeWorkItems

boolean

Inclure des éléments de travail. 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 renommages. 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

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

searchCriteria

TfvcChangesetSearchCriteria

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

Retours

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Récupérer 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 des 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

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

searchCriteria

TfvcChangesetSearchCriteria

Critères disponibles suivants (.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)

Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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 du contrôle de version d’un élément individuel à retourner.

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 du contrôle de version d’un dossier pour retourner 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 sur true pour inclure le contenu de l’élément lors de la demande json. La valeur par défaut est false.

Retours

Promise<TfvcItem>

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

Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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 du contrôle de version d’un élément individuel à retourner.

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 du contrôle de version d’un dossier pour retourner 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 sur true pour inclure le contenu de l’élément lors de la demande json. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

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

Obtenir la liste des éléments 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 du contrôle de version d’un dossier pour retourner 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)

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

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)

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

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)

Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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 du contrôle de version d’un élément individuel à retourner.

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 du contrôle de version d’un dossier pour retourner 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 sur true pour inclure le contenu de l’élément lors de la demande json. La valeur par défaut est false.

Retours

Promise<string>

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

Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’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 du contrôle de version d’un élément individuel à retourner.

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 du contrôle de version d’un dossier pour retourner 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 sur true pour inclure le contenu de l’élément lors de la demande 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)

Obtenir des éléments 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 maximal d’éléments à retourner

skip

number

Nombre d’éléments à ignorer

Retours

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

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

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

Paramètres

requestData

TfvcLabelRequestData

labelScope, name, owner et itemLabelFilter

project

string

ID de projet ou nom du projet

top

number

Nombre maximal d’étiquettes à retourner, la valeur par défaut est 100 quand elle n’est pas définie

skip

number

Nombre d’étiquettes à ignorer

Retours

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Obtenez un seul ensemble de étagères profond.

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

Paramètres

shelvesetId

string

ID unique du jeu d’étagères

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount et maxCommentLength

Retours

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Obtenir les modifications incluses dans un ensemble d’étagères.

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

Paramètres

shelvesetId

string

ID unique du jeu d’étagères

top

number

Nombre maximal de modifications à retourner

skip

number

Nombre de modifications à ignorer

Retours

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Retourne une collection de références de jeu d’étagères peu profondes.

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

Paramètres

requestData

TfvcShelvesetRequestData

name, owner et maxCommentLength

top

number

Nombre maximal de jeux d’étagères à retourner

skip

number

Nombre de jeux d’étagères à ignorer

Retours

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Obtenir des éléments de travail associés à un jeu d’étagères.

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

Paramètres

shelvesetId

string

ID unique du jeu d’étagères

Retours

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Fournit le nombre de fichiers et les octets non compressés pour une collection/un projet dans une étendue 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>