IWidgetConfiguration interface

Pacote:

azure-devops-extension-api

Os autores de widgets implementam essa interface para sua configuração.

Propriedades

listen	Ouvir a mensagem do host
load	Chamado pelo host para definir a configuração do widget, que usa as configurações compartilhadas com o widget para concluir sua experiência de renderização.
onSave	Chamado pelo host quando o usuário clica no botão Salvar. Espera-se que o autor do widget execute validações, se necessário. Se estiver pronto para salvar, use WidgetHelpers.WidgetConfigurationSave.Valid() para retornar as configurações personalizadas serializadas do widget da configuração. Se as configurações personalizadas não forem válidas e, portanto, não estiverem prontas para salvar, use WidgetHelpers.WidgetConfigurationSave.Invalid() para notificar o host para interromper o salvamento.
onSaveComplete	(Opcional) Chamado pelo host quando a configuração está pronta para ser salva (quando o usuário clica no botão salvar no painel de configuração)

Detalhes da propriedade

listen

Ouvir a mensagem do host

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

Valor da propriedade

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

load

Chamado pelo host para definir a configuração do widget, que usa as configurações compartilhadas com o widget para concluir sua experiência de renderização.

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

Valor da propriedade

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

Chamado pelo host quando o usuário clica no botão Salvar. Espera-se que o autor do widget execute validações, se necessário. Se estiver pronto para salvar, use WidgetHelpers.WidgetConfigurationSave.Valid() para retornar as configurações personalizadas serializadas do widget da configuração. Se as configurações personalizadas não forem válidas e, portanto, não estiverem prontas para salvar, use WidgetHelpers.WidgetConfigurationSave.Invalid() para notificar o host para interromper o salvamento.

onSave: () => Promise<SaveStatus>

Valor da propriedade

() => Promise<SaveStatus>

onSaveComplete

(Opcional) Chamado pelo host quando a configuração está pronta para ser salva (quando o usuário clica no botão salvar no painel de configuração)

onSaveComplete?: () => void

Valor da propriedade

() => void