ConfigurationEvent class

Пакет:

azure-devops-extension-api

Свойства

ConfigurationChange	Конфигурация изменилась. Когда об этом событии получает уведомление, предварительный просмотр обновляется и включается кнопка «Сохранить». Полезная нагрузка, ожидаемая при уведомлении об этом событии: { data: customSettings } {customSettings} - это сериализованные пользовательские настройки конфигурации, относящиеся к виджету.
ConfigurationError	Конфигурация пытается выполнить вызовы API и терпит неудачу. Когда об этом событии уведомляется, конфигурация не отображает представление, и мы передаем сообщение об ошибке узлу конфигурации. Полезная нагрузка, ожидаемая при уведомлении об этом событии: { data: string } {string} — это сообщение об ошибке, которое отображается в верхней части конфигурации.
GeneralSettingsChanged	Изменены общие настройки конфигурации виджета. Когда об этом событии получает уведомление, имя виджета или его размер обновляется. Полезная нагрузка, ожидаемая при уведомлении об этом событии: { data: { IGeneralSettings } } {generalSettings} - сериализованный объект, содержащий WidgetName и WidgetSize

Методы

Args<T>(T)

Сведения о свойстве

ConfigurationChange

Конфигурация изменилась. Когда об этом событии получает уведомление, предварительный просмотр обновляется и включается кнопка «Сохранить».

Полезная нагрузка, ожидаемая при уведомлении об этом событии: { data: customSettings }

{customSettings} - это сериализованные пользовательские настройки конфигурации, относящиеся к виджету.

static ConfigurationChange: string

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

string

ConfigurationError

Конфигурация пытается выполнить вызовы API и терпит неудачу. Когда об этом событии уведомляется, конфигурация не отображает представление, и мы передаем сообщение об ошибке узлу конфигурации.

Полезная нагрузка, ожидаемая при уведомлении об этом событии: { data: string }

{string} — это сообщение об ошибке, которое отображается в верхней части конфигурации.

static ConfigurationError: string

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

string

GeneralSettingsChanged

Изменены общие настройки конфигурации виджета. Когда об этом событии получает уведомление, имя виджета или его размер обновляется.

Полезная нагрузка, ожидаемая при уведомлении об этом событии: { data: { IGeneralSettings } }

{generalSettings} - сериализованный объект, содержащий WidgetName и WidgetSize

static GeneralSettingsChanged: string

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

string

Сведения о методе

Args<T>(T)

static function Args<T>(payload: T): EventArgs<T>

Параметры

payload

T

Аргументы события мы передаем, когда хотим уведомить конфигурацию.

Возвращаемое значение

EventArgs<T>