TfvcRestClient class
Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden
- 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 einzelne Verzweigungshierarchie am angegebenen Pfad mit den angegebenen übergeordneten oder untergeordneten Elementen ab. |
| get |
Rufen Sie eine Auflistung von Verzweigungsstammen ab– untergeordnete Elemente der ersten Ebene, Verzweigungen ohne Eltern. |
| get |
Abrufen von Branchhierarchien unterhalb des angegebenen scopePath |
| get |
Abrufen eines Tfvc-Changesets |
| get |
Rufen Sie Tfvc-Änderungen für ein bestimmtes Changeset ab. |
| get |
Abrufen von Tfvc Changesets |
| get |
Ruft die Arbeitselemente ab, die einem bestimmten Changeset zugeordnet sind. |
| get |
Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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-Elementen |
| get |
Posten sie zum Abrufen einer Gruppe von Elementen, die eine Liste von Pfaden oder einen langen Pfad angegeben haben. Ermöglicht das Angeben der rekursionLevel- und Versionsdeskriptoren für jeden Pfad. |
| get |
Posten sie zum Abrufen einer Gruppe von Elementen, die eine Liste von Pfaden oder einen langen Pfad angegeben haben. Ermöglicht das Angeben der rekursionLevel- und Versionsdeskriptoren für jeden Pfad. |
| get |
Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird. |
| get |
Rufen Sie eine einzelne deep-Bezeichnung ab. |
| get |
Ruft Elemente unter einer Bezeichnung ab. |
| get |
Rufen Sie eine Auflistung flacher Bezeichnungsverweise ab. |
| get |
Rufen Sie ein einzelnes deep shelveset ab. |
| get |
Abrufen von Änderungen, die in einem Shelveset enthalten sind. |
| get |
Gibt eine Auflistung flacher Shelveset-Verweise zurück. |
| get |
Ruft 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 einzelne Verzweigungshierarchie am angegebenen Pfad mit den angegebenen übergeordneten oder untergeordneten Elementen ab.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parameter
- path
-
string
Vollständiger Pfad zum Branch. Standardwert: $/ Beispiele: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projekt-ID oder Projektname
- includeParent
-
boolean
Gibt den übergeordneten Branch zurück, falls vorhanden. Standardwert: False
- includeChildren
-
boolean
Gibt untergeordnete Verzweigungen zurück, falls vorhanden. Standardwert: False
Gibt zurück
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Rufen Sie eine Auflistung von Verzweigungsstammen ab– untergeordnete Elemente der ersten Ebene, Verzweigungen ohne Eltern.
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 Branch zurück, falls vorhanden. Standardwert: False
- includeChildren
-
boolean
Gibt die untergeordneten Branches für jeden Stammbranch zurück. Standardwert: False
- includeDeleted
-
boolean
Gibt gelöschte Branches zurück. Standardwert: False
- includeLinks
-
boolean
Gibt Links zurück. Standardwert: False
Gibt zurück
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Abrufen von Branchhierarchien unterhalb des angegebenen scopePath
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parameter
- scopePath
-
string
Vollständiger Pfad zum Branch. Standardwert: $/ Beispiele: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projekt-ID oder Projektname
- includeDeleted
-
boolean
Gibt gelöschte Branches zurück. Standardwert: False
- includeLinks
-
boolean
Gibt Links zurück. Standardwert: False
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
Abzurufende Changeset-ID.
- 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 Einchecknotizen 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. Standard: NULL
- includeSourceRename
-
boolean
Umbenennungen einschließen. Standardwert: FALSE
- skip
-
number
Anzahl der zu überspringenden Ergebnisse. Standard: NULL
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse. Standard: 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
Die folgenden verfügbaren Kriterien (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standardwert: null
Gibt zurück
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Rufen Sie Tfvc-Änderungen für ein bestimmtes Changeset ab.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parameter
- id
-
number
ID des Changesets. Standard: NULL
- skip
-
number
Anzahl der zu überspringenden Ergebnisse. Standard: NULL
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse. Standard: 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. Standard: NULL
- skip
-
number
Anzahl der zu überspringenden Ergebnisse. Standard: NULL
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse. Standard: 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
Die folgenden verfügbaren Kriterien (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standardwert: null
Gibt zurück
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Ruft die Arbeitselemente 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)
Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 eine herunterladbare Anlage.
- 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
Legen Sie diesen Wert auf true fest, 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)
Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 eine herunterladbare Anlage.
- 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
Legen Sie diesen Wert auf true fest, 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-Elementen
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, die eine Liste von Pfaden oder einen langen Pfad angegeben haben. Ermöglicht das Angeben der rekursionLevel- 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, die eine Liste von Pfaden oder einen langen Pfad angegeben haben. Ermöglicht das Angeben der rekursionLevel- 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)
Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 eine herunterladbare Anlage.
- 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
Legen Sie diesen Wert auf true fest, 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)
Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 eine herunterladbare Anlage.
- 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
Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
Gibt zurück
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Rufen Sie eine einzelne deep-Bezeichnung ab.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parameter
- labelId
-
string
Eindeutiger Bezeichner der Bezeichnung
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TfvcLabel>
getLabelItems(string, number, number)
Ruft Elemente unter einer Bezeichnung ab.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parameter
- labelId
-
string
Eindeutiger Bezeichner der Bezeichnung
- top
-
number
Maximale Anzahl der zurückzugebenden Elemente
- skip
-
number
Anzahl der zu überspringenden Elemente
Gibt zurück
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Rufen Sie eine Auflistung flacher Bezeichnungsverweise ab.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Parameter
- requestData
- TfvcLabelRequestData
labelScope, Name, Besitzer und itemLabelFilter
- project
-
string
Projekt-ID oder Projektname
- top
-
number
Maximale Anzahl der zurückzugebenden Bezeichnungen, Standardwert 100, wenn nicht definiert
- skip
-
number
Anzahl der zu überspringenden Bezeichnungen
Gibt zurück
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Rufen Sie ein einzelnes deep shelveset ab.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parameter
- shelvesetId
-
string
Die 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
Die eindeutige ID des Shelvesets
- top
-
number
Maximale Anzahl der zurückzugebenden Änderungen
- skip
-
number
Anzahl der zu überspringenden Änderungen
Gibt zurück
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Gibt eine Auflistung flacher Shelveset-Verweise zurück.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parameter
- requestData
- TfvcShelvesetRequestData
name, besitzer und maxCommentLength
- top
-
number
Maximale Anzahl der zurückzugebenden Shelvesets
- skip
-
number
Anzahl der zu überspringenden Shelvesets
Gibt zurück
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Ruft Arbeitselemente ab, die einem Shelveset zugeordnet sind.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parameter
- shelvesetId
-
string
Die 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 sammlung, "$/project" für ein bestimmtes Projekt
Gibt zurück
Promise<TfvcStatistics>