The term intention refers to the Intention API of the SCION Microfrontend Platform.

The intent is the message that a micro application sends to interact with functionality that is available in the form of a capability.

The platform transports the intent to the micro applications that provide the requested capability. A micro application can issue an intent only if having declared an intention in its manifest. Otherwise, the platform rejects the intent.

An intent is formulated in an abstract way, having assigned a type, and optionally a qualifier. This information is used for resolving the capability; thus, it can be thought of as a form of capability addressing. See the definition of a capability for more information.

Hierarchy

  • Intent

Properties

params?: Map<string, any>

Parameters allow additional data to be passed along with the intent.

They are part of the contract between the intent publisher and the capability provider. The capability provider can declare mandatory and optional parameters. No additional parameters may be included.

Parameters have no effect on the intent routing, unlike the qualifier. If mandatory parameters are missing or non-specified parameters are included, the intent is rejected.

qualifier?: Qualifier

The qualifier is an abstract description of the intent and is expressed in the form of a dictionary.

When issuing an intent, the qualifier must be exact, i.e. not contain wildcards.

type: string

Type of functionality to intend.

Generated using TypeDoc