PluginNoticeComponentShowNoticeOptions.onCloseClick method

PluginNoticeComponentShowNoticeOptions › onCloseClick

A callback invoked when the user clicks the close (X) button, before the notice is hidden. Call PluginNoticeCloseClickEvent.cancel on the event to cancel the close and keep the notice open — for example after your own confirmation declines. An async callback is awaited before the notice is hidden. Runs only when a close button is shown (both PluginNoticeComponentShowNoticeOptions.shouldHideOnClick = false and PluginNoticeComponentShowNoticeOptions.shouldShowCloseButton are set).

Signature:

onCloseClick(this: void, event: PluginNoticeCloseClickEvent): Promisable<void>

Parameters:

Parameter	Type	Description
this	void
event	PluginNoticeCloseClickEvent

Returns: Promisable<void>