IWidgetConfiguration interface

Pakiet:

azure-devops-extension-api

Autorzy widżetów implementują ten interfejs do ich konfiguracji.

Właściwości

listen	Nasłuchiwanie komunikatu z hosta
load	Wywoływane przez hosta w celu skonfigurowania konfiguracji widżetu, która używa ustawień udostępnionych z widżetem w celu ukończenia jego środowiska renderowania.
onSave	Wywoływane przez hosta, gdy użytkownik kliknie przycisk Zapisz. Oczekuje się, że autor widżetu uruchomi weryfikacje w razie potrzeby. Jeśli wszystko będzie gotowe do zapisania, użyj elementu WidgetHelpers.WidgetConfigurationSave.Valid(), aby zwrócić serializowane ustawienia niestandardowe widżetu z konfiguracji. Jeśli ustawienia niestandardowe są nieprawidłowe i nie są gotowe do zapisania, użyj elementu WidgetHelpers.WidgetConfigurationSave.Invalid(), aby powiadomić hosta o zatrzymaniu zapisywania.
onSaveComplete	(Opcjonalnie) Wywoływane przez hosta, gdy konfiguracja jest gotowa do zapisania (gdy użytkownik kliknie przycisk Zapisz na panelu konfiguracji)

Szczegóły właściwości

listen

Nasłuchiwanie komunikatu z hosta

listen?: (event: string, eventArgs: EventArgs<T>) => void

Wartość właściwości

(event: string, eventArgs: EventArgs<T>) => void

load

Wywoływane przez hosta w celu skonfigurowania konfiguracji widżetu, która używa ustawień udostępnionych z widżetem w celu ukończenia jego środowiska renderowania.

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

Wartość właściwości

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

Wywoływane przez hosta, gdy użytkownik kliknie przycisk Zapisz. Oczekuje się, że autor widżetu uruchomi weryfikacje w razie potrzeby. Jeśli wszystko będzie gotowe do zapisania, użyj elementu WidgetHelpers.WidgetConfigurationSave.Valid(), aby zwrócić serializowane ustawienia niestandardowe widżetu z konfiguracji. Jeśli ustawienia niestandardowe są nieprawidłowe i nie są gotowe do zapisania, użyj elementu WidgetHelpers.WidgetConfigurationSave.Invalid(), aby powiadomić hosta o zatrzymaniu zapisywania.

onSave: () => Promise<SaveStatus>

Wartość właściwości

() => Promise<SaveStatus>

onSaveComplete

(Opcjonalnie) Wywoływane przez hosta, gdy konfiguracja jest gotowa do zapisania (gdy użytkownik kliknie przycisk Zapisz na panelu konfiguracji)

onSaveComplete?: () => void

Wartość właściwości

() => void