TfvcRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

TfvcRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

createChangeset(TfvcChangeset, string)	Creare un nuovo set di modifiche.
getBatchedChangesets(TfvcChangesetsRequestData)	Restituisce i set di modifiche per un determinato elenco di ID set di modifiche.
getBranch(string, string, boolean, boolean)	Ottenere una singola gerarchia di rami nel percorso specificato con i genitori o gli elementi figlio come specificato.
getBranches(string, boolean, boolean, boolean, boolean)	Ottenere una raccolta di radici di ramo- elementi figlio di primo livello, rami senza genitori.
getBranchRefs(string, string, boolean, boolean)	Ottenere gerarchie di branch sotto il percorso scopePath specificato
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Recuperare un set di modifiche tfvc
getChangesetChanges(number, number, number)	Recuperare le modifiche di Tfvc per un determinato set di modifiche.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Recuperare i set di modifiche tfvc
getChangesetWorkItems(number)	Recupera gli elementi di lavoro associati a un set di modifiche specifico.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Ottenere un elenco di elementi Tfvc
getItemsBatch(TfvcItemRequestData, string)	Post per il recupero di un set di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori ricorsivoLevel e versione per ogni percorso.
getItemsBatchZip(TfvcItemRequestData, string)	Post per il recupero di un set di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori ricorsivoLevel e versione per ogni percorso.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.
getLabel(string, TfvcLabelRequestData, string)	Ottenere una singola etichetta completa.
getLabelItems(string, number, number)	Ottiene gli elementi sotto un'etichetta.
getLabels(TfvcLabelRequestData, string, number, number)	Ottenere una raccolta di riferimenti a etichette superficiali.
getShelveset(string, TfvcShelvesetRequestData)	Ottieni un unico scaffale profondo.
getShelvesetChanges(string, number, number)	Ottenere le modifiche incluse in uno scaffale.
getShelvesets(TfvcShelvesetRequestData, number, number)	Restituisce una raccolta di riferimenti al set di scaffali superficiali.
getShelvesetWorkItems(string)	Ottiene gli elementi di lavoro associati a un set di scaffali.
getTfvcStatistics(string, string)	Fornisce conteggio file e byte non compressi per una raccolta o un progetto in un ambito specifico per TFVC.

Dettagli costruttore

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

createChangeset(TfvcChangeset, string)

Creare un nuovo set di modifiche.

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

Parametri

changeset

TfvcChangeset

project

string

ID progetto o nome progetto

Restituisce

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Restituisce i set di modifiche per un determinato elenco di ID set di modifiche.

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

Parametri

changesetsRequestData

TfvcChangesetsRequestData

Elenco degli ID set di modifiche.

Restituisce

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Ottenere una singola gerarchia di rami nel percorso specificato con i genitori o gli elementi figlio come specificato.

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

Parametri

path

string

Percorso completo del ramo. Impostazione predefinita: $/ Esempi: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

ID progetto o nome progetto

includeParent

boolean

Restituisce il ramo padre, se presente. Valore predefinito: False

includeChildren

boolean

Restituisce rami figlio, se presenti. Valore predefinito: False

Restituisce

Promise<TfvcBranch>

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

Ottenere una raccolta di radici di ramo- elementi figlio di primo livello, rami senza genitori.

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

Parametri

project

string

ID progetto o nome progetto

includeParent

boolean

Restituisce il ramo padre, se presente. Valore predefinito: False

includeChildren

boolean

Restituisce i rami figlio per ogni ramo radice. Valore predefinito: False

includeDeleted

boolean

Restituisce rami eliminati. Valore predefinito: False

includeLinks

boolean

Restituisce collegamenti. Valore predefinito: False

Restituisce

Promise<TfvcBranch[]>

getBranchRefs(string, string, boolean, boolean)

Ottenere gerarchie di branch sotto il percorso scopePath specificato

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

Parametri

scopePath

string

Percorso completo del ramo. Impostazione predefinita: $/ Esempi: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

ID progetto o nome progetto

includeDeleted

boolean

Restituisce rami eliminati. Valore predefinito: False

includeLinks

boolean

Restituisce collegamenti. Valore predefinito: False

