IWidgetConfiguration interface

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

Os autores de widget implementam esta interface para a respetiva configuração.

Propriedades

listen

Ouvir a mensagem do anfitrião
load

Chamado pelo anfitrião para configurar a configuração do widget, que utiliza as definições partilhadas com o widget para concluir a experiência de composição.
onSave

Chamado pelo anfitrião quando o utilizador clica no botão Guardar. Espera-se que o autor do Widget execute validações, se necessário. Se estiver pronto para guardar, utilize WidgetHelpers.WidgetConfigurationSave.Valid() para devolver as definições personalizadas serializadas do widget a partir da configuração. Se as definições personalizadas não forem válidas e, por isso, não estiverem prontas para serem guardadas, utilize WidgetHelpers.WidgetConfigurationSave.Invalid() para notificar o anfitrião para parar de guardar.
onSaveComplete

(Opcional) Chamado pelo anfitrião quando a configuração estiver pronta para ser guardada (quando o utilizador clicar no botão Guardar no painel de configuração)

Detalhes de Propriedade

listen

Ouvir a mensagem do anfitrião

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

Valor de Propriedade

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

load

Chamado pelo anfitrião para configurar a configuração do widget, que utiliza as definições partilhadas com o widget para concluir a experiência de composição.

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

Valor de Propriedade

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

onSave

Chamado pelo anfitrião quando o utilizador clica no botão Guardar. Espera-se que o autor do Widget execute validações, se necessário. Se estiver pronto para guardar, utilize WidgetHelpers.WidgetConfigurationSave.Valid() para devolver as definições personalizadas serializadas do widget a partir da configuração. Se as definições personalizadas não forem válidas e, por isso, não estiverem prontas para serem guardadas, utilize WidgetHelpers.WidgetConfigurationSave.Invalid() para notificar o anfitrião para parar de guardar.

onSave: () => Promise<SaveStatus>

Valor de Propriedade

() => Promise<SaveStatus>

onSaveComplete

(Opcional) Chamado pelo anfitrião quando a configuração estiver pronta para ser guardada (quando o utilizador clicar no botão Guardar no painel de configuração)

onSaveComplete?: () => void

Valor de Propriedade

() => void