IWidget interface

Пакет:

azure-devops-extension-api

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

Свойства

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

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

disableWidgetForStakeholders

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

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

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

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Запуск мини-приложения в режиме "лайтбокс"

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

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

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

listen

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

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

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

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

load

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

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

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

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

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

onDashboardLoaded?: () => void

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

() => void

preload

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

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

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

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>