WidgetMetadata interface

الحزمة:

azure-devops-extension-api

معلومات تستند إلى المساهمة تصف عناصر واجهة مستخدم لوحة المعلومات.

الخصائص

allowedSizes	الأحجام التي يدعمها عنصر واجهة المستخدم.
analyticsServiceRequired	الاشتراك المنطقي الذي يشير إلى ما إذا كان عنصر واجهة المستخدم يتطلب خدمة التحليلات للعمل. يتم إخفاء عناصر واجهة المستخدم التي تتطلب خدمة التحليلات من الكتالوج إذا لم تكن خدمة التحليلات متوفرة.
catalogIconUrl	مورد لأيقونة في كتالوج عنصر واجهة المستخدم.
catalogInfoUrl	سلسلة عنوان URL للاشتراك تشير إلى معلومات عنصر واجهة المستخدم. الإعدادات الافتراضية ل URL سوق الملحقات إذا تم حذفها
configurationContributionId	معرف المساهمة الأساسية التي تحدد واجهة مستخدم التكوين المخصص ل Widget المتوفرة. فارغ إذا لم تتوفر واجهة مستخدم التكوين المخصصة.
configurationContributionRelativeId	المعرف النسبي للمساهمة الأساسية التي تحدد واجهة مستخدم التكوين المخصص ل Widget المتوفرة. فارغ إذا لم تتوفر واجهة مستخدم التكوين المخصصة.
configurationRequired	يشير إلى ما إذا كان عنصر واجهة المستخدم يتطلب التكوين قبل إضافته إلى لوحة المعلومات.
contentUri	Uri لمحتوى عنصر واجهة المستخدم الذي سيتم تحميله من .
contributionId	معرف المساهمة الأساسية التي تحدد عنصر واجهة المستخدم المقدم.
defaultSettings	الإعدادات الافتراضية الاختيارية التي سيتم نسخها إلى إعدادات عنصر واجهة المستخدم.
description	معلومات موجزة تصف عنصر واجهة المستخدم.
isEnabled	يمكن تعطيل عناصر واجهة المستخدم بواسطة متجر التطبيقات. سنحتاج إلى التعامل بأمان مع: - الاستمرار (السماح) - الطلبات (العلامة على أنها معطل، وتوفير السياق)
isNameConfigurable	قيمة منطقية لإلغاء الاشتراك تشير إلى ما إذا كان عنصر واجهة المستخدم يدعم تكوين اسم عنصر واجهة المستخدم/العنوان. يجب أن تعينه عناصر واجهة المستخدم التي تتجاهل الاسم إلى خطأ في البيان.
isVisibleFromCatalog	قيمة منطقية لإلغاء الاشتراك تشير إلى ما إذا كان عنصر واجهة المستخدم مخفيا من الكتالوج. عادة ما يتم استخدام هذا للسماح للمطورين بتعطيل إنشاء عنصر واجهة مستخدم مهمل. يجب أن يكون عنصر واجهة المستخدم حالة افتراضية وظيفية، أو أن يكون لديه تجربة تكوين، لكي يكون مرئيا من الكتالوج.
keywords	الكلمات الأساسية المقترنة بأداة واجهة المستخدم هذه، غير قابلة للتصفية وغير مرئية
lightboxOptions	خصائص الاشتراك لتخصيص عرض عنصر واجهة المستخدم في مربع حوار "مربع الضوء".
loadingImageUrl	مورد لصورة عنصر نائب للتحميل على لوحة المعلومات
name	اسم واجهة المستخدم لنوع عنصر واجهة المستخدم. يجب أن يستخدم كل عنصر واجهة مستخدم قيمة فريدة هنا.
publisherName	اسم الناشر لهذا النوع من عناصر واجهة المستخدم.
supportedScopes	عقد البيانات المطلوب لكي يعمل عنصر واجهة المستخدم ويعمل في حاويته.
tags	العلامات المقترنة بعناد واجهة المستخدم هذا، مرئية على كل عنصر واجهة مستخدم وقابلة للتصفية.
targets	معرفات هدف المساهمة
typeId	مهمل: معرف فريد محليا يواجه المطور من هذا النوع من عناصر واجهة المستخدم. يوفر معرف المساهمة معرفا فريدا عالميا لنوع عنصر واجهة المستخدم.

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

