IConfigurableWidget interface

الحزمة:

azure-devops-extension-api

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

يمتد

IWidget

الخصائص

reload

عند تغيير طريقة عرض التكوين، من المتوقع أن يقوم عنصر واجهة المستخدم بتحديث طريقة العرض الخاصة به.

الخصائص الموروثة

disableWidgetForStakeholders	يستدعي إطار العمل هذا الأسلوب لتحديد ما إذا كان يجب تعطيل عنصر واجهة المستخدم للمستخدمين الذين لديهم ترخيص المساهم
lightbox	تشغيل عنصر واجهة المستخدم في وضع lightboxed
listen	الاستماع إلى رسالة من المضيف
load	تستخدم عناصر واجهة المستخدم الإعدادات المقدمة بالإضافة إلى المكالمات من جانب الخادم لإكمال تجربة العرض الخاصة بها. في المستقبل، من المتوقع أن توفر عناصر واجهة المستخدم تجربة تحميل بينما يتم انتظار المكالمات لإكمالها. حتى ذلك الحين، سيوفر مضيف عنصر واجهة المستخدم تجربة التحميل
onDashboardLoaded	تدير عناصر واجهة المستخدم أي عمليات غير ضرورية للتحميل الأولي ولكنها مطلوبة لتجربة عنصر واجهة المستخدم الكامل.
preload	تستخدم عناصر واجهة المستخدم الإعدادات المتوفرة مع أي بيانات مخزنة مؤقتا قد تضطر إلى رسم حالة تفاعلية. يجب عدم إجراء أي استدعاءات للشبكة بواسطة عنصر واجهة المستخدم.

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

reload

عند تغيير طريقة عرض التكوين، من المتوقع أن يقوم عنصر واجهة المستخدم بتحديث طريقة العرض الخاصة به.

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

قيمة الخاصية

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

تفاصيل الخاصية الموروثة

disableWidgetForStakeholders

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

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

قيمة الخاصية

(widgetSettings: WidgetSettings) => Promise<boolean>

موروث منIWidget.disableWidgetForStakeholders

lightbox

تشغيل عنصر واجهة المستخدم في وضع lightboxed

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

قيمة الخاصية

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

موروث منIWidget.lightbox

listen

الاستماع إلى رسالة من المضيف

listen?: (event: string, eventArgs: EventArgs<T>) => void

قيمة الخاصية

(event: string, eventArgs: EventArgs<T>) => void

موروث منIWidget.listen

load

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

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

قيمة الخاصية

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

موروثة منIWidget.load

onDashboardLoaded

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

onDashboardLoaded?: () => void

قيمة الخاصية

() => void

موروث منIWidget.onDashboardLoaded

preload

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

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

قيمة الخاصية

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

موروث منIWidget.preload