ConfigurationEvent class

Pacote:

azure-devops-extension-api

Propriedades

ConfigurationChange	A configuração mudou. Quando esse evento é notificado, a visualização é atualizada e o botão Salvar é habilitado. A carga esperada ao notificar este evento: { data: customSettings } {customSettings} são as configurações personalizadas serializadas pertencentes ao widget.
ConfigurationError	A configuração tenta executar chamadas de API e falha. Quando esse evento é notificado, a configuração não renderiza uma exibição e passamos uma mensagem de erro para o host de configuração. A carga esperada ao notificar este evento: { data: string } {string} é a mensagem de erro exibida na parte superior da configuração.
GeneralSettingsChanged	As configurações gerais do widget foram alteradas. Quando esse evento é notificado, o nome ou o tamanho do widget é atualizado. A carga esperada ao notificar este evento: { data: { IGeneralSettings } } {generalSettings} é o objeto serializado que contém WidgetName e WidgetSize

Métodos

Args<T>(T)

Detalhes da propriedade

ConfigurationChange

A configuração mudou. Quando esse evento é notificado, a visualização é atualizada e o botão Salvar é habilitado.

A carga esperada ao notificar este evento: { data: customSettings }

{customSettings} são as configurações personalizadas serializadas pertencentes ao widget.

static ConfigurationChange: string

Valor da propriedade

string

ConfigurationError

A configuração tenta executar chamadas de API e falha. Quando esse evento é notificado, a configuração não renderiza uma exibição e passamos uma mensagem de erro para o host de configuração.

A carga esperada ao notificar este evento: { data: string }

{string} é a mensagem de erro exibida na parte superior da configuração.

static ConfigurationError: string

Valor da propriedade

string

GeneralSettingsChanged

As configurações gerais do widget foram alteradas. Quando esse evento é notificado, o nome ou o tamanho do widget é atualizado.

A carga esperada ao notificar este evento: { data: { IGeneralSettings } }

{generalSettings} é o objeto serializado que contém WidgetName e WidgetSize

static GeneralSettingsChanged: string

Valor da propriedade

string

Detalhes do método

Args<T>(T)

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

Parâmetros

payload

T

os argumentos de evento que passamos quando queremos notificar a configuração.

Retornos

EventArgs<T>