INewDeploymentAvailableHostUiNotification

Home > @gooddata/sdk-pluggable-application-model > INewDeploymentAvailableHostUiNotification

INewDeploymentAvailableHostUiNotification interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Notification dispatched when the host runtime detects that a newer build of the host application has been deployed while the user's tab is still open.

Signature:

export interface INewDeploymentAvailableHostUiNotification 

Remarks

Stale tabs continue to reference content-hashed chunk URLs that no longer exist on the server, so the user must reload to pick up the new build. The host UI module decides how to surface this (e.g. a toast with a reload action).

Properties

Property	Modifiers	Type	Description
commitHash		string	(ALPHA) Commit hash of the newly deployed build, as detected by the host runtime.
type		"newDeploymentAvailable"	(ALPHA) A new build of the host application has been deployed; the user should reload to avoid loading stale chunks. The host UI is expected to surface this to the user (e.g. as a toast with a reload action).