IConfigurableWidget interface

Пакет:

azure-devops-extension-api

Настраиваемые мини-приложения реализуют этот интерфейс

Extends

IWidget

Свойства

reload

При изменении представления конфигурации мини-приложение должно обновить его представление.

Унаследованные свойства

disableWidgetForStakeholders	Платформа вызывает этот метод, чтобы определить, следует ли отключить мини-приложение для пользователей с лицензией заинтересованных лиц.
lightbox	Запуск мини-приложения в режиме lightboxed
listen	Прослушивание сообщения от узла
load	Мини-приложения используют предоставленные параметры, а также вызовы на стороне сервера для завершения работы с отрисовкой. В будущем мини-приложения, как ожидается, обеспечивают загрузку во время ожидания вызовов. До тех пор узел мини-приложения предоставит возможность загрузки
onDashboardLoaded	Мини-приложения управляют любыми операциями, которые не требуются для начальной загрузки, но требуются для полного взаимодействия с мини-приложениями.
preload	мини-приложения используют параметры, предоставленные вместе с любыми кэшируемыми данными, которые они могут закрасить интерактивное состояние. Сетевые вызовы не должны выполняться мини-приложением.

Сведения о свойстве

reload

При изменении представления конфигурации мини-приложение должно обновить его представление.

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

Значение свойства

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Сведения об унаследованном свойстве

disableWidgetForStakeholders

Платформа вызывает этот метод, чтобы определить, следует ли отключить мини-приложение для пользователей с лицензией заинтересованных лиц.

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

Значение свойства

(widgetSettings: WidgetSettings) => Promise<boolean>

Унаследовано отIWidget.disableWidgetForStakeholders

lightbox

Запуск мини-приложения в режиме lightboxed

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

Значение свойства

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

унаследовано отIWidget.lightbox

listen

Прослушивание сообщения от узла

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

Значение свойства

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

унаследовано отIWidget.listen

load

Мини-приложения используют предоставленные параметры, а также вызовы на стороне сервера для завершения работы с отрисовкой. В будущем мини-приложения, как ожидается, обеспечивают загрузку во время ожидания вызовов. До тех пор узел мини-приложения предоставит возможность загрузки

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

Значение свойства

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

наследуется отIWidget.load

onDashboardLoaded

Мини-приложения управляют любыми операциями, которые не требуются для начальной загрузки, но требуются для полного взаимодействия с мини-приложениями.

onDashboardLoaded?: () => void

Значение свойства

() => void

унаследован отIWidget.onDashboardLoaded

preload

мини-приложения используют параметры, предоставленные вместе с любыми кэшируемыми данными, которые они могут закрасить интерактивное состояние. Сетевые вызовы не должны выполняться мини-приложением.

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

Значение свойства

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

унаследован отIWidget.preload