IWidgetConfiguration interface

Paket:

azure-devops-extension-api

Pembuat widget mengimplementasikan antarmuka ini untuk konfigurasinya.

Properti

listen	Mendengarkan pesan dari host
load	Dipanggil oleh host untuk mengatur konfigurasi widget, yang menggunakan pengaturan yang dibagikan dengan widget untuk menyelesaikan pengalaman penyajiannya.
onSave	Dipanggil oleh host ketika pengguna mengklik tombol Simpan. Pembuat widget diharapkan menjalankan validasi jika diperlukan. Jika siap untuk menyimpan, gunakan WidgetHelpers.WidgetConfigurationSave.Valid() untuk mengembalikan pengaturan kustom berseri widget dari configuraton. Jika pengaturan kustom tidak valid dan tidak siap untuk disimpan, maka gunakan WidgetHelpers.WidgetConfigurationSave.Invalid() untuk memberi tahu host untuk berhenti menyimpan.
onSaveComplete	(Opsional) Dipanggil oleh host ketika konfigurasi siap disimpan (ketika pengguna mengklik tombol simpan pada panel konfigurasi)

Detail Properti

listen

Mendengarkan pesan dari host

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

Nilai Properti

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

load

Dipanggil oleh host untuk mengatur konfigurasi widget, yang menggunakan pengaturan yang dibagikan dengan widget untuk menyelesaikan pengalaman penyajiannya.

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

Nilai Properti

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

onSave

Dipanggil oleh host ketika pengguna mengklik tombol Simpan. Pembuat widget diharapkan menjalankan validasi jika diperlukan. Jika siap untuk menyimpan, gunakan WidgetHelpers.WidgetConfigurationSave.Valid() untuk mengembalikan pengaturan kustom berseri widget dari configuraton. Jika pengaturan kustom tidak valid dan tidak siap untuk disimpan, maka gunakan WidgetHelpers.WidgetConfigurationSave.Invalid() untuk memberi tahu host untuk berhenti menyimpan.

onSave: () => Promise<SaveStatus>

Nilai Properti

() => Promise<SaveStatus>

onSaveComplete

(Opsional) Dipanggil oleh host ketika konfigurasi siap disimpan (ketika pengguna mengklik tombol simpan pada panel konfigurasi)

onSaveComplete?: () => void

Nilai Properti

() => void