Поделиться через

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