TfvcRestClient class

Reference

Balíček:: azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS

Extends: RestClientBase

Konstruktory

TfvcRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createChangeset(TfvcChangeset, string)	Vytvořte novou sadu změn.
getBatchedChangesets(TfvcChangesetsRequestData)	Vrátí sady změn pro daný seznam ID sady změn.
getBranch(string, string, boolean, boolean)	Získejte hierarchii jedné větve v dané cestě s nadřazenými nebo podřízenými položkami, jak je uvedeno.
getBranches(string, boolean, boolean, boolean, boolean)	Získejte kolekci kořenů větví – podřízené položky první úrovně, větve bez nadřazených větví.
getBranchRefs(string, string, boolean, boolean)	Získání hierarchií větví pod zadanou cestu k oboru
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Načtení sady změn Tfvc
getChangesetChanges(number, number, number)	Načtení změn Tfvc pro danou sadu změn
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Načtení sad změn Tfvc
getChangesetWorkItems(number)	Načte pracovní položky přidružené ke konkrétní sadě změn.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Získání seznamu položek Tfvc
getItemsBatch(TfvcItemRequestData, string)	Post pro načtení sady položek zadaných seznamem cest nebo dlouhou cestou. Umožňuje zadat deskriptory rekurzeLevel a verze pro každou cestu.
getItemsBatchZip(TfvcItemRequestData, string)	Post pro načtení sady položek zadaných seznamem cest nebo dlouhou cestou. Umožňuje zadat deskriptory rekurzeLevel a verze pro každou cestu.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getLabel(string, TfvcLabelRequestData, string)	Získejte jeden hluboký popisek.
getLabelItems(string, number, number)	Získání položek pod popiskem
getLabels(TfvcLabelRequestData, string, number, number)	Získejte kolekci odkazů na mělké popisky.
getShelveset(string, TfvcShelvesetRequestData)	Pořiďte si jednu hlubokou sadu.
getShelvesetChanges(string, number, number)	Získejte změny zahrnuté v sadě odložených změn.
getShelvesets(TfvcShelvesetRequestData, number, number)	Vrátí kolekci odkazů na mělký odchyt.
getShelvesetWorkItems(string)	Získání pracovních položek přidružených ke sadě odložených odložených položek
getTfvcStatistics(string, string)	Poskytuje počet souborů a nekomprimované bajty pro kolekci nebo projekt v určitém oboru pro TFVC.

Podrobnosti konstruktoru

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

createChangeset(TfvcChangeset, string)

Vytvořte novou sadu změn.

function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>

Parametry

changeset: TfvcChangeset

project: string

ID projektu nebo název projektu

Návraty

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Vrátí sady změn pro daný seznam ID sady změn.

function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>

Parametry

changesetsRequestData: TfvcChangesetsRequestData

Seznam ID sady změn

Návraty

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Získejte hierarchii jedné větve v dané cestě s nadřazenými nebo podřízenými položkami, jak je uvedeno.

function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>

Parametry

path: string

Úplná cesta k větvi Výchozí: $/ Příklady: $/, $/MyProject, $/MyProject/SomeFolder.

project: string

ID projektu nebo název projektu

includeParent: boolean

Vrátí nadřazenou větev, pokud existuje. Výchozí: False

includeChildren: boolean

Vrátit podřízené větve, pokud existují. Výchozí: False

Návraty

Promise<TfvcBranch>

getBranches(string, boolean, boolean, boolean, boolean)

Získejte kolekci kořenů větví – podřízené položky první úrovně, větve bez nadřazených větví.

function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>

Parametry

project: string

ID projektu nebo název projektu

includeParent: boolean

Vrátí nadřazenou větev, pokud existuje. Výchozí: False

includeChildren: boolean

Vrátí podřízené větve pro každou kořenovou větev. Výchozí: False

includeDeleted: boolean

Vrátí odstraněné větve. Výchozí: False

includeLinks: boolean

Odkazy pro vrácení. Výchozí: False

Návraty

Promise<TfvcBranch[]>

getBranchRefs(string, string, boolean, boolean)

Získání hierarchií větví pod zadanou cestu k oboru

function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>

Parametry

scopePath: string

Úplná cesta k větvi Výchozí: $/ Příklady: $/, $/MyProject, $/MyProject/SomeFolder.

project: string

ID projektu nebo název projektu

includeDeleted: boolean

Vrátí odstraněné větve. Výchozí: False

includeLinks: boolean

Odkazy pro vrácení. Výchozí: False

Návraty

Promise<TfvcBranchRef[]>

getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)

Načtení sady změn Tfvc

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>

Parametry

id: number

ID sady změn, které se má načíst.

project: string

ID projektu nebo název projektu

maxChangeCount: number

Počet změn, které se mají vrátit (maximálně 100 změn) Výchozí hodnota: 0

includeDetails: boolean

