QueryFilter interface

الحزمة:

azure-devops-extension-api

عامل تصفية يستخدم لتحديد مجموعة من الملحقات لإرجاعها أثناء الاستعلام.

الخصائص

criteria	تحدد قيم عامل التصفية مجموعة القيم في هذا الاستعلام. يتم تطبيقها استنادا إلى QueryFilterType.
direction	يتم تطبيق PagingDirection على رمز استدعاء الصفحات إذا كان موجودا. إذا لم يكن الأمر كذلك، تجاهل الاتجاه، ويتم استخدام Forward من بداية مجموعة النتائج. يجب استبعاد الاتجاه من الطلب ما لم يتم استخدام رمز الترحيل للمساعدة في منع المشكلات المستقبلية.
pageNumber	رقم الصفحة الذي يطلبه المستخدم. إذا لم يتم توفيره ، يتم افتراض 1 افتراضيا.
pageSize	يحدد حجم الصفحة عدد النتائج التي يريدها المتصل لعامل التصفية هذا. لا يمكن أن يتجاوز العدد حدود حجم الاستعلام الإجمالية.
pagingToken	الرمز المميز للترحيل هو نوع مميز من عوامل التصفية ويتم تجاهل حقول التصفية الأخرى. يمثل رمز ترحيل الصفحات استمرار استعلام تم تنفيذه مسبقا. يتم تضمين المعلومات حول مكان النتيجة والحقول التي يتم تصفيتها في الرمز المميز.
sortBy	يحدد نوع الفرز المراد تطبيقه على النتائج. يتم قص شريحة الصفحة من النتائج التي تم فرزها فقط.
sortOrder	يحدد ترتيب الفرز، 1 للتصاعدي، 2 للتنازلي، وإلا الترتيب الافتراضي استنادا إلى قيمة SortBy

تفاصيل الخاصية

criteria

تحدد قيم عامل التصفية مجموعة القيم في هذا الاستعلام. يتم تطبيقها استنادا إلى QueryFilterType.

criteria: FilterCriteria[]

قيمة الخاصية

FilterCriteria[]

direction

يتم تطبيق PagingDirection على رمز استدعاء الصفحات إذا كان موجودا. إذا لم يكن الأمر كذلك، تجاهل الاتجاه، ويتم استخدام Forward من بداية مجموعة النتائج. يجب استبعاد الاتجاه من الطلب ما لم يتم استخدام رمز الترحيل للمساعدة في منع المشكلات المستقبلية.

direction: PagingDirection

قيمة الخاصية

PagingDirection

pageNumber

رقم الصفحة الذي يطلبه المستخدم. إذا لم يتم توفيره ، يتم افتراض 1 افتراضيا.

pageNumber: number

قيمة الخاصية

number

pageSize

يحدد حجم الصفحة عدد النتائج التي يريدها المتصل لعامل التصفية هذا. لا يمكن أن يتجاوز العدد حدود حجم الاستعلام الإجمالية.

pageSize: number

قيمة الخاصية

number

pagingToken

الرمز المميز للترحيل هو نوع مميز من عوامل التصفية ويتم تجاهل حقول التصفية الأخرى. يمثل رمز ترحيل الصفحات استمرار استعلام تم تنفيذه مسبقا. يتم تضمين المعلومات حول مكان النتيجة والحقول التي يتم تصفيتها في الرمز المميز.

pagingToken: string

قيمة الخاصية

string

sortBy

يحدد نوع الفرز المراد تطبيقه على النتائج. يتم قص شريحة الصفحة من النتائج التي تم فرزها فقط.

sortBy: number

قيمة الخاصية

number

sortOrder

يحدد ترتيب الفرز، 1 للتصاعدي، 2 للتنازلي، وإلا الترتيب الافتراضي استنادا إلى قيمة SortBy

sortOrder: number

قيمة الخاصية

number