ConfigurationEvent class

  • Referência
Pacote:
azure-devops-extension-api

Propriedades

ConfigurationChange

A configuração foi alterada. Quando este evento é notificado, a pré-visualização é atualizada e o botão Guardar está ativado.

O payload esperado ao notificar este evento: { data: customSettings }

{customSettings} são as definições de configuração personalizada serializadas relativas ao widget.
ConfigurationError

A configuração tenta executar chamadas à API e falha. Quando este evento é notificado, a configuração não compõe uma vista e transmitimos uma mensagem de erro ao anfitrião de configuração.

O payload esperado ao notificar este evento: { data: string }

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

As definições gerais de configuração do Widget foram alteradas. Quando este evento é notificado, o nome do widget ou o tamanho do widget são atualizados.

O payload esperado ao notificar este evento: { data: { IGeneralSettings } }

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

Métodos

Args<T>(T)

Detalhes de Propriedade

ConfigurationChange

A configuração foi alterada. Quando este evento é notificado, a pré-visualização é atualizada e o botão Guardar está ativado.

O payload esperado ao notificar este evento: { data: customSettings }

{customSettings} são as definições de configuração personalizada serializadas relativas ao widget.

static ConfigurationChange: string

Valor de Propriedade

string

ConfigurationError

A configuração tenta executar chamadas à API e falha. Quando este evento é notificado, a configuração não compõe uma vista e transmitimos uma mensagem de erro ao anfitrião de configuração.

O payload esperado ao notificar este evento: { data: string }

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

static ConfigurationError: string

Valor de Propriedade

string

GeneralSettingsChanged

As definições gerais de configuração do Widget foram alteradas. Quando este evento é notificado, o nome do widget ou o tamanho do widget são atualizados.

O payload esperado ao notificar este evento: { data: { IGeneralSettings } }

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

static GeneralSettingsChanged: string

Valor de Propriedade

string

Detalhes de Método

Args<T>(T) 

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

Parâmetros

payload

T

os argumentos do evento que transmitimos quando queremos notificar a configuração.

Devoluções

EventArgs<T>