Freigeben über

IWidgetConfiguration interface

  • Referenz
Paket:
azure-devops-extension-api

Widgetautoren implementieren diese Schnittstelle für ihre Konfiguration.

Eigenschaften

listen

Nachrichten vom Host anhören
load

Wird vom Host aufgerufen, um die Widgetkonfiguration einzurichten, die die für das Widget freigegebenen Einstellungen verwendet, um die Renderingerfahrung abzuschließen.
onSave

Wird vom Host aufgerufen, wenn der Benutzer auf die Schaltfläche Speichern klickt. Vom Widgetautor wird erwartet, dass er bei Bedarf Überprüfungen ausführen kann. Wenn Sie zum Speichern bereit sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Valid(), um die serialisierten benutzerdefinierten Einstellungen des Widgets aus dem Configuraton zurückzugeben. Wenn benutzerdefinierte Einstellungen ungültig sind und daher nicht zum Speichern bereit sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Invalid(), um den Host zu benachrichtigen, das Speichern zu beenden.
onSaveComplete

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

Details zur Eigenschaft

listen

Nachrichten vom Host anhören

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

Eigenschaftswert

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

load

Wird vom Host aufgerufen, um die Widgetkonfiguration einzurichten, die die für das Widget freigegebenen Einstellungen verwendet, um die Renderingerfahrung abzuschließen.

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. Vom Widgetautor wird erwartet, dass er bei Bedarf Überprüfungen ausführen kann. Wenn Sie zum Speichern bereit sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Valid(), um die serialisierten benutzerdefinierten Einstellungen des Widgets aus dem Configuraton zurückzugeben. Wenn benutzerdefinierte Einstellungen ungültig sind und daher nicht zum Speichern bereit sind, verwenden Sie WidgetHelpers.WidgetConfigurationSave.Invalid(), um den Host zu benachrichtigen, das Speichern zu beenden.

onSave: () => Promise<SaveStatus>

Eigenschaftswert

() => Promise<SaveStatus>

onSaveComplete

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

onSaveComplete?: () => void

Eigenschaftswert

() => void