TfvcRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

TfvcRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

createChangeset(TfvcChangeset, string)	Yeni bir değişiklik kümesi oluşturun.
getBatchedChangesets(TfvcChangesetsRequestData)	Belirli bir değişiklik kümesi kimlikleri listesi için değişiklik kümeleri döndürür.
getBranch(string, string, boolean, boolean)	Belirtilen yolda belirtilen üst veya alt öğeleri içeren tek bir dal hiyerarşisi alın.
getBranches(string, boolean, boolean, boolean, boolean)	Dal köklerinden oluşan bir koleksiyon alın. Birinci sınıf çocuklar, ebeveynleri olmayan dallar.
getBranchRefs(string, string, boolean, boolean)	Belirtilen scopePath'in altındaki dal hiyerarşilerini alma
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Tfvc Değişiklik Kümesi Alma
getChangesetChanges(number, number, number)	Belirli bir değişiklik kümesi için Tfvc değişikliklerini alın.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Tfvc Değişiklik Kümelerini Alma
getChangesetWorkItems(number)	Belirli bir değişiklik kümesiyle ilişkili iş öğelerini alır.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Tfvc öğelerinin listesini alma
getItemsBatch(TfvcItemRequestData, string)	Yol listesi veya uzun bir yol verilen bir öğe kümesini almak için gönderin. Her yol için recursionLevel ve sürüm tanımlayıcılarını belirtmeye olanak tanır.
getItemsBatchZip(TfvcItemRequestData, string)	Yol listesi veya uzun bir yol verilen bir öğe kümesini almak için gönderin. Her yol için recursionLevel ve sürüm tanımlayıcılarını belirtmeye olanak tanır.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.
getLabel(string, TfvcLabelRequestData, string)	Tek bir derin etiket alın.
getLabelItems(string, number, number)	Bir etiketin altındaki öğeleri alma.
getLabels(TfvcLabelRequestData, string, number, number)	Sığ etiket başvurularından oluşan bir koleksiyon alın.
getShelveset(string, TfvcShelvesetRequestData)	Tek bir derin raf takımı edinin.
getShelvesetChanges(string, number, number)	Raf kümesine değişiklikleri dahil edin.
getShelvesets(TfvcShelvesetRequestData, number, number)	Sığ raf kümesi başvurularından oluşan bir koleksiyon döndürür.
getShelvesetWorkItems(string)	Raf kümesiyle ilişkili iş öğelerini alma.
getTfvcStatistics(string, string)	TFVC için belirli bir kapsamda bir Koleksiyon/Proje için Dosya Sayısı ve Sıkıştırılmamış Baytlar sağlar.

Oluşturucu Ayrıntıları

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

createChangeset(TfvcChangeset, string)

Yeni bir değişiklik kümesi oluşturun.

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

Parametreler

changeset

TfvcChangeset

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Belirli bir değişiklik kümesi kimlikleri listesi için değişiklik kümeleri döndürür.

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

Parametreler

changesetsRequestData

TfvcChangesetsRequestData

Değişiklik kümesi kimliklerinin listesi.

Döndürülenler

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Belirtilen yolda belirtilen üst veya alt öğeleri içeren tek bir dal hiyerarşisi alın.

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

Parametreler

path

string

Dalın tam yolu. Varsayılan: $/ Örnekler: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

Proje kimliği veya proje adı

includeParent

boolean

Varsa üst dalı döndürür. Varsayılan: False

includeChildren

boolean

Varsa alt dalları döndür. Varsayılan: False

Döndürülenler

Promise<TfvcBranch>

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

Dal köklerinden oluşan bir koleksiyon alın. Birinci sınıf çocuklar, ebeveynleri olmayan dallar.

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

Parametreler

project

string

Proje kimliği veya proje adı

includeParent

boolean

Varsa üst dalı döndürür. Varsayılan: False

includeChildren

boolean

Her kök dal için alt dalları döndürür. Varsayılan: False

includeDeleted

boolean

Silinen dalları iade edin. Varsayılan: False

includeLinks

boolean

Dönüş bağlantıları. Varsayılan: False

Döndürülenler

Promise<TfvcBranch[]>

getBranchRefs(string, string, boolean, boolean)

Belirtilen scopePath'in altındaki dal hiyerarşilerini alma

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

Parametreler

scopePath

string

Dalın tam yolu. Varsayılan: $/ Örnekler: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

Proje kimliği veya proje adı

includeDeleted

boolean

Silinen dalları iade edin. Varsayılan: False

includeLinks

boolean

Dönüş bağlantıları. Varsayılan: False

Döndürülenler

Promise<TfvcBranchRef[]>

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

