IConfigurableWidget interface

Paket:

azure-devops-extension-api

Widget yang dapat dikonfigurasi mengimplementasikan antarmuka ini

Memperluas

IWidget

Properti

reload

Ketika tampilan konfigurasi diubah, widget diharapkan untuk memperbarui tampilannya.

Properti yang Diwariskan

disableWidgetForStakeholders	Kerangka kerja memanggil metode ini untuk menentukan apakah widget harus dinonaktifkan untuk pengguna dengan lisensi pemangku kepentingan
lightbox	Jalankan widget dalam mode lightboxed
listen	Mendengarkan pesan dari host
load	Widget menggunakan pengaturan yang disediakan serta panggilan sisi server untuk menyelesaikan pengalaman penyajian mereka. Di masa mendatang, widget diharapkan memberikan pengalaman pemuatan saat panggilan sedang menunggu untuk diselesaikan. Sampai saat itu, host widget akan memberikan pengalaman pemuatan
onDashboardLoaded	Widget mengelola operasi apa pun yang tidak diperlukan untuk beban awal tetapi diperlukan untuk pengalaman widget lengkap.
preload	widget menggunakan pengaturan yang disediakan bersama dengan data cache apa pun yang mungkin harus mereka cat status interaktif. Tidak ada panggilan jaringan yang harus dilakukan oleh widget.

Detail Properti

reload

Ketika tampilan konfigurasi diubah, widget diharapkan untuk memperbarui tampilannya.

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Nilai Properti

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Detail Properti yang Diwariskan

disableWidgetForStakeholders

Kerangka kerja memanggil metode ini untuk menentukan apakah widget harus dinonaktifkan untuk pengguna dengan lisensi pemangku kepentingan

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

Nilai Properti

(widgetSettings: WidgetSettings) => Promise<boolean>

Diwarisi dariIWidget.disableWidgetForStakeholders

lightbox

Jalankan widget dalam mode lightboxed

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

Nilai Properti

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

Diwarisi dariIWidget.lightbox

listen

Mendengarkan pesan dari host

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

Nilai Properti

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

Diwarisi dariIWidget.listen

load

Widget menggunakan pengaturan yang disediakan serta panggilan sisi server untuk menyelesaikan pengalaman penyajian mereka. Di masa mendatang, widget diharapkan memberikan pengalaman pemuatan saat panggilan sedang menunggu untuk diselesaikan. Sampai saat itu, host widget akan memberikan pengalaman pemuatan

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Nilai Properti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Diwarisi dariIWidget.load

onDashboardLoaded

Widget mengelola operasi apa pun yang tidak diperlukan untuk beban awal tetapi diperlukan untuk pengalaman widget lengkap.

onDashboardLoaded?: () => void

Nilai Properti

() => void

Diwarisi dariIWidget.onDashboardLoaded

preload

widget menggunakan pengaturan yang disediakan bersama dengan data cache apa pun yang mungkin harus mereka cat status interaktif. Tidak ada panggilan jaringan yang harus dilakukan oleh widget.

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Nilai Properti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Diwarisi dariIWidget.preload