TfvcRestClient class
Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api
- Memperluas
Konstruktor
| Tfvc |
Properti
| RESOURCE_AREA_ID |
Metode
| create |
Buat set perubahan baru. |
| get |
Mengembalikan set perubahan untuk daftar Id set perubahan tertentu. |
| get |
Dapatkan hierarki cabang tunggal di jalur yang diberikan dengan orang tua atau anak seperti yang ditentukan. |
| get |
Dapatkan kumpulan akar cabang -- anak tingkat pertama, cabang tanpa orang tua. |
| get |
Dapatkan hierarki cabang di bawah scopePath yang ditentukan |
| get |
Mengambil Set Perubahan Tfvc |
| get |
Ambil perubahan Tfvc untuk set perubahan tertentu. |
| get |
Mengambil Set Perubahan Tfvc |
| get |
Mengambil item kerja yang terkait dengan set perubahan tertentu. |
| get |
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan. |
| get |
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan. |
| get |
Mendapatkan daftar item Tfvc |
| get |
Posting untuk mengambil sekumpulan item yang diberi daftar jalur atau jalur panjang. Memungkinkan untuk menentukan recursionLevel dan deskriptor versi untuk setiap jalur. |
| get |
Posting untuk mengambil sekumpulan item yang diberi daftar jalur atau jalur panjang. Memungkinkan untuk menentukan recursionLevel dan deskriptor versi untuk setiap jalur. |
| get |
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan. |
| get |
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan. |
| get |
Dapatkan label dalam tunggal. |
| get |
Dapatkan item di bawah label. |
| get |
Dapatkan kumpulan referensi label dangkal. |
| get |
Dapatkan satu rak dalam. |
| get |
Dapatkan perubahan yang disertakan dalam shelveset. |
| get |
Mengembalikan kumpulan referensi shelveset dangkal. |
| get |
Dapatkan item kerja yang terkait dengan shelveset. |
| get |
Menyediakan Jumlah File dan Byte Yang Tidak Dikompresi untuk Koleksi/Proyek pada cakupan tertentu untuk TFVC. |
Detail Konstruktor
TfvcRestClient(IVssRestClientOptions)
Detail Properti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringNilai Properti
string
Detail Metode
createChangeset(TfvcChangeset, string)
Buat set perubahan baru.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>Parameter
- changeset
- TfvcChangeset
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
Mengembalikan set perubahan untuk daftar Id set perubahan tertentu.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parameter
- changesetsRequestData
- TfvcChangesetsRequestData
Daftar ID set perubahan.
Mengembalikan
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Dapatkan hierarki cabang tunggal di jalur yang diberikan dengan orang tua atau anak seperti yang ditentukan.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parameter
- path
-
string
Jalur lengkap ke cabang. Default: $/ Contoh: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
ID proyek atau nama proyek
- includeParent
-
boolean
Kembalikan cabang induk, jika ada. Default: Salah
- includeChildren
-
boolean
Kembalikan cabang anak, jika ada. Default: Salah
Mengembalikan
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Dapatkan kumpulan akar cabang -- anak tingkat pertama, cabang tanpa orang tua.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>Parameter
- project
-
string
ID proyek atau nama proyek
- includeParent
-
boolean
Kembalikan cabang induk, jika ada. Default: Salah
- includeChildren
-
boolean
Mengembalikan cabang anak untuk setiap cabang akar. Default: Salah
- includeDeleted
-
boolean
Mengembalikan cabang yang dihapus. Default: Salah
- includeLinks
-
boolean
Mengembalikan tautan. Default: Salah
Mengembalikan
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Dapatkan hierarki cabang di bawah scopePath yang ditentukan
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parameter
- scopePath
-
string
Jalur lengkap ke cabang. Default: $/ Contoh: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
ID proyek atau nama proyek
- includeDeleted
-
boolean
Mengembalikan cabang yang dihapus. Default: Salah
- includeLinks
-
boolean
Mengembalikan tautan. Default: Salah
Mengembalikan
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Mengambil Set Perubahan 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>Parameter
- id
-
number
Ubah Id set untuk diambil.
- project
-
string
ID proyek atau nama proyek
- maxChangeCount
-
number
Jumlah perubahan yang akan dikembalikan (maksimum 100 perubahan) Default: 0
- includeDetails
-
boolean
Sertakan detail kebijakan dan catatan check-in dalam respons. Default: false
- includeWorkItems
-
boolean
Sertakan workitem. Default: false
- maxCommentLength
-
number
Sertakan detail tentang item kerja terkait dalam respons. Default: null
- includeSourceRename
-
boolean
Sertakan penggantian nama. Default: false
- skip
-
number
Jumlah hasil yang akan dilewati. Default: null
- top
-
number
Jumlah maksimum hasil yang akan dikembalikan. Default: null
- orderby
-
string
Hasil diurutkan menurut ID dalam urutan turun secara default. Gunakan asc id untuk mengurutkan menurut ID dalam urutan naik.
- searchCriteria
- TfvcChangesetSearchCriteria
Kriteria berikut tersedia (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null
Mengembalikan
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Ambil perubahan Tfvc untuk set perubahan tertentu.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parameter
- id
-
number
ID set perubahan. Default: null
- skip
-
number
Jumlah hasil yang akan dilewati. Default: null
- top
-
number
Jumlah maksimum hasil yang akan dikembalikan. Default: null
Mengembalikan
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Mengambil Set Perubahan Tfvc
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>Parameter
- project
-
string
ID proyek atau nama proyek
- maxCommentLength
-
number
Sertakan detail tentang item kerja terkait dalam respons. Default: null
- skip
-
number
Jumlah hasil yang akan dilewati. Default: null
- top
-
number
Jumlah maksimum hasil yang akan dikembalikan. Default: null
- orderby
-
string
Hasil diurutkan menurut ID dalam urutan turun secara default. Gunakan asc id untuk mengurutkan menurut ID dalam urutan naik.
- searchCriteria
- TfvcChangesetSearchCriteria
Kriteria berikut tersedia (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null
Mengembalikan
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Mengambil item kerja yang terkait dengan set perubahan tertentu.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Parameter
- id
-
number
ID set perubahan.
Mengembalikan
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>Parameter
- path
-
string
Jalur kontrol versi item individual yang akan dikembalikan.
- project
-
string
ID proyek atau nama proyek
- fileName
-
string
nama file item yang dikembalikan.
- download
-
boolean
Jika true, buat lampiran yang dapat diunduh.
- scopePath
-
string
Jalur kontrol versi folder untuk mengembalikan beberapa item.
- recursionLevel
- VersionControlRecursionType
Tidak ada (hanya item), atau OneLevel (konten folder).
- versionDescriptor
- TfvcVersionDescriptor
Deskriptor versi. Defaultnya adalah null.
- includeContent
-
boolean
Atur ke true untuk menyertakan konten item saat meminta json. Defaultnya adalah false.
Mengembalikan
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameter
- path
-
string
Jalur kontrol versi item individual yang akan dikembalikan.
- project
-
string
ID proyek atau nama proyek
- fileName
-
string
nama file item yang dikembalikan.
- download
-
boolean
Jika true, buat lampiran yang dapat diunduh.
- scopePath
-
string
Jalur kontrol versi folder untuk mengembalikan beberapa item.
- recursionLevel
- VersionControlRecursionType
Tidak ada (hanya item), atau OneLevel (konten folder).
- versionDescriptor
- TfvcVersionDescriptor
Deskriptor versi. Defaultnya adalah null.
- includeContent
-
boolean
Atur ke true untuk menyertakan konten item saat meminta json. Defaultnya adalah false.
Mengembalikan
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Mendapatkan daftar item Tfvc
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>Parameter
- project
-
string
ID proyek atau nama proyek
- scopePath
-
string
Jalur kontrol versi folder untuk mengembalikan beberapa item.
- recursionLevel
- VersionControlRecursionType
Tidak ada (hanya item), atau OneLevel (konten folder).
- includeLinks
-
boolean
Benar untuk menyertakan tautan.
- versionDescriptor
- TfvcVersionDescriptor
Mengembalikan
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Posting untuk mengambil sekumpulan item yang diberi daftar jalur atau jalur panjang. Memungkinkan untuk menentukan recursionLevel dan deskriptor versi untuk setiap jalur.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>Parameter
- itemRequestData
- TfvcItemRequestData
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
Posting untuk mengambil sekumpulan item yang diberi daftar jalur atau jalur panjang. Memungkinkan untuk menentukan recursionLevel dan deskriptor versi untuk setiap jalur.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>Parameter
- itemRequestData
- TfvcItemRequestData
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>Parameter
- path
-
string
Jalur kontrol versi item individual yang akan dikembalikan.
- project
-
string
ID proyek atau nama proyek
- fileName
-
string
nama file item yang dikembalikan.
- download
-
boolean
Jika true, buat lampiran yang dapat diunduh.
- scopePath
-
string
Jalur kontrol versi folder untuk mengembalikan beberapa item.
- recursionLevel
- VersionControlRecursionType
Tidak ada (hanya item), atau OneLevel (konten folder).
- versionDescriptor
- TfvcVersionDescriptor
Deskriptor versi. Defaultnya adalah null.
- includeContent
-
boolean
Atur ke true untuk menyertakan konten item saat meminta json. Defaultnya adalah false.
Mengembalikan
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameter
- path
-
string
Jalur kontrol versi item individual yang akan dikembalikan.
- project
-
string
ID proyek atau nama proyek
- fileName
-
string
nama file item yang dikembalikan.
- download
-
boolean
Jika true, buat lampiran yang dapat diunduh.
- scopePath
-
string
Jalur kontrol versi folder untuk mengembalikan beberapa item.
- recursionLevel
- VersionControlRecursionType
Tidak ada (hanya item), atau OneLevel (konten folder).
- versionDescriptor
- TfvcVersionDescriptor
Deskriptor versi. Defaultnya adalah null.
- includeContent
-
boolean
Atur ke true untuk menyertakan konten item saat meminta json. Defaultnya adalah false.
Mengembalikan
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Dapatkan label dalam tunggal.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parameter
- labelId
-
string
Pengidentifikasi unik label
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<TfvcLabel>
getLabelItems(string, number, number)
Dapatkan item di bawah label.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parameter
- labelId
-
string
Pengidentifikasi unik label
- top
-
number
Jumlah maksimum item yang akan dikembalikan
- skip
-
number
Jumlah item yang akan dilewati
Mengembalikan
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Dapatkan kumpulan referensi label dangkal.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Parameter
- requestData
- TfvcLabelRequestData
labelScope, nama, pemilik, dan itemLabelFilter
- project
-
string
ID proyek atau nama proyek
- top
-
number
Jumlah maksimum label yang akan dikembalikan, default ke 100 saat tidak ditentukan
- skip
-
number
Jumlah label yang akan dilewati
Mengembalikan
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Dapatkan satu rak dalam.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parameter
- shelvesetId
-
string
ID unik Shelveset
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount, dan maxCommentLength
Mengembalikan
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Dapatkan perubahan yang disertakan dalam shelveset.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parameter
- shelvesetId
-
string
ID unik Shelveset
- top
-
number
Jumlah maksimum perubahan yang akan dikembalikan
- skip
-
number
Jumlah perubahan yang akan dilewati
Mengembalikan
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Mengembalikan kumpulan referensi shelveset dangkal.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parameter
- requestData
- TfvcShelvesetRequestData
nama, pemilik, dan maxCommentLength
- top
-
number
Jumlah maksimum shelveset yang akan dikembalikan
- skip
-
number
Jumlah shelveset yang akan dilewati
Mengembalikan
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Dapatkan item kerja yang terkait dengan shelveset.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parameter
- shelvesetId
-
string
ID unik Shelveset
Mengembalikan
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Menyediakan Jumlah File dan Byte Yang Tidak Dikompresi untuk Koleksi/Proyek pada cakupan tertentu untuk TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parameter
- project
-
string
ID proyek atau nama proyek
- scopePath
-
string
'$/' untuk koleksi, '$/project' untuk proyek tertentu
Mengembalikan
Promise<TfvcStatistics>