IExtensionDataManager interface

الحزمة:

azure-devops-extension-api

الأساليب

createDocument(string, any, IDocumentOptions)	إرجاع وعد لإنشاء مستند في المجموعة المتوفرة
deleteDocument(string, string, IDocumentOptions)	إرجاع وعد بحذف المستند في النطاق والمجموعة والمعرف المقدم
getDocument(string, string, IDocumentOptions)	إرجاع وعد للحصول على مستند مع المعرف المقدم في المجموعة المقدمة
getDocuments(string, IDocumentOptions)	إرجاع وعد بالحصول على جميع المستندات في المجموعة المقدمة
getValue<T>(string, IDocumentOptions)	إرجاع وعد لاسترداد إعداد في المفتاح والنطاق المتوفرين
queryCollections(ExtensionDataCollection[])	إرجاع وعد للاستعلام عن مجموعة من المجموعات
queryCollectionsByName(string[])	إرجاع وعد للاستعلام عن مجموعة من المجموعات
setDocument(string, any, IDocumentOptions)	إرجاع وعد لتعيين مستند في المجموعة المقدمة إنشاء المستند إذا لم يكن موجودا، وإلا يقوم بتحديث المستند الموجود بالمعرف المقدم
setValue<T>(string, T, IDocumentOptions)	إرجاع وعد بحفظ إعداد عند المفتاح والنطاق المتوفرين
updateDocument(string, any, IDocumentOptions)	إرجاع وعد بتحديث مستند في المجموعة المقدمة يجب أن يكون المستند الذي يحتوي على المعرف المقدم موجودا

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

createDocument(string, any, IDocumentOptions)

إرجاع وعد لإنشاء مستند في المجموعة المتوفرة

function createDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>

المعلمات

collectionName

string

اسم المجموعة التي يوجد بها المستند

doc

any

المستند المراد تخزينه

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<any>

deleteDocument(string, string, IDocumentOptions)

إرجاع وعد بحذف المستند في النطاق والمجموعة والمعرف المقدم

function deleteDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<void>

المعلمات

collectionName

string

اسم المجموعة التي يوجد بها المستند

id

string

معرف المستند في المجموعة

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<void>

getDocument(string, string, IDocumentOptions)

إرجاع وعد للحصول على مستند مع المعرف المقدم في المجموعة المقدمة

function getDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<any>

المعلمات

collectionName

string

اسم المجموعة التي يوجد بها المستند

id

string

معرف المستند في المجموعة

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<any>

getDocuments(string, IDocumentOptions)

إرجاع وعد بالحصول على جميع المستندات في المجموعة المقدمة

function getDocuments(collectionName: string, documentOptions?: IDocumentOptions): Promise<any[]>

المعلمات

collectionName

string

اسم المجموعة التي يوجد بها المستند

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<any[]>

getValue<T>(string, IDocumentOptions)

إرجاع وعد لاسترداد إعداد في المفتاح والنطاق المتوفرين

function getValue<T>(key: string, documentOptions?: IDocumentOptions): Promise<T>

المعلمات

key

string

المفتاح لاسترداد قيمة ل

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<T>

queryCollections(ExtensionDataCollection[])

إرجاع وعد للاستعلام عن مجموعة من المجموعات

function queryCollections(collections: ExtensionDataCollection[]): Promise<ExtensionDataCollection[]>

المعلمات

collections

ExtensionDataCollection[]

قائمة المجموعات المراد الاستعلام عنها. ستحتوي كل مجموعة على collectionName ونوع النطاق وقيمة النطاق

المرتجعات

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

إرجاع وعد للاستعلام عن مجموعة من المجموعات

function queryCollectionsByName(collectionNames: string[]): Promise<ExtensionDataCollection[]>

المعلمات

collectionNames

string[]

المرتجعات

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

إرجاع وعد لتعيين مستند في المجموعة المقدمة إنشاء المستند إذا لم يكن موجودا، وإلا يقوم بتحديث المستند الموجود بالمعرف المقدم

function setDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>

المعلمات

collectionName

string

اسم المجموعة التي يوجد بها المستند

doc

any

المستند المراد تخزينه

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<any>

setValue<T>(string, T, IDocumentOptions)

إرجاع وعد بحفظ إعداد عند المفتاح والنطاق المتوفرين

function setValue<T>(key: string, value: T, documentOptions?: IDocumentOptions): Promise<T>

المعلمات

key

string

المفتاح لحفظ قيمة

value

T

القيمة المطلوب حفظها

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<T>

updateDocument(string, any, IDocumentOptions)

إرجاع وعد بتحديث مستند في المجموعة المقدمة يجب أن يكون المستند الذي يحتوي على المعرف المقدم موجودا

function updateDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>

المعلمات

collectionName

string

اسم المجموعة التي يوجد بها المستند

doc

any

المستند المراد تخزينه

documentOptions

IDocumentOptions

خيارات مستند الملحق، قيمة النطاق الافتراضية على مستوى الحساب

المرتجعات

Promise<any>