Configures the interaction of the host application with the platform.

As with micro applications, you can provide a manifest for the host, allowing the host to contribute capabilities and declare intentions.

Constructors

Properties

intentionCheckDisabled?: boolean

Controls whether the host can interact with the capabilities of other apps without having to declare respective intentions.

By default, intention check is enabled. Disabling intention check is strongly discouraged.

intentionRegisterApiDisabled?: boolean

Controls whether the host can register and unregister intentions dynamically at runtime.

By default, this API is disabled. Enabling this API is strongly discouraged.

manifest?: string | Manifest

The manifest of the host.

The manifest can be passed either as an object literal or specified as a URL to be loaded over the network. Providing a manifest lets the host contribute capabilities or declare intentions.

messageDeliveryTimeout?: number

Maximum time (in milliseconds) that the platform waits to receive dispatch confirmation for messages sent by the host until rejecting the publishing Promise. By default, a timeout of 10s is used.

scopeCheckDisabled?: boolean

Controls whether the host can interact with private capabilities of other micro applications.

By default, scope check is enabled. Disabling scope check is strongly discouraged.

symbolicName?: string

Symbolic name of the host. If not set, 'host' is used as the symbolic name of the host.

The symbolic name must be unique and contain only lowercase alphanumeric characters and hyphens.