dispatchHostNotification()

Home > @gooddata/sdk-ui-pluggable-host > dispatchHostNotification

dispatchHostNotification() function

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.

Dispatches a notification into the currently mounted host UI module.

Signature:

export declare function dispatchHostNotification(notification: IHostUiNotification): void;

Parameters

Parameter	Type	Description
notification	IHostUiNotification

Returns:

void

Remarks

If no UI is mounted yet (e.g. the host bootstrap is still in progress) the notification is queued and replayed when the host UI handle registers. The queue is capped at a small bounded size; oldest entries are dropped on overflow.