Options
All
  • Public
  • Public/Protected
  • All
Menu

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

An intention refers to one or more capabilities that a micro application wants to interact with.

Intentions are declared in the application’s manifest and are formulated in an abstract way, consisting of a type and optionally a qualifier. The qualifier is used to differentiate capabilities of the same type.

Hierarchy

  • Intention

Index

Properties

Properties

qualifier?: Qualifier

Qualifies the capability which to interact with.

The qualifier is a dictionary of arbitrary key-value pairs to differentiate capabilities of the same type.

The intention must exactly match the qualifier of the capability, if any. The intention qualifier allows using wildcards (such as * or ?) to match multiple capabilities simultaneously.

In the intention, the following wildcards are supported:

  • **Asterisk wildcard character (*):**
    Matches capabilities with such a qualifier property no matter of its value (except null or undefined). Use it like this: {property: '*'}.
  • **Optional wildcard character (?):**
    Matches capabilities regardless of having or not having such a property. Use it like this: {property: '?'}.
  • Partial wildcard (**): Matches capabilities even if having additional properties. Use it like this: {'*': '*'}.
type: string

The type of capability to interact with.

Generated using TypeDoc