TfvcRestClient class
Classe di base da usare (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
| Tfvc |
Proprietà
| RESOURCE_AREA_ID |
Metodi
| create |
Creare un nuovo insieme di modifiche. |
| get |
Restituisce gli insiemi di modifiche per un determinato elenco di ID dell'insieme di modifiche. |
| get |
Ottenere una singola gerarchia di rami nel percorso specificato con i genitori o i figli come specificato. |
| get |
Procuratevi una collezione di radici di rami: figli di primo livello, rami senza genitori. |
| get |
Ottenere le gerarchie di rami sotto l'ambito Path specificato |
| get |
Recuperare un insieme di modifiche Tfvc |
| get |
Recuperare le modifiche Tfvc per un determinato insieme di modifiche. |
| get |
Recupera insiemi di modifiche Tfvc |
| get |
Recupera gli elementi di lavoro associati a un determinato insieme di modifiche. |
| get |
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download. |
| get |
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download. |
| get |
Ottenere un elenco di elementi Tfvc |
| get |
Post per il recupero di un insieme di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori recursionLevel e version per ogni percorso. |
| get |
Post per il recupero di un insieme di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori recursionLevel e version per ogni percorso. |
| get |
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download. |
| get |
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download. |
| get |
Ottieni un'unica etichetta profonda. |
| get |
Ottenere gli elementi sotto un'etichetta. |
| get |
Ottieni una raccolta di riferimenti di etichette poco profondi. |
| get |
Ottenere un'unica area di sospensione profonda. |
| get |
Ottenere le modifiche incluse in un'area di sospensione. |
| get |
Restituisce una raccolta di riferimenti all'area di sospensione poco profondi. |
| get |
Ottenere gli elementi di lavoro associati a un'area di sospensione. |
| get |
Fornisce il numero di file e i byte non compressi per una raccolta/progetto in un determinato ambito per TFVC. |
Dettagli costruttore
TfvcRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValore della proprietà
string
Dettagli metodo
createChangeset(TfvcChangeset, string)
Creare un nuovo insieme 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 gli insiemi di modifiche per un determinato elenco di ID dell'insieme di modifiche.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parametri
- changesetsRequestData
- TfvcChangesetsRequestData
Elenco degli ID degli insiemi di modifiche.
Restituisce
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Ottenere una singola gerarchia di rami nel percorso specificato con i genitori o i figli 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. Impostazione predefinita: False
- includeChildren
-
boolean
Restituisci rami figlio, se presenti. Impostazione predefinita: False
Restituisce
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Procuratevi una collezione di radici di rami: figli 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. Impostazione predefinita: False
- includeChildren
-
boolean
Restituire i rami figlio per ogni ramo radice. Impostazione predefinita: False
- includeDeleted
-
boolean
Restituisci i rami eliminati. Impostazione predefinita: False
- includeLinks
-
boolean
Link di ritorno. Impostazione predefinita: False
Restituisce
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Ottenere le gerarchie di rami sotto l'ambito Path 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
Restituisci i rami eliminati. Impostazione predefinita: False
- includeLinks
-
boolean
Link di ritorno. Impostazione predefinita: False
Restituisce
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Recuperare un insieme 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 insieme 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
Includi i dettagli dei criteri e le note di archiviazione nella risposta. Impostazione predefinita: false
- includeWorkItems
-
boolean
Includi elementi di lavoro. Impostazione predefinita: false
- maxCommentLength
-
number
Includere i dettagli sugli elementi di lavoro associati nella risposta. Impostazione predefinita: null
- includeSourceRename
-
boolean
Includi ridenominazioni. Impostazione predefinita: false
- skip
-
number
Numero di risultati da ignorare. Impostazione predefinita: null
- top
-
number
Numero massimo di risultati da restituire. Impostazione predefinita: null
- orderby
-
string
Per impostazione predefinita, i risultati vengono ordinati in base all'ID in ordine decrescente. Utilizzare id asc per ordinare in base all'ID in ordine crescente.
- searchCriteria
- TfvcChangesetSearchCriteria
Sono disponibili i seguenti criteri (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Impostazione predefinita: null
Restituisce
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Recuperare le modifiche Tfvc per un determinato insieme di modifiche.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parametri
- id
-
number
ID dell'insieme di modifiche. Impostazione predefinita: null
- skip
-
number
Numero di risultati da ignorare. Impostazione predefinita: null
- top
-
number
Numero massimo di risultati da restituire. Impostazione predefinita: null
Restituisce
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Recupera insiemi 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 i dettagli sugli elementi di lavoro associati nella risposta. Impostazione predefinita: null
- skip
-
number
Numero di risultati da ignorare. Impostazione predefinita: null
- top
-
number
Numero massimo di risultati da restituire. Impostazione predefinita: null
- orderby
-
string
Per impostazione predefinita, i risultati vengono ordinati in base all'ID in ordine decrescente. Utilizzare id asc per ordinare in base all'ID in ordine crescente.
- searchCriteria
- TfvcChangesetSearchCriteria
Sono disponibili i seguenti criteri (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Impostazione predefinita: null
Restituisce
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Recupera gli elementi di lavoro associati a un determinato insieme di modifiche.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Parametri
- id
-
number
ID dell'insieme di modifiche.
Restituisce
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente 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 del controllo della versione di un singolo elemento da restituire.
- project
-
string
ID progetto o nome progetto
- fileName
-
string
Nome del file dell'elemento restituito.
- download
-
boolean
Se true, crea 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 di versione. Il valore predefinito è Null.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. Il valore predefinito è false.
Restituisce
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente 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 del controllo della versione di un singolo elemento da restituire.
- project
-
string
ID progetto o nome progetto
- fileName
-
string
Nome del file dell'elemento restituito.
- download
-
boolean
Se true, crea 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 di versione. Il valore predefinito è Null.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. Il valore predefinito è 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 i collegamenti.
- versionDescriptor
- TfvcVersionDescriptor
Restituisce
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Post per il recupero di un insieme di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori recursionLevel e version 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 insieme di elementi in base a un elenco di percorsi o a un percorso lungo. Consente di specificare i descrittori recursionLevel e version 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)
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente 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 del controllo della versione di un singolo elemento da restituire.
- project
-
string
ID progetto o nome progetto
- fileName
-
string
Nome del file dell'elemento restituito.
- download
-
boolean
Se true, crea 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 di versione. Il valore predefinito è Null.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. Il valore predefinito è false.
Restituisce
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Ottiene i metadati e/o il contenuto dell'elemento per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o semplicemente 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 del controllo della versione di un singolo elemento da restituire.
- project
-
string
ID progetto o nome progetto
- fileName
-
string
Nome del file dell'elemento restituito.
- download
-
boolean
Se true, crea 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 di versione. Il valore predefinito è Null.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. Il valore predefinito è false.
Restituisce
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Ottieni un'unica etichetta profonda.
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 progetto
Restituisce
Promise<TfvcLabel>
getLabelItems(string, number, number)
Ottenere 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 articoli da restituire
- skip
-
number
Numero di elementi da saltare
Restituisce
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Ottieni una raccolta di riferimenti di etichette poco profondi.
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 progetto
- top
-
number
Numero massimo di etichette da restituire, il valore predefinito è 100 quando non è definito
- skip
-
number
Numero di etichette da saltare
Restituisce
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Ottenere un'unica area di sospensione profonda.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parametri
- shelvesetId
-
string
ID univoco dell'area di sospensione
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount e maxCommentLength
Restituisce
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Ottenere le modifiche incluse in un'area di sospensione.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parametri
- shelvesetId
-
string
ID univoco dell'area di sospensione
- 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 all'area di sospensione poco profondi.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parametri
- requestData
- TfvcShelvesetRequestData
nome, proprietario e maxCommentLength
- top
-
number
Numero massimo di aree di sospensione da restituire
- skip
-
number
Numero di aree di sospensione da ignorare
Restituisce
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Ottenere gli elementi di lavoro associati a un'area di sospensione.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parametri
- shelvesetId
-
string
ID univoco dell'area di sospensione
Restituisce
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Fornisce il numero di file e i byte non compressi per una raccolta/progetto in un determinato ambito per TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parametri
- project
-
string
ID progetto o nome progetto
- scopePath
-
string
'$/' per la raccolta, '$/project' per un progetto specifico
Restituisce
Promise<TfvcStatistics>