IWidgetConfiguration interface

Paket:

azure-devops-extension-api

Widget-Autoren implementieren diese Schnittstelle für ihre Konfiguration.

Eigenschaften

listen	Hören Sie sich die Nachricht des Gastgebers an
load	Wird vom Host aufgerufen, um die Widget-Konfiguration einzurichten, die die für das Widget freigegebenen Einstellungen verwendet, um das Rendern zu vervollständigen.
onSave	Wird vom Host aufgerufen, wenn der Benutzer auf die Schaltfläche Speichern klickt. Es wird erwartet, dass der Widget-Autor bei Bedarf Validierungen ausführt. Wenn Sie bereit zum Speichern sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Valid(), um die serialisierten benutzerdefinierten Einstellungen des Widgets aus der Konfiguration zurückzugeben. Wenn benutzerdefinierte Einstellungen nicht gültig sind und daher nicht zum Speichern bereit sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Invalid(), um den Host zu benachrichtigen, den Speichervorgang zu beenden.
onSaveComplete	(Fakultativ) Wird vom Host aufgerufen, wenn die Konfiguration zum Speichern bereit ist (wenn der Benutzer auf die Schaltfläche "Speichern" im Konfigurationsfenster klickt)

Details zur Eigenschaft

listen

Hören Sie sich die Nachricht des Gastgebers an

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

Eigenschaftswert

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

load

Wird vom Host aufgerufen, um die Widget-Konfiguration einzurichten, die die für das Widget freigegebenen Einstellungen verwendet, um das Rendern zu vervollständigen.

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

Eigenschaftswert

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

onSave

Wird vom Host aufgerufen, wenn der Benutzer auf die Schaltfläche Speichern klickt. Es wird erwartet, dass der Widget-Autor bei Bedarf Validierungen ausführt. Wenn Sie bereit zum Speichern sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Valid(), um die serialisierten benutzerdefinierten Einstellungen des Widgets aus der Konfiguration zurückzugeben. Wenn benutzerdefinierte Einstellungen nicht gültig sind und daher nicht zum Speichern bereit sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Invalid(), um den Host zu benachrichtigen, den Speichervorgang zu beenden.

onSave: () => Promise<SaveStatus>

Eigenschaftswert

() => Promise<SaveStatus>

onSaveComplete

(Fakultativ) Wird vom Host aufgerufen, wenn die Konfiguration zum Speichern bereit ist (wenn der Benutzer auf die Schaltfläche "Speichern" im Konfigurationsfenster klickt)

onSaveComplete?: () => void

Eigenschaftswert

() => void