TfvcRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- يمتد
الخصائص
| RESOURCE_AREA_ID |
الأساليب
| create |
إنشاء مجموعة تغييرات جديدة. |
| get |
إرجاع مجموعات التغييرات لقائمة معينة من معرفات مجموعة التغييرات. |
| get |
احصل على تدرج هرمي فرعي واحد في المسار المحدد مع الوالدين أو الأطفال كما هو محدد. |
| get |
احصل على مجموعة من جذور الفروع - أطفال من المستوى الأول ، فروع بدون آباء. |
| get |
الحصول على التدرجات الهرمية للفروع أسفل scopePath المحدد |
| get |
استرداد مجموعة تغييرات Tfvc |
| get |
استرداد تغييرات Tfvc لمجموعة تغييرات معينة. |
| get |
استرداد مجموعات التغيير Tfvc |
| get |
استرداد عناصر العمل المقترنة بمجموعة تغييرات معينة. |
| get |
الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل. |
| get |
الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل. |
| get |
احصل على قائمة بعناصر Tfvc |
| get |
انشر لاسترداد مجموعة من العناصر بإعطاء قائمة بالمسارات أو مسار طويل. يسمح بتحديد واصفات العودية والإصدار لكل مسار. |
| get |
انشر لاسترداد مجموعة من العناصر بإعطاء قائمة بالمسارات أو مسار طويل. يسمح بتحديد واصفات العودية والإصدار لكل مسار. |
| get |
الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل. |
| get |
الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل. |
| get |
احصل على ملصق عميق واحد. |
| get |
الحصول على عناصر ضمن تصنيف. |
| get |
احصل على مجموعة من مراجع الملصقات الضحلة. |
| get |
احصل على مجموعة واحدة عميقة. |
| get |
احصل على التغييرات المضمنة في مجموعة الحافظات. |
| get |
إرجاع مجموعة من مراجع الجداول الضحلة. |
| get |
الحصول على عناصر العمل المقترنة بمجموعة أرجف. |
| get |
يوفر عدد الملفات ووحدات البايت غير المضغوطة لمجموعة/مشروع في نطاق معين ل TFVC. |
تفاصيل المنشئ
TfvcRestClient(IVssRestClientOptions)
تفاصيل الخاصية
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringقيمة الخاصية
string
تفاصيل الأسلوب
createChangeset(TfvcChangeset, string)
إنشاء مجموعة تغييرات جديدة.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>المعلمات
- changeset
- TfvcChangeset
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
إرجاع مجموعات التغييرات لقائمة معينة من معرفات مجموعة التغييرات.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>المعلمات
- changesetsRequestData
- TfvcChangesetsRequestData
قائمة معرفات مجموعة التغييرات.
المرتجعات
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
احصل على تدرج هرمي فرعي واحد في المسار المحدد مع الوالدين أو الأطفال كما هو محدد.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>المعلمات
- path
-
string
المسار الكامل للفرع. الافتراضي: $/ أمثلة: $/، $/MyProject، $/MyProject/SomeFolder.
- project
-
string
معرف المشروع أو اسم المشروع
- includeParent
-
boolean
قم بإرجاع الفرع الأصل، إذا كان هناك واحد. الافتراضي: خطأ
- includeChildren
-
boolean
إرجاع الفروع الفرعية إن وجدت. الافتراضي: خطأ
المرتجعات
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
احصل على مجموعة من جذور الفروع - أطفال من المستوى الأول ، فروع بدون آباء.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- includeParent
-
boolean
قم بإرجاع الفرع الأصل، إذا كان هناك واحد. الافتراضي: خطأ
- includeChildren
-
boolean
إرجاع الفروع الفرعية لكل فرع جذر. الافتراضي: خطأ
- includeDeleted
-
boolean
إرجاع الفروع المحذوفة. الافتراضي: خطأ
- includeLinks
-
boolean
إرجاع الروابط. الافتراضي: خطأ
المرتجعات
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
الحصول على التدرجات الهرمية للفروع أسفل scopePath المحدد
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>المعلمات
- scopePath
-
string
المسار الكامل للفرع. الافتراضي: $/ أمثلة: $/، $/MyProject، $/MyProject/SomeFolder.
- project
-
string
معرف المشروع أو اسم المشروع
- includeDeleted
-
boolean
إرجاع الفروع المحذوفة. الافتراضي: خطأ
- includeLinks
-
boolean
إرجاع الروابط. الافتراضي: خطأ
المرتجعات
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
استرداد مجموعة تغييرات 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>المعلمات
- id
-
number
معرف مجموعة التغييرات لاسترداده.
- project
-
string
معرف المشروع أو اسم المشروع
- maxChangeCount
-
number
عدد التغييرات المطلوب إرجاعها (بحد أقصى 100 تغيير) الافتراضي: 0
- includeDetails
-
boolean
قم بتضمين تفاصيل السياسة وملاحظات الإيداع في الاستجابة. الافتراضي: false
- includeWorkItems
-
boolean
تضمين عناصر العمل. الافتراضي: false
- maxCommentLength
-
number
قم بتضمين تفاصيل حول عناصر العمل المقترنة في الاستجابة. الافتراضي: null
- includeSourceRename
-
boolean
تضمين عمليات إعادة التسمية. الافتراضي: false
- skip
-
number
عدد النتائج التي يجب تخطيها. الافتراضي: null
- top
-
number
الحد الأقصى لعدد النتائج التي سيتم إرجاعها. الافتراضي: null
- orderby
-
string
يتم فرز النتائج حسب المعرف بترتيب تنازلي بشكل افتراضي. استخدم id asc للفرز حسب المعرف بترتيب تصاعدي.
- searchCriteria
- TfvcChangesetSearchCriteria
المعايير التالية المتاحة (.itemPath ، .version ، .versionType ، .versionOption ، .author ، .fromId ، .toId ، .fromDate ، .toDate) الافتراضي: null
المرتجعات
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
استرداد تغييرات Tfvc لمجموعة تغييرات معينة.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>المعلمات
- id
-
number
معرف مجموعة التغييرات. الافتراضي: null
- skip
-
number
عدد النتائج التي يجب تخطيها. الافتراضي: null
- top
-
number
الحد الأقصى لعدد النتائج التي سيتم إرجاعها. الافتراضي: null
المرتجعات
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
استرداد مجموعات التغيير Tfvc
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- maxCommentLength
-
number
قم بتضمين تفاصيل حول عناصر العمل المقترنة في الاستجابة. الافتراضي: null
- skip
-
number
عدد النتائج التي يجب تخطيها. الافتراضي: null
- top
-
number
الحد الأقصى لعدد النتائج التي سيتم إرجاعها. الافتراضي: null
- orderby
-
string
يتم فرز النتائج حسب المعرف بترتيب تنازلي بشكل افتراضي. استخدم id asc للفرز حسب المعرف بترتيب تصاعدي.
- searchCriteria
- TfvcChangesetSearchCriteria
المعايير التالية المتاحة (.itemPath ، .version ، .versionType ، .versionOption ، .author ، .fromId ، .toId ، .fromDate ، .toDate) الافتراضي: null
المرتجعات
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
استرداد عناصر العمل المقترنة بمجموعة تغييرات معينة.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>المعلمات
- id
-
number
معرف مجموعة التغييرات.
المرتجعات
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
الحصول على بيانات تعريف العنصر و/أو المحتوى لعنصر واحد. معلمة التنزيل هي للإشارة إلى ما إذا كان يجب أن يكون المحتوى متوفرا كتنزيل أو مجرد إرساله كتدفق في الاستجابة. لا ينطبق على المحتوى المضغوط الذي يتم إرجاعه دائما كتنزيل.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>المعلمات
- path
-
string
مسار التحكم في الإصدار لعنصر فردي لإرجاعه.
- project
-
string
معرف المشروع أو اسم المشروع
- fileName
-
string
اسم ملف العنصر الذي تم إرجاعه.
- download
-
boolean
إذا كان هذا صحيحا، فقم بإنشاء مرفق قابل للتنزيل.
- scopePath
-
string
مسار التحكم في الإصدار لمجلد لإرجاع عناصر متعددة.
- recursionLevel
- VersionControlRecursionType
لا شيء (العنصر فقط) ، أو OneLevel (محتويات المجلد).
- versionDescriptor
- TfvcVersionDescriptor
واصف الإصدار. القيمة الافتراضية خالية.
- includeContent
-
boolean
قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.
المرتجعات
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>المعلمات
- path
-
string
مسار التحكم في الإصدار لعنصر فردي لإرجاعه.
- project
-
string
معرف المشروع أو اسم المشروع
- fileName
-
string
اسم ملف العنصر الذي تم إرجاعه.
- download
-
boolean
إذا كان هذا صحيحا، فقم بإنشاء مرفق قابل للتنزيل.
- scopePath
-
string
مسار التحكم في الإصدار لمجلد لإرجاع عناصر متعددة.
- recursionLevel
- VersionControlRecursionType
لا شيء (العنصر فقط) ، أو OneLevel (محتويات المجلد).
- versionDescriptor
- TfvcVersionDescriptor
واصف الإصدار. القيمة الافتراضية خالية.
- includeContent
-
boolean
قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.
المرتجعات
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
احصل على قائمة بعناصر Tfvc
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- scopePath
-
string
مسار التحكم في الإصدار لمجلد لإرجاع عناصر متعددة.
- recursionLevel
- VersionControlRecursionType
لا شيء (العنصر فقط) ، أو OneLevel (محتويات المجلد).
- includeLinks
-
boolean
صحيح لتضمين الارتباطات.
- versionDescriptor
- TfvcVersionDescriptor
المرتجعات
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
انشر لاسترداد مجموعة من العناصر بإعطاء قائمة بالمسارات أو مسار طويل. يسمح بتحديد واصفات العودية والإصدار لكل مسار.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>المعلمات
- itemRequestData
- TfvcItemRequestData
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
انشر لاسترداد مجموعة من العناصر بإعطاء قائمة بالمسارات أو مسار طويل. يسمح بتحديد واصفات العودية والإصدار لكل مسار.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>المعلمات
- itemRequestData
- TfvcItemRequestData
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
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>المعلمات
- path
-
string
مسار التحكم في الإصدار لعنصر فردي لإرجاعه.
- project
-
string
معرف المشروع أو اسم المشروع
- fileName
-
string
اسم ملف العنصر الذي تم إرجاعه.
- download
-
boolean
إذا كان هذا صحيحا، فقم بإنشاء مرفق قابل للتنزيل.
- scopePath
-
string
مسار التحكم في الإصدار لمجلد لإرجاع عناصر متعددة.
- recursionLevel
- VersionControlRecursionType
لا شيء (العنصر فقط) ، أو OneLevel (محتويات المجلد).
- versionDescriptor
- TfvcVersionDescriptor
واصف الإصدار. القيمة الافتراضية خالية.
- includeContent
-
boolean
قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.
المرتجعات
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>المعلمات
- path
-
string
مسار التحكم في الإصدار لعنصر فردي لإرجاعه.
- project
-
string
معرف المشروع أو اسم المشروع
- fileName
-
string
اسم ملف العنصر الذي تم إرجاعه.
- download
-
boolean
إذا كان هذا صحيحا، فقم بإنشاء مرفق قابل للتنزيل.
- scopePath
-
string
مسار التحكم في الإصدار لمجلد لإرجاع عناصر متعددة.
- recursionLevel
- VersionControlRecursionType
لا شيء (العنصر فقط) ، أو OneLevel (محتويات المجلد).
- versionDescriptor
- TfvcVersionDescriptor
واصف الإصدار. القيمة الافتراضية خالية.
- includeContent
-
boolean
قم بتعيين إلى true لتضمين محتوى العنصر عند طلب json. الافتراضي هو خطأ.
المرتجعات
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
احصل على ملصق عميق واحد.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>المعلمات
- labelId
-
string
المعرف الفريد للتصنيف
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TfvcLabel>
getLabelItems(string, number, number)
الحصول على عناصر ضمن تصنيف.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>المعلمات
- labelId
-
string
المعرف الفريد للتصنيف
- top
-
number
الحد الأقصى لعدد العناصر المراد إرجاعها
- skip
-
number
عدد العناصر التي يجب تخطيها
المرتجعات
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
احصل على مجموعة من مراجع الملصقات الضحلة.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>المعلمات
- requestData
- TfvcLabelRequestData
labelScope والاسم والمالك والitemLabelFilter
- project
-
string
معرف المشروع أو اسم المشروع
- top
-
number
الحد الأقصى لعدد التسميات المراد إرجاعها ، يتم تعيينه افتراضيا على 100 عندما يكون غير محدد
- skip
-
number
عدد الملصقات المطلوب تخطيها
المرتجعات
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
احصل على مجموعة واحدة عميقة.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>المعلمات
- shelvesetId
-
string
معرف Racket الفريد
- requestData
- TfvcShelvesetRequestData
includeDetails وincludeWorkItems وmaxChangeCount وmaxCommentLength
المرتجعات
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
احصل على التغييرات المضمنة في مجموعة الحافظات.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>المعلمات
- shelvesetId
-
string
معرف Racket الفريد
- top
-
number
الحد الأقصى لعدد التغييرات المطلوب إرجاعها
- skip
-
number
عدد التغييرات التي يجب تخطيها
المرتجعات
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
إرجاع مجموعة من مراجع الجداول الضحلة.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>المعلمات
- requestData
- TfvcShelvesetRequestData
الاسم والمالك وmaxCommentLength
- top
-
number
الحد الأقصى لعدد مجموعات القوائم المراد إرجاعها
- skip
-
number
عدد مجموعات الرفوف المراد تخطيها
المرتجعات
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
الحصول على عناصر العمل المقترنة بمجموعة أرجف.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>المعلمات
- shelvesetId
-
string
معرف Racket الفريد
المرتجعات
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
يوفر عدد الملفات ووحدات البايت غير المضغوطة لمجموعة/مشروع في نطاق معين ل TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- scopePath
-
string
"$/" للتحصيل، "$/مشروع" لمشروع معين
المرتجعات
Promise<TfvcStatistics>