ConfigurationEvent class

Paquete:

azure-devops-extension-api

Propiedades

ConfigurationChange	La configuración ha cambiado. Cuando se notifica este evento, se actualiza la vista previa y se habilita el botón Guardar. La carga útil esperada al notificar este evento: { data: customSettings } {customSettings} es la configuración de configuración personalizada serializada que pertenece al widget.
ConfigurationError	La configuración intenta ejecutar llamadas API y produce un error. Cuando se notifica este evento, la configuración no representa una vista y pasamos un mensaje de error al host de configuración. La carga esperada al notificar este evento: { data: string } {string} es el mensaje de error que se muestra en la parte superior de la configuración.
GeneralSettingsChanged	Se han cambiado las opciones generales de configuración del widget. Cuando se notifica este evento, se actualiza el nombre del widget o el tamaño del widget. La carga útil esperada al notificar este evento: { data: { IGeneralSettings } } {generalSettings} es el objeto serializado que contiene WidgetName y WidgetSize.

Métodos

Args<T>(T)

Detalles de las propiedades

ConfigurationChange

La configuración ha cambiado. Cuando se notifica este evento, se actualiza la vista previa y se habilita el botón Guardar.

La carga útil esperada al notificar este evento: { data: customSettings }

{customSettings} es la configuración de configuración personalizada serializada que pertenece al widget.

static ConfigurationChange: string

Valor de propiedad

string

ConfigurationError

La configuración intenta ejecutar llamadas API y produce un error. Cuando se notifica este evento, la configuración no representa una vista y pasamos un mensaje de error al host de configuración.

La carga esperada al notificar este evento: { data: string }

{string} es el mensaje de error que se muestra en la parte superior de la configuración.

static ConfigurationError: string

Valor de propiedad

string

GeneralSettingsChanged

Se han cambiado las opciones generales de configuración del widget. Cuando se notifica este evento, se actualiza el nombre del widget o el tamaño del widget.

La carga útil esperada al notificar este evento: { data: { IGeneralSettings } }

{generalSettings} es el objeto serializado que contiene WidgetName y WidgetSize.

static GeneralSettingsChanged: string

Valor de propiedad

string

Detalles del método

Args<T>(T)

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

Parámetros

payload

T

los argumentos de evento que pasamos cuando queremos notificar la configuración.

Devoluciones

EventArgs<T>