Tfvc Değişiklik Kümesi Alma

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>

Parametreler

id

number

Alınacak değişiklik kümesi kimliği.

project

string

Proje kimliği veya proje adı

maxChangeCount

number

Döndürülecek değişiklik sayısı (en fazla 100 değişiklik) Varsayılan: 0

includeDetails

boolean

Yanıta ilke ayrıntılarını ve iade notlarını ekleyin. Varsayılan: false

includeWorkItems

boolean

İş öğeleri ekleyin. Varsayılan: false

maxCommentLength

number

Yanıta ilişkili iş öğeleriyle ilgili ayrıntıları ekleyin. Varsayılan: null

includeSourceRename

boolean

Yeniden adlandırmaları dahil edin. Varsayılan: false

skip

number

Atlana sonuç sayısı. Varsayılan: null

top

number

Döndürülecek en fazla sonuç sayısı. Varsayılan: null

orderby

string

Sonuçlar, varsayılan olarak kimliğine göre azalan düzende sıralanır. Kimliği artan düzende sıralamak için id asc kullanın.

searchCriteria

TfvcChangesetSearchCriteria

Aşağıdaki ölçütler kullanılabilir (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Varsayılan: null

Döndürülenler

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Belirli bir değişiklik kümesi için Tfvc değişikliklerini alın.

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

Parametreler

id

number

Değişiklik kümesinin kimliği. Varsayılan: null

skip

number

Atlana sonuç sayısı. Varsayılan: null

top

number

Döndürülecek en fazla sonuç sayısı. Varsayılan: null

Döndürülenler

Promise<PagedList<TfvcChange>>

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

Tfvc Değişiklik Kümelerini Alma

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

Parametreler

project

string

Proje kimliği veya proje adı

maxCommentLength

number

Yanıta ilişkili iş öğeleriyle ilgili ayrıntıları ekleyin. Varsayılan: null

skip

number

Atlana sonuç sayısı. Varsayılan: null

top

number

Döndürülecek en fazla sonuç sayısı. Varsayılan: null

orderby

string

Sonuçlar, varsayılan olarak kimliğine göre azalan düzende sıralanır. Kimliği artan düzende sıralamak için id asc kullanın.

searchCriteria

TfvcChangesetSearchCriteria

Aşağıdaki ölçütler kullanılabilir (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Varsayılan: null

Döndürülenler

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Belirli bir değişiklik kümesiyle ilişkili iş öğelerini alır.

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

Parametreler

id

number

Değişiklik kümesinin kimliği.

Döndürülenler

Promise<AssociatedWorkItem[]>

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

Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.

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

Parametreler

path

string

Döndürülecek tek bir öğenin sürüm denetimi yolu.

project

string

Proje kimliği veya proje adı

fileName

string

döndürülen öğenin dosya adı.

download

boolean

Doğruysa, indirilebilir bir ek oluşturun.

scopePath

string

Birden çok öğe döndürmek için bir klasörün sürüm denetim yolu.

recursionLevel

VersionControlRecursionType

Hiçbiri (yalnızca öğe) veya OneLevel (bir klasörün içeriği).

versionDescriptor

TfvcVersionDescriptor

Sürüm tanımlayıcısı. Varsayılan değer null'tır.

includeContent

boolean

json isteğinde bulunurken öğe içeriği eklemek için true olarak ayarlayın. Varsayılan değer false'tur.

Döndürülenler

Promise<TfvcItem>

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

Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.

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

Parametreler

path

string

Döndürülecek tek bir öğenin sürüm denetimi yolu.

project

string

Proje kimliği veya proje adı

fileName

string

döndürülen öğenin dosya adı.

download

boolean

Doğruysa, indirilebilir bir ek oluşturun.

scopePath

string

Birden çok öğe döndürmek için bir klasörün sürüm denetim yolu.

recursionLevel

VersionControlRecursionType

Hiçbiri (yalnızca öğe) veya OneLevel (bir klasörün içeriği).

versionDescriptor

TfvcVersionDescriptor

Sürüm tanımlayıcısı. Varsayılan değer null'tır.

includeContent

boolean

json isteğinde bulunurken öğe içeriği eklemek için true olarak ayarlayın. Varsayılan değer false'tur.

Döndürülenler

Promise<ArrayBuffer>

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

Tfvc öğelerinin listesini alma

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

Parametreler

project

string

Proje kimliği veya proje adı

scopePath

string

Birden çok öğe döndürmek için bir klasörün sürüm denetim yolu.

recursionLevel

VersionControlRecursionType

Hiçbiri (yalnızca öğe) veya OneLevel (bir klasörün içeriği).

includeLinks

boolean

Bağlantıları eklemek için true.

versionDescriptor

TfvcVersionDescriptor

Döndürülenler

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Yol listesi veya uzun bir yol verilen bir öğe kümesini almak için gönderin. Her yol için recursionLevel ve sürüm tanımlayıcılarını belirtmeye olanak tanır.

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

Parametreler

itemRequestData

TfvcItemRequestData

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Yol listesi veya uzun bir yol verilen bir öğe kümesini almak için gönderin. Her yol için recursionLevel ve sürüm tanımlayıcılarını belirtmeye olanak tanır.

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

Parametreler

itemRequestData

TfvcItemRequestData

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<ArrayBuffer>

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

Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.

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

Parametreler

path

string

Döndürülecek tek bir öğenin sürüm denetimi yolu.

project

string

Proje kimliği veya proje adı

fileName

string

döndürülen öğenin dosya adı.

download

boolean

Doğruysa, indirilebilir bir ek oluşturun.

scopePath

string

Birden çok öğe döndürmek için bir klasörün sürüm denetim yolu.

recursionLevel

VersionControlRecursionType

Hiçbiri (yalnızca öğe) veya OneLevel (bir klasörün içeriği).

versionDescriptor

TfvcVersionDescriptor

Sürüm tanımlayıcısı. Varsayılan değer null'tır.

includeContent

boolean

json isteğinde bulunurken öğe içeriği eklemek için true olarak ayarlayın. Varsayılan değer false'tur.

Döndürülenler

Promise<string>

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

Tek bir öğe için Öğe Meta Verileri ve/veya İçeriği alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini göstermektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.

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

Parametreler

path

string

Döndürülecek tek bir öğenin sürüm denetimi yolu.

project

string

Proje kimliği veya proje adı

fileName

string

döndürülen öğenin dosya adı.

download

boolean

Doğruysa, indirilebilir bir ek oluşturun.

scopePath

string

Birden çok öğe döndürmek için bir klasörün sürüm denetim yolu.

recursionLevel

VersionControlRecursionType

Hiçbiri (yalnızca öğe) veya OneLevel (bir klasörün içeriği).

versionDescriptor

TfvcVersionDescriptor

Sürüm tanımlayıcısı. Varsayılan değer null'tır.

includeContent

boolean

json isteğinde bulunurken öğe içeriği eklemek için true olarak ayarlayın. Varsayılan değer false'tur.

Döndürülenler

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Tek bir derin etiket alın.

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

Parametreler

labelId

string

Etiketin benzersiz tanımlayıcısı

requestData

TfvcLabelRequestData

maxItemCount

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<TfvcLabel>

getLabelItems(string, number, number)

Bir etiketin altındaki öğeleri alma.

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

Parametreler

labelId

string

Etiketin benzersiz tanımlayıcısı

top

number

Döndürülecek en fazla öğe sayısı

skip

number

Atlana öğe sayısı

Döndürülenler

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

Sığ etiket başvurularından oluşan bir koleksiyon alın.

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

Parametreler

requestData

TfvcLabelRequestData

labelScope, name, owner ve itemLabelFilter

project

string

Proje kimliği veya proje adı

top

number

Döndürülecek en fazla etiket sayısı, tanımsız olduğunda varsayılan olarak 100 olarak belirlenmiştir

skip

number

Atlana etiket sayısı

Döndürülenler

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Tek bir derin raf takımı edinin.

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

Parametreler

shelvesetId

string

Raf kümesinin benzersiz kimliği

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount ve maxCommentLength

Döndürülenler

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Raf kümesine değişiklikleri dahil edin.

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

Parametreler

shelvesetId

string

Raf kümesinin benzersiz kimliği

top

number

Döndürülecek en fazla değişiklik sayısı

skip

number

Atlana değişikliklerin sayısı

Döndürülenler

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Sığ raf kümesi başvurularından oluşan bir koleksiyon döndürür.

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

Parametreler

requestData

TfvcShelvesetRequestData

name, owner ve maxCommentLength

top

number

Döndürülecek en fazla raf kümesi sayısı

skip

number

Atlana raf kümesi sayısı

Döndürülenler

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Raf kümesiyle ilişkili iş öğelerini alma.

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

Parametreler

shelvesetId

string

Raf kümesinin benzersiz kimliği

Döndürülenler

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

TFVC için belirli bir kapsamda bir Koleksiyon/Proje için Dosya Sayısı ve Sıkıştırılmamış Baytlar sağlar.

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

Parametreler

project

string

Proje kimliği veya proje adı

scopePath

string

Koleksiyon için '$/', belirli bir proje için '$/project'

Döndürülenler

Promise<TfvcStatistics>