FileContainerRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

RestClientBase

المنشئون

FileContainerRestClient(IVssRestClientOptions)

الأساليب

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)	إنشاء العناصر المحددة في الحاوية المشار إليها.
deleteItem(number, string, string)	حذف العناصر المحددة في حاوية.
getContainers(string, string)	يحصل على حاويات تمت تصفيتها بواسطة قائمة مفصولة بفواصل من uris البيانات الاصطناعية ضمن نفس النطاق، إذا لم يتم تحديدها بإرجاع كافة الحاويات
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)	يحصل على كائن حاوية الملف المحدد بتنسيق يعتمد على المعلمات المحددة أو عنوان طلب قبول HTTP

تفاصيل المنشئ

FileContainerRestClient(IVssRestClientOptions)

new FileContainerRestClient(options: IVssRestClientOptions)

المعلمات

options

IVssRestClientOptions

تفاصيل الأسلوب

createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)

إنشاء العناصر المحددة في الحاوية المشار إليها.

function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>

المعلمات

items

VssJsonCollectionWrapperV<FileContainerItem[]>

containerId

number

scope

string

معرف فريد يمثل نطاق الحاوية. غالبا ما يكون هذا هو معرف المشروع.

المرتجعات

Promise<FileContainerItem[]>

deleteItem(number, string, string)

حذف العناصر المحددة في حاوية.

function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>

المعلمات

containerId

number

معرف الحاوية.

itemPath

string

مسار الحذف.

scope

string

معرف فريد يمثل نطاق الحاوية. غالبا ما يكون هذا هو معرف المشروع.

المرتجعات

Promise<void>

getContainers(string, string)

يحصل على حاويات تمت تصفيتها بواسطة قائمة مفصولة بفواصل من uris البيانات الاصطناعية ضمن نفس النطاق، إذا لم يتم تحديدها بإرجاع كافة الحاويات

function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>

المعلمات

scope

string

معرف فريد يمثل نطاق الحاوية. غالبا ما يكون هذا هو معرف المشروع.

artifactUris

string

المرتجعات

Promise<FileContainer[]>

getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)

يحصل على كائن حاوية الملف المحدد بتنسيق يعتمد على المعلمات المحددة أو عنوان طلب قبول HTTP

function getItems(containerId: number, scope?: string, itemPath?: string, metadata?: boolean, format?: string, downloadFileName?: string, includeDownloadTickets?: boolean, isShallow?: boolean, ignoreRequestedMediaType?: boolean, includeBlobMetadata?: boolean, saveAbsolutePath?: boolean, preferRedirect?: boolean): Promise<FileContainerItem[]>

المعلمات

containerId

number

معرف الحاوية المطلوب

scope

string

معرف فريد يمثل نطاق الحاوية. غالبا ما يكون هذا هو معرف المشروع.

itemPath

string

المسار إلى عنصر الاهتمام

metadata

boolean

إذا كان صحيحا، فإن هذا يتجاوز أي معلمة تنسيق محددة أو عنوان طلب قبول HTTP لتوفير معلومات غير متكررة لمسار العنصر المحدد

format

string

إذا تم تحديده، فإن هذا يتجاوز عنوان طلب قبول HTTP لإرجاع إما 'json' أو 'zip'. إذا تم تحديد $format، فيجب أيضا تحديد إصدار api كمعلمة استعلام.

downloadFileName

string

إذا تم تحديده وإرجاعه بخلاف تنسيق JSON، استخدام اسم التنزيل هذا (الإعدادات الافتراضية الأخرى ل itemPath)

includeDownloadTickets

boolean

isShallow

boolean

إذا كان صحيحا، فترجع فقط التوابع الفورية (الملفات & المجلدات) ل itemPath المحدد. ستقوم False بإعادة كافة العناصر بشكل متكرر داخل itemPath.

ignoreRequestedMediaType

boolean

قم بتعيين إلى صحيح لتجاهل عنوان طلب قبول HTTP. الافتراضي هو خطأ.

includeBlobMetadata

boolean

saveAbsolutePath

boolean

قم بتعيين إلى false لعدم حفظ المسار المطلق إلى الدليل المحدد للبيانات الاصطناعية في الأرشيف الذي تم إرجاعه. يعمل فقط لدلائل البيانات الاصطناعية. الافتراضي صحيح.

preferRedirect

boolean

اضبط على true للحصول على استجابة إعادة التوجيه التي تؤدي إلى الدفق مع المحتوى. الافتراضي هو خطأ.

المرتجعات

Promise<FileContainerItem[]>