TfvcRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's
- Extends
Constructors
| Tfvc |
Eigenschappen
| RESOURCE_AREA_ID |
Methoden
| create |
Maak een nieuwe wijzigingenset. |
| get |
Retourneert changesets voor een opgegeven lijst met wijzigingenset-id's. |
| get |
Haal een hiërarchie met één vertakking op het opgegeven pad op met bovenliggende of onderliggende elementen zoals opgegeven. |
| get |
Haal een verzameling vertakkingswortels op, kinderen op het eerste niveau, vertakkingen zonder ouders. |
| get |
Vertakkingshiërarchieën ophalen onder het opgegeven scopePath |
| get |
Een Tfvc-wijzigingenset ophalen |
| get |
Tfvc-wijzigingen voor een bepaalde wijzigingenset ophalen. |
| get |
Tfvc-wijzigingensets ophalen |
| get |
Hiermee haalt u de werkitems op die zijn gekoppeld aan een bepaalde wijzigingenset. |
| get |
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download. |
| get |
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download. |
| get |
Een lijst met Tfvc-items ophalen |
| get |
Posten voor het ophalen van een set items op basis van een lijst met paden of een lang pad. Hiermee kunt u de recursionLevel- en versiedescriptors voor elk pad opgeven. |
| get |
Posten voor het ophalen van een set items op basis van een lijst met paden of een lang pad. Hiermee kunt u de recursionLevel- en versiedescriptors voor elk pad opgeven. |
| get |
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download. |
| get |
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download. |
| get |
Eén diep label ophalen. |
| get |
Items onder een label ophalen. |
| get |
Een verzameling ondiepe labelverwijzingen ophalen. |
| get |
Eén diepe plankenset. |
| get |
Haal wijzigingen op die zijn opgenomen in een plankenset. |
| get |
Retourneert een verzameling ondiepe verwijzingen naar een plankenset. |
| get |
Werkitems ophalen die zijn gekoppeld aan een plankenset. |
| get |
Biedt het aantal bestanden en niet-gecomprimeerde bytes voor een verzameling/project met een bepaald bereik voor TFVC. |
Constructordetails
TfvcRestClient(IVssRestClientOptions)
Eigenschapdetails
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringWaarde van eigenschap
string
Methodedetails
createChangeset(TfvcChangeset, string)
Maak een nieuwe wijzigingenset.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>Parameters
- changeset
- TfvcChangeset
- project
-
string
Project-id of projectnaam
Retouren
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
Retourneert changesets voor een opgegeven lijst met wijzigingenset-id's.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parameters
- changesetsRequestData
- TfvcChangesetsRequestData
Lijst met wijzigingenset-id's.
Retouren
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Haal een hiërarchie met één vertakking op het opgegeven pad op met bovenliggende of onderliggende elementen zoals opgegeven.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parameters
- path
-
string
Volledig pad naar de vertakking. Standaardinstelling: $/ Voorbeelden: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Project-id of projectnaam
- includeParent
-
boolean
Retourneer de bovenliggende vertakking, indien aanwezig. Standaardinstelling: Onwaar
- includeChildren
-
boolean
Retourneer onderliggende vertakkingen, indien aanwezig. Standaardinstelling: Onwaar
Retouren
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Haal een verzameling vertakkingswortels op, kinderen op het eerste niveau, vertakkingen zonder ouders.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>Parameters
- project
-
string
Project-id of projectnaam
- includeParent
-
boolean
Retourneer de bovenliggende vertakking, indien aanwezig. Standaardinstelling: Onwaar
- includeChildren
-
boolean
Retourneer de onderliggende vertakkingen voor elke hoofdbranch. Standaardinstelling: Onwaar
- includeDeleted
-
boolean
Verwijderde vertakkingen retourneren. Standaardinstelling: Onwaar
- includeLinks
-
boolean
Retourkoppelingen. Standaardinstelling: Onwaar
Retouren
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Vertakkingshiërarchieën ophalen onder het opgegeven scopePath
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parameters
- scopePath
-
string
Volledig pad naar de vertakking. Standaardinstelling: $/ Voorbeelden: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Project-id of projectnaam
- includeDeleted
-
boolean
Verwijderde vertakkingen retourneren. Standaardinstelling: Onwaar
- includeLinks
-
boolean
Retourkoppelingen. Standaardinstelling: Onwaar
Retouren
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Een Tfvc-wijzigingenset ophalen
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>Parameters
- id
-
number
De op te halen wijzigingenset-id.
- project
-
string
Project-id of projectnaam
- maxChangeCount
-
number
Aantal wijzigingen dat moet worden geretourneerd (maximaal 100 wijzigingen) Standaard: 0
- includeDetails
-
boolean
Voeg beleidsdetails en opmerkingen bij het inchecken toe aan het antwoord. Standaardinstelling: false
- includeWorkItems
-
boolean
Werkitems opnemen. Standaardinstelling: false
- maxCommentLength
-
number
Neem details op over gekoppelde werkitems in het antwoord. Standaardinstelling: null
- includeSourceRename
-
boolean
Namen opnemen. Standaardinstelling: false
- skip
-
number
Het aantal over te slaan resultaten. Standaardinstelling: null
- top
-
number
Het maximum aantal resultaten dat moet worden geretourneerd. Standaardinstelling: null
- orderby
-
string
Resultaten worden standaard gesorteerd op id in aflopende volgorde. Gebruik id asc om te sorteren op id in oplopende volgorde.
- searchCriteria
- TfvcChangesetSearchCriteria
De volgende beschikbare criteria (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standaard: null
Retouren
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Tfvc-wijzigingen voor een bepaalde wijzigingenset ophalen.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parameters
- id
-
number
Id van de wijzigingenset. Standaardinstelling: null
- skip
-
number
Het aantal over te slaan resultaten. Standaardinstelling: null
- top
-
number
Het maximum aantal resultaten dat moet worden geretourneerd. Standaardinstelling: null
Retouren
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Tfvc-wijzigingensets ophalen
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>Parameters
- project
-
string
Project-id of projectnaam
- maxCommentLength
-
number
Neem details op over gekoppelde werkitems in het antwoord. Standaardinstelling: null
- skip
-
number
Het aantal over te slaan resultaten. Standaardinstelling: null
- top
-
number
Het maximum aantal resultaten dat moet worden geretourneerd. Standaardinstelling: null
- orderby
-
string
Resultaten worden standaard gesorteerd op id in aflopende volgorde. Gebruik id asc om te sorteren op id in oplopende volgorde.
- searchCriteria
- TfvcChangesetSearchCriteria
De volgende beschikbare criteria (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standaard: null
Retouren
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Hiermee haalt u de werkitems op die zijn gekoppeld aan een bepaalde wijzigingenset.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Parameters
- id
-
number
Id van de wijzigingenset.
Retouren
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>Parameters
- path
-
string
Versiebeheerpad van een afzonderlijk item dat moet worden geretourneerd.
- project
-
string
Project-id of projectnaam
- fileName
-
string
de bestandsnaam van het geretourneerde item.
- download
-
boolean
Als dit waar is, maakt u een downloadbare bijlage.
- scopePath
-
string
Versiebeheerpad van een map om meerdere items te retourneren.
- recursionLevel
- VersionControlRecursionType
None (alleen het item) of OneLevel (inhoud van een map).
- versionDescriptor
- TfvcVersionDescriptor
Versiedescriptor. De standaardwaarde is null.
- includeContent
-
boolean
Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardinstelling is onwaar.
Retouren
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameters
- path
-
string
Versiebeheerpad van een afzonderlijk item dat moet worden geretourneerd.
- project
-
string
Project-id of projectnaam
- fileName
-
string
de bestandsnaam van het geretourneerde item.
- download
-
boolean
Als dit waar is, maakt u een downloadbare bijlage.
- scopePath
-
string
Versiebeheerpad van een map om meerdere items te retourneren.
- recursionLevel
- VersionControlRecursionType
None (alleen het item) of OneLevel (inhoud van een map).
- versionDescriptor
- TfvcVersionDescriptor
Versiedescriptor. De standaardwaarde is null.
- includeContent
-
boolean
Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardinstelling is onwaar.
Retouren
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Een lijst met Tfvc-items ophalen
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>Parameters
- project
-
string
Project-id of projectnaam
- scopePath
-
string
Versiebeheerpad van een map om meerdere items te retourneren.
- recursionLevel
- VersionControlRecursionType
None (alleen het item) of OneLevel (inhoud van een map).
- includeLinks
-
boolean
Waar om koppelingen op te nemen.
- versionDescriptor
- TfvcVersionDescriptor
Retouren
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Posten voor het ophalen van een set items op basis van een lijst met paden of een lang pad. Hiermee kunt u de recursionLevel- en versiedescriptors voor elk pad opgeven.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>Parameters
- itemRequestData
- TfvcItemRequestData
- project
-
string
Project-id of projectnaam
Retouren
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
Posten voor het ophalen van een set items op basis van een lijst met paden of een lang pad. Hiermee kunt u de recursionLevel- en versiedescriptors voor elk pad opgeven.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>Parameters
- itemRequestData
- TfvcItemRequestData
- project
-
string
Project-id of projectnaam
Retouren
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>Parameters
- path
-
string
Versiebeheerpad van een afzonderlijk item dat moet worden geretourneerd.
- project
-
string
Project-id of projectnaam
- fileName
-
string
de bestandsnaam van het geretourneerde item.
- download
-
boolean
Als dit waar is, maakt u een downloadbare bijlage.
- scopePath
-
string
Versiebeheerpad van een map om meerdere items te retourneren.
- recursionLevel
- VersionControlRecursionType
None (alleen het item) of OneLevel (inhoud van een map).
- versionDescriptor
- TfvcVersionDescriptor
Versiedescriptor. De standaardwaarde is null.
- includeContent
-
boolean
Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardinstelling is onwaar.
Retouren
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Metagegevens en/of inhoud van items ophalen voor één item. De downloadparameter geeft aan of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als een download.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameters
- path
-
string
Versiebeheerpad van een afzonderlijk item dat moet worden geretourneerd.
- project
-
string
Project-id of projectnaam
- fileName
-
string
de bestandsnaam van het geretourneerde item.
- download
-
boolean
Als dit waar is, maakt u een downloadbare bijlage.
- scopePath
-
string
Versiebeheerpad van een map om meerdere items te retourneren.
- recursionLevel
- VersionControlRecursionType
None (alleen het item) of OneLevel (inhoud van een map).
- versionDescriptor
- TfvcVersionDescriptor
Versiedescriptor. De standaardwaarde is null.
- includeContent
-
boolean
Stel in op true om iteminhoud op te nemen bij het aanvragen van json. De standaardinstelling is onwaar.
Retouren
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Eén diep label ophalen.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parameters
- labelId
-
string
Unieke id van label
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
Project-id of projectnaam
Retouren
Promise<TfvcLabel>
getLabelItems(string, number, number)
Items onder een label ophalen.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parameters
- labelId
-
string
Unieke id van label
- top
-
number
Maximum aantal items dat moet worden geretourneerd
- skip
-
number
Aantal items dat moet worden overgeslagen
Retouren
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Een verzameling ondiepe labelverwijzingen ophalen.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Parameters
- requestData
- TfvcLabelRequestData
labelScope, name, owner en itemLabelFilter
- project
-
string
Project-id of projectnaam
- top
-
number
Maximum aantal labels dat moet worden geretourneerd, wordt standaard ingesteld op 100 wanneer dit niet is gedefinieerd
- skip
-
number
Aantal labels dat moet worden overgeslagen
Retouren
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Eén diepe plankenset.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parameters
- shelvesetId
-
string
De unieke id van Shelveset
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount en maxCommentLength
Retouren
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Haal wijzigingen op die zijn opgenomen in een plankenset.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parameters
- shelvesetId
-
string
De unieke id van Shelveset
- top
-
number
Maximum aantal wijzigingen dat moet worden geretourneerd
- skip
-
number
Aantal wijzigingen dat moet worden overgeslagen
Retouren
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Retourneert een verzameling ondiepe verwijzingen naar een plankenset.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parameters
- requestData
- TfvcShelvesetRequestData
naam, eigenaar en maxCommentLength
- top
-
number
Maximum aantal planken dat moet worden geretourneerd
- skip
-
number
Aantal planken dat moet worden overgeslagen
Retouren
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Werkitems ophalen die zijn gekoppeld aan een plankenset.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parameters
- shelvesetId
-
string
De unieke id van Shelveset
Retouren
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Biedt het aantal bestanden en niet-gecomprimeerde bytes voor een verzameling/project met een bepaald bereik voor TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parameters
- project
-
string
Project-id of projectnaam
- scopePath
-
string
'$/' voor verzameling, '$/project' voor een specifiek project
Retouren
Promise<TfvcStatistics>
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor