IWidgetConfiguration interface

Пакет:

azure-devops-extension-api

Авторы виджетов реализуют этот интерфейс для своей конфигурации.

Свойства

listen	Прослушивание сообщения от узла
load	Вызывается узлом для настройки конфигурации виджета, который использует параметры, общие с виджетом, для завершения его рендеринга.
onSave	Вызывается узлом сети, когда пользователь нажимает на кнопку Сохранить. Ожидается, что автор виджета при необходимости выполнит проверку. Если вы готовы к сохранению, используйте WidgetHelpers.WidgetConfigurationSave.Valid() для возврата сериализованных пользовательских настроек виджета из конфигурации. Если пользовательские настройки недопустимы и поэтому не готовы к сохранению, используйте 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() для возврата сериализованных пользовательских настроек виджета из конфигурации. Если пользовательские настройки недопустимы и поэтому не готовы к сохранению, используйте WidgetHelpers.WidgetConfigurationSave.Invalid() для уведомления узла сети о необходимости остановить сохранение.

onSave: () => Promise<SaveStatus>

Значение свойства

() => Promise<SaveStatus>

onSaveComplete

(Дополнительный) Вызывается узлом сети, когда конфигурация готова к сохранению (когда пользователь нажимает кнопку «Сохранить» на панели конфигурации)

onSaveComplete?: () => void

Значение свойства

() => void