IHostUiMountHandle

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

IHostUiMountHandle 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.

Handle returned from a host UI mount for lifecycle management.

Signature:

export interface IHostUiMountHandle

Methods

Method

Description

getAppContainer()

(ALPHA) Returns the DOM element where the active pluggable application should be rendered.

notify(notification)?

(ALPHA) (Optional) Receives an out-of-band notification from the host runtime.

unmount()

(ALPHA) Unmounts the host UI and releases all resources.

updateApplications(apps)?

(ALPHA) (Optional) Pushes an updated list of resolved applications into the host UI.

updateContext(ctx)?

(ALPHA) (Optional) Pushes an updated platform context into the host UI.

updateHeader(header)?

(ALPHA) (Optional) Pushes updated header options into the host UI.

updatePathname(pathname)?

(ALPHA) (Optional) Pushes the current pathname into the host UI.

← IHostUiModuleIHostUiMountOptions →