IWidget interface

Pacote:

azure-devops-extension-api

Todos os widgets implementam essa interface

Propriedades

disableWidgetForStakeholders	A estrutura chama esse método para determinar se o widget deve ser desabilitado para usuários com licença de participante
lightbox	Executar widget no modo lightboxed
listen	Ouvir a mensagem do host
load	Os widgets usam as configurações fornecidas, bem como as chamadas do lado do servidor, para concluir sua experiência de renderização. No futuro, espera-se que os widgets forneçam uma experiência de carregamento enquanto as chamadas estão sendo aguardadas para serem concluídas. Até lá, o host do widget fornecerá a experiência de carregamento
onDashboardLoaded	Os widgets gerenciam todas as operações que não são necessárias para o carregamento inicial, mas são necessárias para a experiência completa do widget.
preload	Os widgets usam as configurações fornecidas junto com os dados em cache que possam ter para pintar um estado interativo. Nenhuma chamada de rede deve ser feita pelo widget.

Detalhes da propriedade

disableWidgetForStakeholders

A estrutura chama esse método para determinar se o widget deve ser desabilitado para usuários com licença de participante

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

Valor da propriedade

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Executar widget no modo lightboxed

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

Valor da propriedade

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

listen

Ouvir a mensagem do host

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

Valor da propriedade

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

load

Os widgets usam as configurações fornecidas, bem como as chamadas do lado do servidor, para concluir sua experiência de renderização. No futuro, espera-se que os widgets forneçam uma experiência de carregamento enquanto as chamadas estão sendo aguardadas para serem concluídas. Até lá, o host do widget fornecerá a experiência de carregamento

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

Valor da propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

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

onDashboardLoaded?: () => void

Valor da propriedade

() => void

preload

Os widgets usam as configurações fornecidas junto com os dados em cache que possam ter para pintar um estado interativo. Nenhuma chamada de rede deve ser feita pelo widget.

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

Valor da propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>