TfvcRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Tfvc |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
| create |
Erstellen Sie ein neues Changeset. |
| get |
Gibt Changesets für eine bestimmte Liste von Changeset-IDs zurück. |
| get |
Rufen Sie eine Hierarchie für einen einzelnen Zweig im angegebenen Pfad mit übergeordneten oder untergeordneten Elementen ab. |
| get |
Rufen Sie eine Sammlung von Zweigwurzeln ab – untergeordnete Zweige der ersten Ebene, Zweige ohne übergeordnete Elemente. |
| get |
Abrufen von Verzweigungshierarchien unterhalb des angegebenen scopePath |
| get |
Abrufen eines TFVC-Changesets |
| get |
Abrufen von Tfvc-Änderungen für ein bestimmtes Changeset. |
| get |
Abrufen von TFVC-Changesets |
| get |
Ruft die Arbeitsaufgaben ab, die einem bestimmten Changeset zugeordnet sind. |
| get |
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird. |
| get |
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird. |
| get |
Abrufen einer Liste von Tfvc-Artikeln |
| get |
Posten Sie zum Abrufen einer Gruppe von Elementen, wenn eine Liste von Pfaden oder ein langer Pfad angegeben ist. Ermöglicht die Angabe der recursionLevel- und Versionsdeskriptoren für jeden Pfad. |
| get |
Posten Sie zum Abrufen einer Gruppe von Elementen, wenn eine Liste von Pfaden oder ein langer Pfad angegeben ist. Ermöglicht die Angabe der recursionLevel- und Versionsdeskriptoren für jeden Pfad. |
| get |
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird. |
| get |
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird. |
| get |
Holen Sie sich ein einzelnes tiefes Etikett. |
| get |
Abrufen von Elementen unter einem Etikett. |
| get |
Rufen Sie eine Sammlung flacher Beschriftungsverweise ab. |
| get |
Holen Sie sich ein einzelnes tiefes Shelveset. |
| get |
Abrufen von Änderungen, die in einem Shelveset enthalten sind. |
| get |
Gibt eine Auflistung flacher Shelvesetverweise zurück. |
| get |
Rufen Sie Arbeitselemente ab, die einem Shelveset zugeordnet sind. |
| get |
Stellt die Dateianzahl und unkomprimierte Bytes für eine Sammlung/ein Projekt in einem bestimmten Bereich für TFVC bereit. |
Details zum Konstruktor
TfvcRestClient(IVssRestClientOptions)
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
createChangeset(TfvcChangeset, string)
Erstellen Sie ein neues Changeset.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>Parameter
- changeset
- TfvcChangeset
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
Gibt Changesets für eine bestimmte Liste von Changeset-IDs zurück.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parameter
- changesetsRequestData
- TfvcChangesetsRequestData
Liste der Changeset-IDs.
Gibt zurück
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Rufen Sie eine Hierarchie für einen einzelnen Zweig im angegebenen Pfad mit übergeordneten oder untergeordneten Elementen ab.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parameter
- path
-
string
Vollständiger Pfad zum Zweig. Standardwert: $/ Beispiele: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projekt-ID oder Projektname
- includeParent
-
boolean
Gibt den übergeordneten Zweig zurück, falls vorhanden. Standardwert: Falsch
- includeChildren
-
boolean
Gibt untergeordnete Zweige zurück, falls vorhanden. Standardwert: Falsch
Gibt zurück
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Rufen Sie eine Sammlung von Zweigwurzeln ab – untergeordnete Zweige der ersten Ebene, Zweige ohne übergeordnete Elemente.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- includeParent
-
boolean
Gibt den übergeordneten Zweig zurück, falls vorhanden. Standardwert: Falsch
- includeChildren
-
boolean
Gibt die untergeordneten Zweige für jeden Stammzweig zurück. Standardwert: Falsch
- includeDeleted
-
boolean
Gelöschte Zweige zurückgeben. Standardwert: Falsch
- includeLinks
-
boolean
Links zurückgeben. Standardwert: Falsch
Gibt zurück
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Abrufen von Verzweigungshierarchien unterhalb des angegebenen scopePath
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parameter
- scopePath
-
string
Vollständiger Pfad zum Zweig. Standardwert: $/ Beispiele: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projekt-ID oder Projektname
- includeDeleted
-
boolean
Gelöschte Zweige zurückgeben. Standardwert: Falsch
- includeLinks
-
boolean
Links zurückgeben. Standardwert: Falsch
Gibt zurück
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Abrufen eines TFVC-Changesets
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>Parameter
- id
-
number
Changeset-ID, die abgerufen werden soll.
- project
-
string
Projekt-ID oder Projektname
- maxChangeCount
-
number
Anzahl der zurückzugebenden Änderungen (maximal 100 Änderungen) Standardwert: 0
- includeDetails
-
boolean
Fügen Sie Richtliniendetails und Eincheckhinweise in die Antwort ein. Standardwert: false
- includeWorkItems
-
boolean
Schließen Sie Arbeitselemente ein. Standardwert: false
- maxCommentLength
-
number
Fügen Sie Details zu zugeordneten Arbeitselementen in die Antwort ein. Standardwert: null
- includeSourceRename
-
boolean
Umbenennungen einschließen. Standardwert: false
- skip
-
number
Anzahl der zu überspringenden Ergebnisse. Standardwert: null
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse. Standardwert: null
- orderby
-
string
Die Ergebnisse werden standardmäßig in absteigender Reihenfolge nach ID sortiert. Verwenden Sie id asc, um nach ID in aufsteigender Reihenfolge zu sortieren.
- searchCriteria
- TfvcChangesetSearchCriteria
Folgende Kriterien verfügbar (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standardwert: null
Gibt zurück
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Abrufen von Tfvc-Änderungen für ein bestimmtes Changeset.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parameter
- id
-
number
ID des Changesets. Standardwert: null
- skip
-
number
Anzahl der zu überspringenden Ergebnisse. Standardwert: null
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse. Standardwert: null
Gibt zurück
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Abrufen von TFVC-Changesets
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- maxCommentLength
-
number
Fügen Sie Details zu zugeordneten Arbeitselementen in die Antwort ein. Standardwert: null
- skip
-
number
Anzahl der zu überspringenden Ergebnisse. Standardwert: null
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse. Standardwert: null
- orderby
-
string
Die Ergebnisse werden standardmäßig in absteigender Reihenfolge nach ID sortiert. Verwenden Sie id asc, um nach ID in aufsteigender Reihenfolge zu sortieren.
- searchCriteria
- TfvcChangesetSearchCriteria
Folgende Kriterien verfügbar (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standardwert: null
Gibt zurück
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Ruft die Arbeitsaufgaben ab, die einem bestimmten Changeset zugeordnet sind.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Parameter
- id
-
number
ID des Changesets.
Gibt zurück
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>Parameter
- path
-
string
Versionskontrollpfad eines einzelnen Elements, das zurückgegeben werden soll.
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Dateiname des zurückgegebenen Elements.
- download
-
boolean
Wenn true, erstellen Sie einen herunterladbaren Anhang.
- scopePath
-
string
Versionskontrollpfad eines Ordners, um mehrere Elemente zurückzugeben.
- recursionLevel
- VersionControlRecursionType
Keine (nur das Element) oder OneLevel (Inhalt eines Ordners).
- versionDescriptor
- TfvcVersionDescriptor
Versionsdeskriptor. Der Standardwert lautet null.
- includeContent
-
boolean
Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
Gibt zurück
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameter
- path
-
string
Versionskontrollpfad eines einzelnen Elements, das zurückgegeben werden soll.
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Dateiname des zurückgegebenen Elements.
- download
-
boolean
Wenn true, erstellen Sie einen herunterladbaren Anhang.
- scopePath
-
string
Versionskontrollpfad eines Ordners, um mehrere Elemente zurückzugeben.
- recursionLevel
- VersionControlRecursionType
Keine (nur das Element) oder OneLevel (Inhalt eines Ordners).
- versionDescriptor
- TfvcVersionDescriptor
Versionsdeskriptor. Der Standardwert lautet null.
- includeContent
-
boolean
Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
Gibt zurück
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Abrufen einer Liste von Tfvc-Artikeln
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- scopePath
-
string
Versionskontrollpfad eines Ordners, um mehrere Elemente zurückzugeben.
- recursionLevel
- VersionControlRecursionType
Keine (nur das Element) oder OneLevel (Inhalt eines Ordners).
- includeLinks
-
boolean
True, um Links einzuschließen.
- versionDescriptor
- TfvcVersionDescriptor
Gibt zurück
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Posten Sie zum Abrufen einer Gruppe von Elementen, wenn eine Liste von Pfaden oder ein langer Pfad angegeben ist. Ermöglicht die Angabe der recursionLevel- und Versionsdeskriptoren für jeden Pfad.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>Parameter
- itemRequestData
- TfvcItemRequestData
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
Posten Sie zum Abrufen einer Gruppe von Elementen, wenn eine Liste von Pfaden oder ein langer Pfad angegeben ist. Ermöglicht die Angabe der recursionLevel- und Versionsdeskriptoren für jeden Pfad.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>Parameter
- itemRequestData
- TfvcItemRequestData
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>Parameter
- path
-
string
Versionskontrollpfad eines einzelnen Elements, das zurückgegeben werden soll.
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Dateiname des zurückgegebenen Elements.
- download
-
boolean
Wenn true, erstellen Sie einen herunterladbaren Anhang.
- scopePath
-
string
Versionskontrollpfad eines Ordners, um mehrere Elemente zurückzugeben.
- recursionLevel
- VersionControlRecursionType
Keine (nur das Element) oder OneLevel (Inhalt eines Ordners).
- versionDescriptor
- TfvcVersionDescriptor
Versionsdeskriptor. Der Standardwert lautet null.
- includeContent
-
boolean
Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
Gibt zurück
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameter
- path
-
string
Versionskontrollpfad eines einzelnen Elements, das zurückgegeben werden soll.
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Dateiname des zurückgegebenen Elements.
- download
-
boolean
Wenn true, erstellen Sie einen herunterladbaren Anhang.
- scopePath
-
string
Versionskontrollpfad eines Ordners, um mehrere Elemente zurückzugeben.
- recursionLevel
- VersionControlRecursionType
Keine (nur das Element) oder OneLevel (Inhalt eines Ordners).
- versionDescriptor
- TfvcVersionDescriptor
Versionsdeskriptor. Der Standardwert lautet null.
- includeContent
-
boolean
Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
Gibt zurück
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Holen Sie sich ein einzelnes tiefes Etikett.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parameter
- labelId
-
string
Eindeutige Kennung des Etiketts
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TfvcLabel>
getLabelItems(string, number, number)
Abrufen von Elementen unter einem Etikett.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parameter
- labelId
-
string
Eindeutige Kennung des Etiketts
- top
-
number
Maximale Anzahl der zurückzusendenden Artikel
- skip
-
number
Anzahl der zu überspringenden Elemente
Gibt zurück
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Rufen Sie eine Sammlung flacher Beschriftungsverweise ab.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Parameter
- requestData
- TfvcLabelRequestData
labelScope, name, owner und itemLabelFilter
- project
-
string
Projekt-ID oder Projektname
- top
-
number
Maximale Anzahl der zurückzugebenden Bezeichnungen, standardmäßig 100, wenn nicht definiert
- skip
-
number
Anzahl der zu überspringenden Beschriftungen
Gibt zurück
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Holen Sie sich ein einzelnes tiefes Shelveset.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parameter
- shelvesetId
-
string
Eindeutige ID des Shelvesets
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount und maxCommentLength
Gibt zurück
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Abrufen von Änderungen, die in einem Shelveset enthalten sind.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parameter
- shelvesetId
-
string
Eindeutige ID des Shelvesets
- top
-
number
Maximale Anzahl der Änderungen, die zurückgegeben werden sollen
- skip
-
number
Anzahl der zu überspringenden Änderungen
Gibt zurück
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Gibt eine Auflistung flacher Shelvesetverweise zurück.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parameter
- requestData
- TfvcShelvesetRequestData
name, owner und maxCommentLength
- top
-
number
Maximale Anzahl der zurückzugebenden Shelvesets
- skip
-
number
Anzahl der zu überspringenden Shelvesets
Gibt zurück
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Rufen Sie Arbeitselemente ab, die einem Shelveset zugeordnet sind.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parameter
- shelvesetId
-
string
Eindeutige ID des Shelvesets
Gibt zurück
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Stellt die Dateianzahl und unkomprimierte Bytes für eine Sammlung/ein Projekt in einem bestimmten Bereich für TFVC bereit.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parameter
- project
-
string
Projekt-ID oder Projektname
- scopePath
-
string
'$/' für die Sammlung, '$/project' für ein bestimmtes Projekt
Gibt zurück
Promise<TfvcStatistics>