IWidget interface

  • Referência
Pacote:
azure-devops-extension-api

Todos os widgets implementam esta interface

Propriedades

disableWidgetForStakeholders

A arquitetura chama este método para determinar se o widget deve ser desativado para utilizadores com licença de intervenientes
lightbox

Executar widget no modo lightboxed
listen

Ouvir a mensagem do anfitrião
load

Os widgets utilizam as definições fornecidas, bem como as chamadas do lado do servidor para concluir a experiência de composição. No futuro, espera-se que os widgets forneçam uma experiência de carregamento enquanto as chamadas estão a ser esperadas para serem concluídas. Até lá, o anfitrião do widget fornecerá a experiência de carregamento
onDashboardLoaded

Os widgets gerem todas as operações que não são necessárias para a carga inicial, mas que são necessárias para a experiência completa do widget.
preload

Os widgets utilizam as definições fornecidas juntamente com os dados em cache que possam ter para pintar um estado interativo. O widget não deve efetuar chamadas de rede.

Detalhes de Propriedade

disableWidgetForStakeholders

A arquitetura chama este método para determinar se o widget deve ser desativado para utilizadores com licença de intervenientes

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

Valor de Propriedade

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Executar widget no modo lightboxed

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

Valor de Propriedade

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

listen

Ouvir a mensagem do anfitrião

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

Valor de Propriedade

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

load

Os widgets utilizam as definições fornecidas, bem como as chamadas do lado do servidor para concluir a experiência de composição. No futuro, espera-se que os widgets forneçam uma experiência de carregamento enquanto as chamadas estão a ser esperadas para serem concluídas. Até lá, o anfitrião do widget fornecerá a experiência de carregamento

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

Valor de Propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Os widgets gerem todas as operações que não são necessárias para a carga inicial, mas que são necessárias para a experiência completa do widget.

onDashboardLoaded?: () => void

Valor de Propriedade

() => void

preload

Os widgets utilizam as definições fornecidas juntamente com os dados em cache que possam ter para pintar um estado interativo. O widget não deve efetuar chamadas de rede.

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

Valor de Propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>