Do odpovědi uveďte podrobnosti o zásadách a poznámky k ohlášení. Výchozí hodnota: false

includeWorkItems: boolean

Zahrnout pracovní položky. Výchozí hodnota: false

maxCommentLength: number

Do odpovědi uveďte podrobnosti o přidružených pracovních položkách. Výchozí hodnota: null

includeSourceRename: boolean

Zahrnout přejmenování. Výchozí hodnota: false

skip: number

Počet výsledků, které se mají přeskočit Výchozí hodnota: null

top: number

Maximální počet výsledků, které se mají vrátit. Výchozí hodnota: null

orderby: string

Výsledky jsou ve výchozím nastavení seřazené podle ID v sestupném pořadí. Použijte id asc k seřazení podle ID ve vzestupném pořadí.

searchCriteria: TfvcChangesetSearchCriteria

Následující dostupná kritéria (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Výchozí: null

Návraty

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Načtení změn Tfvc pro danou sadu změn

function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>

Parametry

id: number

ID sady změn. Výchozí hodnota: null

skip: number

Počet výsledků, které se mají přeskočit Výchozí hodnota: null

top: number

Maximální počet výsledků, které se mají vrátit. Výchozí hodnota: null

Návraty

Promise<PagedList<TfvcChange>>

getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)

Načtení sad změn Tfvc

function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>

Parametry

project: string

ID projektu nebo název projektu

maxCommentLength: number

Do odpovědi uveďte podrobnosti o přidružených pracovních položkách. Výchozí hodnota: null

skip: number

Počet výsledků, které se mají přeskočit Výchozí hodnota: null

top: number

Maximální počet výsledků, které se mají vrátit. Výchozí hodnota: null

orderby: string

Výsledky jsou ve výchozím nastavení seřazené podle ID v sestupném pořadí. Použijte id asc k seřazení podle ID ve vzestupném pořadí.

searchCriteria: TfvcChangesetSearchCriteria

Následující dostupná kritéria (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Výchozí: null

Návraty

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Načte pracovní položky přidružené ke konkrétní sadě změn.

function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>

Parametry

id: number

ID sady změn.

Návraty

Promise<AssociatedWorkItem[]>

getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.

function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>

Parametry

path: string

Cesta správy verzí jednotlivé položky, která se má vrátit.

project: string

ID projektu nebo název projektu

fileName: string

název souboru vrácené položky.

download: boolean

Pokud je true, vytvořte přílohu ke stažení.

scopePath: string

Cesta správy verzí složky pro vrácení více položek.

recursionLevel: VersionControlRecursionType

None (pouze položka) nebo OneLevel (obsah složky).

versionDescriptor: TfvcVersionDescriptor

Popisovač verze. Výchozí hodnota je null.

includeContent: boolean

Nastavte na true, pokud chcete zahrnout obsah položky při žádosti o json. Výchozí hodnota je false.

Návraty

Promise<TfvcItem>

getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Parametry

path: string

Cesta správy verzí jednotlivé položky, která se má vrátit.

project: string

ID projektu nebo název projektu

fileName: string

název souboru vrácené položky.

download: boolean

Pokud je true, vytvořte přílohu ke stažení.

scopePath: string

Cesta správy verzí složky pro vrácení více položek.

recursionLevel: VersionControlRecursionType

None (pouze položka) nebo OneLevel (obsah složky).

versionDescriptor: TfvcVersionDescriptor

Popisovač verze. Výchozí hodnota je null.

includeContent: boolean

Nastavte na true, pokud chcete zahrnout obsah položky při žádosti o json. Výchozí hodnota je false.

Návraty

Promise<ArrayBuffer>

getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)

Získání seznamu položek Tfvc

function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>

Parametry

project: string

ID projektu nebo název projektu

scopePath: string

Cesta správy verzí složky pro vrácení více položek.

recursionLevel: VersionControlRecursionType

None (pouze položka) nebo OneLevel (obsah složky).

includeLinks: boolean

True, pokud chcete zahrnout odkazy.

versionDescriptor: TfvcVersionDescriptor

Návraty

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Post pro načtení sady položek zadaných seznamem cest nebo dlouhou cestou. Umožňuje zadat deskriptory rekurzeLevel a verze pro každou cestu.

function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>

Parametry

itemRequestData: TfvcItemRequestData

project: string

ID projektu nebo název projektu

Návraty

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Post pro načtení sady položek zadaných seznamem cest nebo dlouhou cestou. Umožňuje zadat deskriptory rekurzeLevel a verze pro každou cestu.

function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>

Parametry

itemRequestData: TfvcItemRequestData

project: string

ID projektu nebo název projektu

Návraty

Promise<ArrayBuffer>

getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>

Parametry

path: string

Cesta správy verzí jednotlivé položky, která se má vrátit.

project: string

ID projektu nebo název projektu

fileName: string

název souboru vrácené položky.