allowedSizes

الأحجام التي يدعمها عنصر واجهة المستخدم.

allowedSizes: WidgetSize[]

قيمة الخاصية

WidgetSize[]

analyticsServiceRequired

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

analyticsServiceRequired: boolean

قيمة الخاصية

boolean

catalogIconUrl

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

catalogIconUrl: string

قيمة الخاصية

string

catalogInfoUrl

سلسلة عنوان URL للاشتراك تشير إلى معلومات عنصر واجهة المستخدم. الإعدادات الافتراضية ل URL سوق الملحقات إذا تم حذفها

catalogInfoUrl: string

قيمة الخاصية

string

configurationContributionId

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

configurationContributionId: string

قيمة الخاصية

string

configurationContributionRelativeId

المعرف النسبي للمساهمة الأساسية التي تحدد واجهة مستخدم التكوين المخصص ل Widget المتوفرة. فارغ إذا لم تتوفر واجهة مستخدم التكوين المخصصة.

configurationContributionRelativeId: string

قيمة الخاصية

string

configurationRequired

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

configurationRequired: boolean

قيمة الخاصية

boolean

contentUri

Uri لمحتوى عنصر واجهة المستخدم الذي سيتم تحميله من .

contentUri: string

قيمة الخاصية

string

contributionId

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

contributionId: string

قيمة الخاصية

string

defaultSettings

الإعدادات الافتراضية الاختيارية التي سيتم نسخها إلى إعدادات عنصر واجهة المستخدم.

defaultSettings: string

قيمة الخاصية

string

description

معلومات موجزة تصف عنصر واجهة المستخدم.

description: string

قيمة الخاصية

string

isEnabled

يمكن تعطيل عناصر واجهة المستخدم بواسطة متجر التطبيقات. سنحتاج إلى التعامل بأمان مع: - الاستمرار (السماح) - الطلبات (العلامة على أنها معطل، وتوفير السياق)

isEnabled: boolean

قيمة الخاصية

boolean

isNameConfigurable

قيمة منطقية لإلغاء الاشتراك تشير إلى ما إذا كان عنصر واجهة المستخدم يدعم تكوين اسم عنصر واجهة المستخدم/العنوان. يجب أن تعينه عناصر واجهة المستخدم التي تتجاهل الاسم إلى خطأ في البيان.

isNameConfigurable: boolean

قيمة الخاصية

boolean

isVisibleFromCatalog

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

isVisibleFromCatalog: boolean

قيمة الخاصية

boolean

keywords

الكلمات الأساسية المقترنة بأداة واجهة المستخدم هذه، غير قابلة للتصفية وغير مرئية

keywords: string[]

قيمة الخاصية

string[]

lightboxOptions

خصائص الاشتراك لتخصيص عرض عنصر واجهة المستخدم في مربع حوار "مربع الضوء".

lightboxOptions: LightboxOptions

قيمة الخاصية

LightboxOptions

loadingImageUrl

مورد لصورة عنصر نائب للتحميل على لوحة المعلومات

loadingImageUrl: string

قيمة الخاصية

string

name

اسم واجهة المستخدم لنوع عنصر واجهة المستخدم. يجب أن يستخدم كل عنصر واجهة مستخدم قيمة فريدة هنا.

name: string

قيمة الخاصية

string

publisherName

اسم الناشر لهذا النوع من عناصر واجهة المستخدم.

publisherName: string

قيمة الخاصية

string

supportedScopes

عقد البيانات المطلوب لكي يعمل عنصر واجهة المستخدم ويعمل في حاويته.

supportedScopes: WidgetScope[]

قيمة الخاصية

WidgetScope[]

tags

العلامات المقترنة بعناد واجهة المستخدم هذا، مرئية على كل عنصر واجهة مستخدم وقابلة للتصفية.

tags: string[]

قيمة الخاصية

string[]

targets

معرفات هدف المساهمة

targets: string[]

قيمة الخاصية

string[]

typeId

مهمل: معرف فريد محليا يواجه المطور من هذا النوع من عناصر واجهة المستخدم. يوفر معرف المساهمة معرفا فريدا عالميا لنوع عنصر واجهة المستخدم.

typeId: string

قيمة الخاصية

string