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

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>