IConfigurableWidget interface

Pacote:

azure-devops-extension-api

Widgets configuráveis implementam essa interface

Extends

IWidget

Propriedades

reload

Quando a exibiçã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 desabilitado para usuários com licença de stakeholder
lightbox	Executar widget no modo de lightboxed
listen	Ouça a mensagem do host
load	Os widgets usam as configurações fornecidas, bem como as chamadas do lado do servidor para concluir a 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 esperadas 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 a carga 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 armazenados em cache que possam ter para pintar um estado interativo. Nenhuma chamada de rede deve ser feita pelo widget.

Detalhes da propriedade

reload

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

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

Valor da propriedade

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Detalhes das propriedades herdadas

disableWidgetForStakeholders

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

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

Valor da propriedade

(widgetSettings: WidgetSettings) => Promise<boolean>

herdado deIWidget.disableWidgetForStakeholders

lightbox

Executar widget no modo de lightboxed

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

Valor da propriedade

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

herdado de IWidget.lightbox

listen

Ouça a mensagem do host

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

Valor da propriedade

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

Herdado deIWidget.listen

load

Os widgets usam as configurações fornecidas, bem como as chamadas do lado do servidor para concluir a 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 esperadas 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>

herdado deIWidget.load

onDashboardLoaded

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

onDashboardLoaded?: () => void

Valor da propriedade

() => void

Herdado deIWidget.onDashboardLoaded

preload

Os widgets usam as configurações fornecidas junto 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 da propriedade

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Herdado doIWidget.preload