TfvcRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatása) kell használni

Extends

RestClientBase

Konstruktorok

TfvcRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

createChangeset(TfvcChangeset, string)	Hozzon létre egy új változáskészletet.
getBatchedChangesets(TfvcChangesetsRequestData)	A változáskészlet-azonosítók adott listájának változáskészleteit adja vissza.
getBranch(string, string, boolean, boolean)	Egyetlen ághierarchia lekérése az adott útvonalon a szülőkkel vagy gyermekekkel a megadott módon.
getBranches(string, boolean, boolean, boolean, boolean)	Gyűjtse be az ággyökereket – első szintű gyermekeket, szülők nélküli ágakat.
getBranchRefs(string, string, boolean, boolean)	Ághierarchiák lekérése a megadott scopePath alatt
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Tfvc-változáskészlet lekérése
getChangesetChanges(number, number, number)	Egy adott változáskészlet Tfvc-módosításainak lekérése.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Tfvc-módosítások lekérése
getChangesetWorkItems(number)	Lekéri az adott változáskészlethez társított munkaelemeket.
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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Tfvc-elemek listájának lekérése
getItemsBatch(TfvcItemRequestData, string)	Bejegyzés az elérési utak listájával vagy hosszú elérési útként megadott elemek lekéréséhez. Lehetővé teszi a rekurziószint és a verzióleírók megadását az egyes elérési utakhoz.
getItemsBatchZip(TfvcItemRequestData, string)	Bejegyzés az elérési utak listájával vagy hosszú elérési útként megadott elemek lekéréséhez. Lehetővé teszi a rekurziószint és a verzióleírók megadását az egyes elérési utakhoz.
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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getLabel(string, TfvcLabelRequestData, string)	Egyetlen mélycímke lekérése.
getLabelItems(string, number, number)	Elemek lekérése címke alatt.
getLabels(TfvcLabelRequestData, string, number, number)	Szerezze be a sekély címkehivatkozások gyűjteményét.
getShelveset(string, TfvcShelvesetRequestData)	Szerezzen egy mély polckészletet.
getShelvesetChanges(string, number, number)	A polckészlet módosításainak lekérése.
getShelvesets(TfvcShelvesetRequestData, number, number)	Adja vissza a sekély polcok referenciáinak gyűjteményét.
getShelvesetWorkItems(string)	Polckészlethez társított munkaelemek lekérése.
getTfvcStatistics(string, string)	Fájlszámot és tömörítetlen bájtokat biztosít egy gyűjteményhez/projekthez egy adott hatókörben a TFVC-hez.

Konstruktor adatai

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

createChangeset(TfvcChangeset, string)

Hozzon létre egy új változá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ók listája.

Válaszok

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Egyetlen ághierarchia lekérése az adott útvonalon a szülőkkel vagy gyermekekkel a megadott módon.

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)

Gyűjtse be az ággyökereket – első szintű gyermekeket, szülők nélküli ágakat.

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ő változáskészlet azonosítója.

project

string

Projektazonosító vagy projektnév

maxChangeCount

number

A 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

Adja meg az á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 az azonosító alapján csökkenő sorrendben vannak rendezve. Az id asc használatával növekvő sorrendben 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 az azonosító alapján csökkenő sorrendben vannak rendezve. Az id asc használatával növekvő sorrendben 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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer 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

Egy visszaadandó elem verziókövetési útvonala.

project

string

Projektazonosító vagy projektnév

fileName

string

a visszaadott elem fájlneve.

download

boolean

Ha igaz, hozzon létre egy letölthető mellékletet.

scopePath

string

Egy mappa verziókövetési útvonala 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, hogy elemtartalmat tartalmazzon json kérésekor. Az alapértelmezett érték a false (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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer 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

Egy visszaadandó elem verziókövetési útvonala.

project

string

Projektazonosító vagy projektnév

fileName

string

a visszaadott elem fájlneve.

download

boolean

Ha igaz, hozzon létre egy letölthető mellékletet.

scopePath

string

Egy mappa verziókövetési útvonala 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, hogy elemtartalmat tartalmazzon json kérésekor. Az alapértelmezett érték a false (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 útvonala 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 lekéréséhez. Lehetővé teszi a rekurziószint é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 lekéréséhez. Lehetővé teszi a rekurziószint é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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer 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

Egy visszaadandó elem verziókövetési útvonala.

project

string

Projektazonosító vagy projektnév

fileName

string

a visszaadott elem fájlneve.

download

boolean

Ha igaz, hozzon létre egy letölthető mellékletet.

scopePath

string

Egy mappa verziókövetési útvonala 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, hogy elemtartalmat tartalmazzon json kérésekor. Az alapértelmezett érték a false (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 tartalomnak elérhetőnek kell-e lennie letöltésként, vagy csak streamként kell-e elküldeni a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer 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

Egy visszaadandó elem verziókövetési útvonala.

project

string

Projektazonosító vagy projektnév

fileName

string

a visszaadott elem fájlneve.

download

boolean

Ha igaz, hozzon létre egy letölthető mellékletet.

scopePath

string

Egy mappa verziókövetési útvonala 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, hogy elemtartalmat tartalmazzon json kérésekor. Az alapértelmezett érték a false (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

A 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 egy 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 polckészlet módosításainak lekérése.

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 polcok referenciáinak 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)

Polckészlethez társított munkaelemek lekérése.

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 egy adott hatókörben a TFVC-hez.

function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>

Paraméterek

project

string

Projektazonosító vagy projektnév

scopePath

string

"$/" a gyűjteményhez, "$/project" egy adott projekthez

Válaszok

Promise<TfvcStatistics>