download: boolean

Pokud je true, vytvořte přílohu ke stažení.

scopePath: string

Cesta správy verzí složky pro vrácení více položek.

recursionLevel: VersionControlRecursionType

None (pouze položka) nebo OneLevel (obsah složky).

versionDescriptor: TfvcVersionDescriptor

Popisovač verze. Výchozí hodnota je null.

includeContent: boolean

Nastavte na true, pokud chcete zahrnout obsah položky při žádosti o json. Výchozí hodnota je false.

Návraty

Promise<string>

getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Parametry

path: string

Cesta správy verzí jednotlivé položky, která se má vrátit.

project: string

ID projektu nebo název projektu

fileName: string

název souboru vrácené položky.

download: boolean

Pokud je true, vytvořte přílohu ke stažení.

scopePath: string

Cesta správy verzí složky pro vrácení více položek.

recursionLevel: VersionControlRecursionType

None (pouze položka) nebo OneLevel (obsah složky).

versionDescriptor: TfvcVersionDescriptor

Popisovač verze. Výchozí hodnota je null.

includeContent: boolean

Nastavte na true, pokud chcete zahrnout obsah položky při žádosti o json. Výchozí hodnota je false.

Návraty

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Získejte jeden hluboký popisek.

function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>

Parametry

labelId: string

Jedinečný identifikátor popisku

requestData: TfvcLabelRequestData

maxItemCount

project: string

ID projektu nebo název projektu

Návraty

Promise<TfvcLabel>

getLabelItems(string, number, number)

Získání položek pod popiskem

function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>

Parametry

labelId: string

Jedinečný identifikátor popisku

top: number

Maximální počet položek, které se mají vrátit

skip: number

Počet položek, které se mají přeskočit

Návraty

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

Získejte kolekci odkazů na mělké popisky.

function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>

Parametry

requestData: TfvcLabelRequestData

labelScope, name, owner a itemLabelFilter

project: string

ID projektu nebo název projektu

top: number

Maximální počet popisků, které se mají vrátit, výchozí hodnota je 100, pokud není definována

skip: number

Počet popisků, které se mají přeskočit

Návraty

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Pořiďte si jednu hlubokou sadu.

function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>

Parametry

shelvesetId: string

Jedinečné ID sady odložených odlic

requestData: TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount a maxCommentLength

Návraty

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Získejte změny zahrnuté v sadě odložených změn.

function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>

Parametry

shelvesetId: string

Jedinečné ID sady odložených odlic

top: number

Maximální počet změn, které se mají vrátit

skip: number

Počet změn, které se mají přeskočit

Návraty

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Vrátí kolekci odkazů na mělký odchyt.

function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>

Parametry

requestData: TfvcShelvesetRequestData

name, owner a maxCommentLength

top: number

Maximální počet sad odložených položek, které se mají vrátit

skip: number

Počet sad odložených odložených položek

Návraty

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Získání pracovních položek přidružených ke sadě odložených odložených položek

function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>

Parametry

shelvesetId: string

Jedinečné ID sady odložených odlic

Návraty

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Poskytuje počet souborů a nekomprimované bajty pro kolekci nebo projekt v určitém oboru pro TFVC.

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

Parametry

project: string

ID projektu nebo název projektu

scopePath: string

$/pro kolekci, $/project pro konkrétní projekt

Návraty

Promise<TfvcStatistics>

Sdílet prostřednictvím

TfvcRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

TfvcRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

createChangeset(TfvcChangeset, string)

Parametry

Návraty

getBatchedChangesets(TfvcChangesetsRequestData)

Parametry

Návraty

getBranch(string, string, boolean, boolean)

Parametry

Návraty

getBranches(string, boolean, boolean, boolean, boolean)

Parametry

Návraty

getBranchRefs(string, string, boolean, boolean)

Parametry

Návraty

getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)

Parametry

Návraty

getChangesetChanges(number, number, number)

Parametry

Návraty

getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)

Parametry

Návraty

getChangesetWorkItems(number)

Parametry

Návraty

getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Parametry

Návraty

getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Parametry

Návraty

getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)

Parametry

Návraty

getItemsBatch(TfvcItemRequestData, string)

Parametry

Návraty

getItemsBatchZip(TfvcItemRequestData, string)

Parametry

Návraty

getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Parametry

Návraty

getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Parametry

Návraty

getLabel(string, TfvcLabelRequestData, string)

Parametry

Návraty

getLabelItems(string, number, number)

Parametry

Návraty

getLabels(TfvcLabelRequestData, string, number, number)

Parametry

Návraty

getShelveset(string, TfvcShelvesetRequestData)

Parametry

Návraty

getShelvesetChanges(string, number, number)

Parametry

Návraty

getShelvesets(TfvcShelvesetRequestData, number, number)

Parametry

Návraty

getShelvesetWorkItems(string)

Parametry