TfvcRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Konstruktorok
| Tfvc |
Tulajdonságok
| RESOURCE_AREA_ID |
Metódusok
| create |
Hozzon létre egy új módosításkészletet. |
| get |
A változáskészlet-azonosítók adott listájának változáskészleteit adja vissza. |
| get |
Egyetlen ághierarchia lekérése az adott útvonalon a megadott szülőkkel vagy gyerekekkel. |
| get |
Szerezze be az ággyökereket, az első szintű gyermekeket, az ágakat szülők nélkül. |
| get |
Ághierarchiák lekérése a megadott scopePath alatt |
| get |
Tfvc-változáskészlet lekérése |
| get |
Egy adott változáskészlet Tfvc-módosításainak lekérése. |
| get |
Tfvc-módosítások lekérése |
| get |
Lekéri az adott változáskészlethez társított munkaelemeket. |
| get |
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza. |
| get |
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza. |
| get |
Tfvc-elemek listájának lekérése |
| get |
Bejegyzés az elérési utak listájával vagy hosszú elérési útként megadott elemek beolvasásához. Lehetővé teszi a recursionLevel és a verzióleírók megadását az egyes elérési utakhoz. |
| get |
Bejegyzés az elérési utak listájával vagy hosszú elérési útként megadott elemek beolvasásához. Lehetővé teszi a recursionLevel és a verzióleírók megadását az egyes elérési utakhoz. |
| get |
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza. |
| get |
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza. |
| get |
Egyetlen mélycímke lekérése. |
| get |
Elemek lekérése címke alatt. |
| get |
Szerezze be a sekély címkehivatkozások gyűjteményét. |
| get |
Szerezzen be egyetlen mély polckészletet. |
| get |
A módosítások lekérése egy polckészletben. |
| get |
Adja vissza a sekély polckészlet-referenciák gyűjteményét. |
| get |
Lekérheti a polckészlethez társított munkaelemeket. |
| get |
Fájlszámot és tömörítetlen bájtokat biztosít egy gyűjteményhez/projekthez a TFVC adott hatókörében. |
Konstruktor adatai
TfvcRestClient(IVssRestClientOptions)
Tulajdonság adatai
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringTulajdonság értéke
string
Metódus adatai
createChangeset(TfvcChangeset, string)
Hozzon létre egy új módosításkészletet.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>Paraméterek
- changeset
- TfvcChangeset
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
A változáskészlet-azonosítók adott listájának változáskészleteit adja vissza.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Paraméterek
- changesetsRequestData
- TfvcChangesetsRequestData
A változáskészlet azonosítóinak listája.
Válaszok
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Egyetlen ághierarchia lekérése az adott útvonalon a megadott szülőkkel vagy gyerekekkel.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Paraméterek
- path
-
string
Az ág teljes elérési útja. Alapértelmezett: $/ Példák: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projektazonosító vagy projektnév
- includeParent
-
boolean
Adja vissza a szülőágat, ha van ilyen. Alapértelmezett: Hamis
- includeChildren
-
boolean
Gyermekágakat ad vissza, ha vannak ilyenek. Alapértelmezett: Hamis
Válaszok
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Szerezze be az ággyökereket, az első szintű gyermekeket, az ágakat szülők nélkül.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- includeParent
-
boolean
Adja vissza a szülőágat, ha van ilyen. Alapértelmezett: Hamis
- includeChildren
-
boolean
Adja vissza az egyes gyökérágak gyermekágait. Alapértelmezett: Hamis
- includeDeleted
-
boolean
Törölt ágakat ad vissza. Alapértelmezett: Hamis
- includeLinks
-
boolean
Hivatkozásokat ad vissza. Alapértelmezett: Hamis
Válaszok
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Ághierarchiák lekérése a megadott scopePath alatt
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Paraméterek
- scopePath
-
string
Az ág teljes elérési útja. Alapértelmezett: $/ Példák: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projektazonosító vagy projektnév
- includeDeleted
-
boolean
Törölt ágakat ad vissza. Alapértelmezett: Hamis
- includeLinks
-
boolean
Hivatkozásokat ad vissza. Alapértelmezett: Hamis
Válaszok
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Tfvc-változáskészlet lekérése
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>Paraméterek
- id
-
number
A lekérendő módosításkészlet-azonosító.
- project
-
string
Projektazonosító vagy projektnév
- maxChangeCount
-
number
Visszaadandó módosítások száma (legfeljebb 100 módosítás) Alapértelmezett: 0
- includeDetails
-
boolean
Adja meg a szabályzat részleteit és a bejelentkezési megjegyzéseket a válaszban. Alapértelmezett: hamis
- includeWorkItems
-
boolean
Munkaelemek belefoglalása. Alapértelmezett: hamis
- maxCommentLength
-
number
Adja meg a kapcsolódó munkaelemek részleteit a válaszban. Alapértelmezett: null
- includeSourceRename
-
boolean
Adjon meg átnevezéseket. Alapértelmezett: hamis
- skip
-
number
Kihagyandó eredmények száma. Alapértelmezett: null
- top
-
number
A visszaadandó eredmények maximális száma. Alapértelmezett: null
- orderby
-
string
Az eredmények alapértelmezés szerint csökkenő sorrendben vannak rendezve. Az id asc használatával növekvő sorrendbe rendezheti az azonosítót.
- searchCriteria
- TfvcChangesetSearchCriteria
A következő feltételek érhetők el (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Alapértelmezett: null
Válaszok
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Egy adott változáskészlet Tfvc-módosításainak lekérése.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Paraméterek
- id
-
number
A változáskészlet azonosítója. Alapértelmezett: null
- skip
-
number
Kihagyandó eredmények száma. Alapértelmezett: null
- top
-
number
A visszaadandó eredmények maximális száma. Alapértelmezett: null
Válaszok
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Tfvc-módosítások lekérése
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- maxCommentLength
-
number
Adja meg a kapcsolódó munkaelemek részleteit a válaszban. Alapértelmezett: null
- skip
-
number
Kihagyandó eredmények száma. Alapértelmezett: null
- top
-
number
A visszaadandó eredmények maximális száma. Alapértelmezett: null
- orderby
-
string
Az eredmények alapértelmezés szerint csökkenő sorrendben vannak rendezve. Az id asc használatával növekvő sorrendbe rendezheti az azonosítót.
- searchCriteria
- TfvcChangesetSearchCriteria
A következő feltételek érhetők el (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Alapértelmezett: null
Válaszok
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Lekéri az adott változáskészlethez társított munkaelemeket.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Paraméterek
- id
-
number
A változáskészlet azonosítója.
Válaszok
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>Paraméterek
- path
-
string
Az egyes visszaadandó elemek verziókövetési elérési útja.
- project
-
string
Projektazonosító vagy projektnév
- fileName
-
string
visszaadott elem fájlneve.
- download
-
boolean
Ha igaz, hozzon létre egy letölthető mellékletet.
- scopePath
-
string
Egy mappa verziókövetési elérési útja több elem visszaadásához.
- recursionLevel
- VersionControlRecursionType
Nincs (csak az elem), vagy OneLevel (mappa tartalma).
- versionDescriptor
- TfvcVersionDescriptor
Verzióleíró. Az alapértelmezett érték null.
- includeContent
-
boolean
Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.
Válaszok
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Paraméterek
- path
-
string
Az egyes visszaadandó elemek verziókövetési elérési útja.
- project
-
string
Projektazonosító vagy projektnév
- fileName
-
string
visszaadott elem fájlneve.
- download
-
boolean
Ha igaz, hozzon létre egy letölthető mellékletet.
- scopePath
-
string
Egy mappa verziókövetési elérési útja több elem visszaadásához.
- recursionLevel
- VersionControlRecursionType
Nincs (csak az elem), vagy OneLevel (mappa tartalma).
- versionDescriptor
- TfvcVersionDescriptor
Verzióleíró. Az alapértelmezett érték null.
- includeContent
-
boolean
Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.
Válaszok
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Tfvc-elemek listájának lekérése
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- scopePath
-
string
Egy mappa verziókövetési elérési útja több elem visszaadásához.
- recursionLevel
- VersionControlRecursionType
Nincs (csak az elem), vagy OneLevel (mappa tartalma).
- includeLinks
-
boolean
Igaz, hogy hivatkozásokat tartalmazzon.
- versionDescriptor
- TfvcVersionDescriptor
Válaszok
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Bejegyzés az elérési utak listájával vagy hosszú elérési útként megadott elemek beolvasásához. Lehetővé teszi a recursionLevel és a verzióleírók megadását az egyes elérési utakhoz.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>Paraméterek
- itemRequestData
- TfvcItemRequestData
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
Bejegyzés az elérési utak listájával vagy hosszú elérési útként megadott elemek beolvasásához. Lehetővé teszi a recursionLevel és a verzióleírók megadását az egyes elérési utakhoz.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>Paraméterek
- itemRequestData
- TfvcItemRequestData
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>Paraméterek
- path
-
string
Az egyes visszaadandó elemek verziókövetési elérési útja.
- project
-
string
Projektazonosító vagy projektnév
- fileName
-
string
visszaadott elem fájlneve.
- download
-
boolean
Ha igaz, hozzon létre egy letölthető mellékletet.
- scopePath
-
string
Egy mappa verziókövetési elérési útja több elem visszaadásához.
- recursionLevel
- VersionControlRecursionType
Nincs (csak az elem), vagy OneLevel (mappa tartalma).
- versionDescriptor
- TfvcVersionDescriptor
Verzióleíró. Az alapértelmezett érték null.
- includeContent
-
boolean
Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.
Válaszok
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Paraméterek
- path
-
string
Az egyes visszaadandó elemek verziókövetési elérési útja.
- project
-
string
Projektazonosító vagy projektnév
- fileName
-
string
visszaadott elem fájlneve.
- download
-
boolean
Ha igaz, hozzon létre egy letölthető mellékletet.
- scopePath
-
string
Egy mappa verziókövetési elérési útja több elem visszaadásához.
- recursionLevel
- VersionControlRecursionType
Nincs (csak az elem), vagy OneLevel (mappa tartalma).
- versionDescriptor
- TfvcVersionDescriptor
Verzióleíró. Az alapértelmezett érték null.
- includeContent
-
boolean
Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.
Válaszok
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Egyetlen mélycímke lekérése.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Paraméterek
- labelId
-
string
A címke egyedi azonosítója
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<TfvcLabel>
getLabelItems(string, number, number)
Elemek lekérése címke alatt.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Paraméterek
- labelId
-
string
A címke egyedi azonosítója
- top
-
number
Visszaadandó elemek maximális száma
- skip
-
number
Kihagyandó elemek száma
Válaszok
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Szerezze be a sekély címkehivatkozások gyűjteményét.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Paraméterek
- requestData
- TfvcLabelRequestData
labelScope, name, owner és itemLabelFilter
- project
-
string
Projektazonosító vagy projektnév
- top
-
number
A visszaadandó címkék maximális száma, alapértelmezés szerint 100, ha nincs definiálva
- skip
-
number
Kihagyandó címkék száma
Válaszok
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Szerezzen be egyetlen mély polckészletet.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Paraméterek
- shelvesetId
-
string
A polckészlet egyedi azonosítója
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount és maxCommentLength
Válaszok
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
A módosítások lekérése egy polckészletben.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Paraméterek
- shelvesetId
-
string
A polckészlet egyedi azonosítója
- top
-
number
A visszaadandó módosítások maximális száma
- skip
-
number
Kihagyandó módosítások száma
Válaszok
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Adja vissza a sekély polckészlet-referenciák gyűjteményét.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Paraméterek
- requestData
- TfvcShelvesetRequestData
név, tulajdonos és maxCommentLength
- top
-
number
A visszaadandó polckészletek maximális száma
- skip
-
number
Kihagyandó polckészletek száma
Válaszok
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Lekérheti a polckészlethez társított munkaelemeket.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Paraméterek
- shelvesetId
-
string
A polckészlet egyedi azonosítója
Válaszok
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Fájlszámot és tömörítetlen bájtokat biztosít egy gyűjteményhez/projekthez a TFVC adott hatókörében.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- scopePath
-
string
"$/" a gyűjteményhez, "$/project" adott projekthez
Válaszok
Promise<TfvcStatistics>