Restituisce

Promise<TfvcBranchRef[]>

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

Recuperare un set di modifiche 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>

Parametri

id

number

ID set di modifiche da recuperare.

project

string

ID progetto o nome progetto

maxChangeCount

number

Numero di modifiche da restituire (massimo 100 modifiche) Impostazione predefinita: 0

includeDetails

boolean

Includere i dettagli dei criteri e le note di check-in nella risposta. Valore predefinito: false

includeWorkItems

boolean

Includere elementi di lavoro. Valore predefinito: false

maxCommentLength

number

Includere dettagli sugli elementi di lavoro associati nella risposta. Impostazione predefinita: Null

includeSourceRename

boolean

Includi rinomina. Valore predefinito: false

skip

number

Numero di risultati da ignorare. Impostazione predefinita: Null

top

number

Il numero massimo di risultati da restituire. Impostazione predefinita: Null

orderby

string

I risultati vengono ordinati in base all'ID in ordine decrescente per impostazione predefinita. Usare id asc per ordinare in base all'ID in ordine crescente.

searchCriteria

TfvcChangesetSearchCriteria

I criteri seguenti sono disponibili (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: Null

Restituisce

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Recuperare le modifiche di Tfvc per un determinato set di modifiche.

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

Parametri

id

number

ID del set di modifiche. Impostazione predefinita: Null

skip

number

Numero di risultati da ignorare. Impostazione predefinita: Null

top

number

Il numero massimo di risultati da restituire. Impostazione predefinita: Null

Restituisce

Promise<PagedList<TfvcChange>>

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

Recuperare i set di modifiche tfvc

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

Parametri

project

string

ID progetto o nome progetto

maxCommentLength

number

Includere dettagli sugli elementi di lavoro associati nella risposta. Impostazione predefinita: Null

skip

number

Numero di risultati da ignorare. Impostazione predefinita: Null

top

number

Il numero massimo di risultati da restituire. Impostazione predefinita: Null

orderby

string

I risultati vengono ordinati in base all'ID in ordine decrescente per impostazione predefinita. Usare id asc per ordinare in base all'ID in ordine crescente.

searchCriteria

TfvcChangesetSearchCriteria

I criteri seguenti sono disponibili (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: Null

Restituisce

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Recupera gli elementi di lavoro associati a un set di modifiche specifico.

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

Parametri

id

number

ID del set di modifiche.

Restituisce

Promise<AssociatedWorkItem[]>

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

Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.

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

Parametri

path

string

Percorso di controllo della versione di un singolo elemento da restituire.

project

string

ID progetto o nome progetto

fileName

string

nome file dell'elemento restituito.

download

boolean

Se true, creare un allegato scaricabile.

scopePath

string

Percorso del controllo della versione di una cartella per restituire più elementi.

recursionLevel

VersionControlRecursionType

Nessuno (solo l'elemento) o OneLevel (contenuto di una cartella).

versionDescriptor

TfvcVersionDescriptor

Descrittore della versione. Il valore predefinito è null.

includeContent

boolean

Impostare su true per includere il contenuto dell'elemento durante la richiesta di json. L'impostazione predefinita è false.

Restituisce

Promise<TfvcItem>

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

Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.

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

Parametri

path

string

Percorso di controllo della versione di un singolo elemento da restituire.

project

string

ID progetto o nome progetto

fileName

string

nome file dell'elemento restituito.

download

boolean

Se true, creare un allegato scaricabile.

scopePath

string

Percorso del controllo della versione di una cartella per restituire più elementi.

recursionLevel

VersionControlRecursionType

Nessuno (solo l'elemento) o OneLevel (contenuto di una cartella).

versionDescriptor

TfvcVersionDescriptor

Descrittore della versione. Il valore predefinito è null.

includeContent

boolean

Impostare su true per includere il contenuto dell'elemento durante la richiesta di json. L'impostazione predefinita è false.

Restituisce

Promise<ArrayBuffer>

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

Ottenere un elenco di elementi Tfvc

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

Parametri

project

string

ID progetto o nome progetto

scopePath

string

Percorso del controllo della versione di una cartella per restituire più elementi.

recursionLevel

VersionControlRecursionType

Nessuno (solo l'elemento) o OneLevel (contenuto di una cartella).

includeLinks

boolean

True per includere collegamenti.

versionDescriptor

TfvcVersionDescriptor

Restituisce

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Post per il recupero di un set di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori ricorsivoLevel e versione per ogni percorso.

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

Parametri

itemRequestData

TfvcItemRequestData

project

string

ID progetto o nome progetto

Restituisce

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Post per il recupero di un set di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori ricorsivoLevel e versione per ogni percorso.

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

Parametri

itemRequestData

TfvcItemRequestData

project

string

ID progetto o nome progetto

Restituisce

Promise<ArrayBuffer>

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

Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.

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

Parametri

path

string

Percorso di controllo della versione di un singolo elemento da restituire.

project

string

ID progetto o nome progetto

fileName

string

nome file dell'elemento restituito.

download

boolean

Se true, creare un allegato scaricabile.

scopePath

string

Percorso del controllo della versione di una cartella per restituire più elementi.

recursionLevel

VersionControlRecursionType

Nessuno (solo l'elemento) o OneLevel (contenuto di una cartella).

versionDescriptor

TfvcVersionDescriptor

Descrittore della versione. Il valore predefinito è null.

includeContent

boolean

Impostare su true per includere il contenuto dell'elemento durante la richiesta di json. L'impostazione predefinita è false.

Restituisce

Promise<string>

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

Ottenere metadati dell'elemento e/o contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.

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

Parametri

path

string

Percorso di controllo della versione di un singolo elemento da restituire.

project

string

ID progetto o nome progetto

fileName

string

nome file dell'elemento restituito.

download

boolean

Se true, creare un allegato scaricabile.

scopePath

string

Percorso del controllo della versione di una cartella per restituire più elementi.

recursionLevel

VersionControlRecursionType

Nessuno (solo l'elemento) o OneLevel (contenuto di una cartella).

versionDescriptor

TfvcVersionDescriptor

Descrittore della versione. Il valore predefinito è null.

includeContent

boolean

Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.

Restituisce

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Ottenere una singola etichetta completa.

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

Parametri

labelId

string

Identificatore univoco dell'etichetta

requestData

TfvcLabelRequestData

maxItemCount

project

string

ID progetto o nome del progetto

Restituisce

Promise<TfvcLabel>

getLabelItems(string, number, number)

Ottiene gli elementi sotto un'etichetta.

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

Parametri

labelId

string

Identificatore univoco dell'etichetta

top

number

Numero massimo di elementi da restituire

skip

number

Numero di elementi da ignorare

Restituisce

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

Ottenere una raccolta di riferimenti a etichette superficiali.

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

Parametri

requestData

TfvcLabelRequestData

labelScope, nome, proprietario e itemLabelFilter

project

string

ID progetto o nome del progetto

top

number

Numero massimo di etichette da restituire, il valore predefinito è 100 se non definito

skip

number

Numero di etichette da ignorare

Restituisce

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Ottieni un unico scaffale profondo.

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

Parametri

shelvesetId

string

ID univoco di Shelveset

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount e maxCommentLength

Restituisce

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Ottenere le modifiche incluse in uno scaffale.

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

Parametri

shelvesetId

string

ID univoco di Shelveset

top

number

Numero massimo di modifiche da restituire

skip

number

Numero di modifiche da ignorare

Restituisce

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Restituisce una raccolta di riferimenti al set di scaffali superficiali.

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

Parametri

requestData

TfvcShelvesetRequestData

name, owner e maxCommentLength

top

number

Numero massimo di scaffali da restituire

skip

number

Numero di scaffali da ignorare

Restituisce

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Ottiene gli elementi di lavoro associati a un set di scaffali.

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

Parametri

shelvesetId

string

ID univoco di Shelveset

Restituisce

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Fornisce conteggio file e byte non compressi per una raccolta o un progetto in un ambito specifico per TFVC.

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

Parametri

project

string

ID progetto o nome del progetto

scopePath

string

'$/' per la raccolta, '$/project' per un progetto specifico

Restituisce

Promise<TfvcStatistics>