ConfigurationEvent class

Balíček:

azure-devops-extension-api

Vlastnosti

ConfigurationChange	Konfigurace se změnila. Když je tato událost upozorněna, náhled se aktualizuje a tlačítko Uložit je povolené. Datová část očekávaná při oznamování této události: { data: customSettings } {customSettings} je serializovaná vlastní nastavení konfigurace týkající se widgetu.
ConfigurationError	Konfigurace se pokusí provést volání rozhraní API a selže. Když je tato událost upozorněna, konfigurace nevykreslí zobrazení a hostiteli konfigurace předáme chybovou zprávu. Datová část očekávaná při oznamování této události: { data: string } {string} je chybová zpráva, která se zobrazí v horní části konfigurace.
GeneralSettingsChanged	Změnila se obecná nastavení konfigurace widgetu. Po oznámení této události se název widgetu nebo velikost widgetu aktualizuje. Datová část očekávaná při oznamování této události: { data: { IGeneralSettings } } {generalSettings} je serializovaný objekt obsahující WidgetName a WidgetSize.

Metody

Args<T>(T)

Podrobnosti vlastnosti

ConfigurationChange

Konfigurace se změnila. Když je tato událost upozorněna, náhled se aktualizuje a tlačítko Uložit je povolené.

Datová část očekávaná při oznamování této události: { data: customSettings }

{customSettings} je serializovaná vlastní nastavení konfigurace týkající se widgetu.

static ConfigurationChange: string

Hodnota vlastnosti

string

ConfigurationError

Konfigurace se pokusí provést volání rozhraní API a selže. Když je tato událost upozorněna, konfigurace nevykreslí zobrazení a hostiteli konfigurace předáme chybovou zprávu.

Datová část očekávaná při oznamování této události: { data: string }

{string} je chybová zpráva, která se zobrazí v horní části konfigurace.

static ConfigurationError: string

Hodnota vlastnosti

string

GeneralSettingsChanged

Změnila se obecná nastavení konfigurace widgetu. Po oznámení této události se název widgetu nebo velikost widgetu aktualizuje.

Datová část očekávaná při oznamování této události: { data: { IGeneralSettings } }

{generalSettings} je serializovaný objekt obsahující WidgetName a WidgetSize.

static GeneralSettingsChanged: string

Hodnota vlastnosti

string

Podrobnosti metody

Args<T>(T)

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

Parametry

payload

T

argumenty události, které předáváme, když chceme oznámit konfiguraci.

Návraty

EventArgs<T>