IWidgetConfiguration interface

الحزمة:

azure-devops-extension-api

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

الخصائص

listen	الاستماع إلى رسالة من المضيف
load	يتم استدعاؤه من قبل المضيف لإعداد تكوين عنصر واجهة المستخدم، والذي يستخدم الإعدادات المشتركة مع عنصر واجهة المستخدم لإكمال تجربة العرض الخاصة به.
onSave	يتم استدعاؤه من قبل المضيف عندما ينقر المستخدم على الزر حفظ. من المتوقع أن يقوم كاتب عنصر واجهة المستخدم بتشغيل عمليات التحقق من الصحة إذا لزم الأمر. إذا كنت جاهزا للحفظ، فاستخدم WidgetHelpers.WidgetConfigurationSave.Valid() لإرجاع الإعدادات المخصصة المتسلسلة لأداة من configuraton. إذا كانت الإعدادات المخصصة غير صالحة وغير جاهزة للحفظ، فاستخدم WidgetHelpers.WidgetConfigurationSave.Invalid() لإعلام المضيف بإيقاف الحفظ.
onSaveComplete	(اختياري) يتم استدعاؤه بواسطة المضيف عندما يكون التكوين جاهزا للحفظ (عندما ينقر المستخدم فوق زر الحفظ في لوحة التكوين)

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

listen

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

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

قيمة الخاصية

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

load

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

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

قيمة الخاصية

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

يتم استدعاؤه من قبل المضيف عندما ينقر المستخدم على الزر حفظ. من المتوقع أن يقوم كاتب عنصر واجهة المستخدم بتشغيل عمليات التحقق من الصحة إذا لزم الأمر. إذا كنت جاهزا للحفظ، فاستخدم WidgetHelpers.WidgetConfigurationSave.Valid() لإرجاع الإعدادات المخصصة المتسلسلة لأداة من configuraton. إذا كانت الإعدادات المخصصة غير صالحة وغير جاهزة للحفظ، فاستخدم WidgetHelpers.WidgetConfigurationSave.Invalid() لإعلام المضيف بإيقاف الحفظ.

onSave: () => Promise<SaveStatus>

قيمة الخاصية

() => Promise<SaveStatus>

onSaveComplete

(اختياري) يتم استدعاؤه بواسطة المضيف عندما يكون التكوين جاهزا للحفظ (عندما ينقر المستخدم فوق زر الحفظ في لوحة التكوين)

onSaveComplete?: () => void

قيمة الخاصية

() => void