IWidgetConfiguration interface

Paket:

azure-devops-extension-api

Widget yazarları, yapılandırmaları için bu arabirimi uygular.

Özellikler

listen	Ev sahibinden gelen mesajı dinleyin
load	İşleme deneyimini tamamlamak için widget ile paylaşılan ayarları kullanan widget yapılandırmasını ayarlamak için ana bilgisayar tarafından çağrılır.
onSave	Kullanıcı Kaydet düğmesine tıkladığında ana bilgisayar tarafından çağrılır. Widget yazarının gerekirse doğrulamaları çalıştırması beklenir. Kaydetmeye hazırsanız, widget'ın serileştirilmiş özel ayarlarını yapılandırmadan döndürmek için WidgetHelpers.WidgetConfigurationSave.Valid() öğesini kullanın. Özel ayarlar geçerli değilse ve bu nedenle kaydetmeye hazır değilse, ana bilgisayara kaydetmeyi durdurmasını bildirmek için WidgetHelpers.WidgetConfigurationSave.Invalid() öğesini kullanın.
onSaveComplete	(İsteğe bağlı) Konfigürasyon kaydedilmeye hazır olduğunda ana bilgisayar tarafından çağrılır (kullanıcı konfigürasyon panelindeki kaydet düğmesine tıkladığında)

Özellik Ayrıntıları

listen

Ev sahibinden gelen mesajı dinleyin

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

Özellik Değeri

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

load

İşleme deneyimini tamamlamak için widget ile paylaşılan ayarları kullanan widget yapılandırmasını ayarlamak için ana bilgisayar tarafından çağrılır.

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

Özellik Değeri

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

onSave

Kullanıcı Kaydet düğmesine tıkladığında ana bilgisayar tarafından çağrılır. Widget yazarının gerekirse doğrulamaları çalıştırması beklenir. Kaydetmeye hazırsanız, widget'ın serileştirilmiş özel ayarlarını yapılandırmadan döndürmek için WidgetHelpers.WidgetConfigurationSave.Valid() öğesini kullanın. Özel ayarlar geçerli değilse ve bu nedenle kaydetmeye hazır değilse, ana bilgisayara kaydetmeyi durdurmasını bildirmek için WidgetHelpers.WidgetConfigurationSave.Invalid() öğesini kullanın.

onSave: () => Promise<SaveStatus>

Özellik Değeri

() => Promise<SaveStatus>

onSaveComplete

(İsteğe bağlı) Konfigürasyon kaydedilmeye hazır olduğunda ana bilgisayar tarafından çağrılır (kullanıcı konfigürasyon panelindeki kaydet düğmesine tıkladığında)

onSaveComplete?: () => void

Özellik Değeri

() => void