IConfigurableWidget interface

Pacote:

azure-devops-extension-api

Widgets configuráveis implementam esta interface

Extends

IWidget

Propriedades

reload

Quando a visualização de configuração é alterada, espera-se que o widget atualize sua exibição.

Propriedades Herdadas

disableWidgetForStakeholders	A estrutura chama esse método para determinar se o widget deve ser desativado para usuários com licença de partes interessadas
lightbox	Executar widget no modo lightboxed
listen	Ouvir mensagem do anfitrião
load	Os widgets usam as configurações fornecidas, bem como 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 juntamente com os dados armazenados em cache que possam ter para pintar um estado interativo. Nenhuma chamada de rede deve ser feita pelo widget.

Detalhes de Propriedade

reload

Quando a visualização de configuração é alterada, espera-se que o widget atualize sua exibição.

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

Valor de Propriedade

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Detalhes da Propriedade Herdada

disableWidgetForStakeholders

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

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

Valor de Propriedade

(widgetSettings: WidgetSettings) => Promise<boolean>

herdado deIWidget.disableWidgetForStakeholders

lightbox

Executar widget no modo lightboxed

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

Valor de Propriedade

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

herdado deIWidget.lightbox

listen

Ouvir mensagem do anfitrião

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

Valor de Propriedade

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

herdado deIWidget.listen

load

Os widgets usam as configurações fornecidas, bem como 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 de Propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

herdado de IWidget.load

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 de Propriedade

() => void

herdado de IWidget.onDashboardLoaded

preload

Os widgets usam as configurações fornecidas juntamente com os dados armazenados 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 de Propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

herdado de IWidget.preload