Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ManifestService

Allows browsing the catalog of capabilities and managing the capabilities of the application.

The app can browse only capabilities which are visible to it, i.e., for which the app has declared an intention and which are also publicly available. Capabilities that the app provides itself are always visible to the app.

The app can also provide new capabilities or remove existing ones. If the Intention Registration API is enabled for the app, the app can also manage its intentions, which, however, is strongly discouraged. Instead, apps should declare the required functionality in their manifests using wildcard intentions.

Hierarchy

  • ManifestService

Implements

  • Initializer

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

applications

Methods

init

  • init(): Promise<void>

lookupApplications$

lookupCapabilities$

  • Allows browsing the catalog of capabilities that match the given filter.

    You can only browse capabilities that are visible to your application, that is, capabilities that you provide yourself or that are publicly available and for which you have declared an intention in your manifest.

    Type parameters

    Parameters

    • Optional filter: ManifestObjectFilter

      Control which capabilities to browse. If no or an empty filter is given, all capabilities visible to the requesting app are returned. Specified filter criteria are "AND"ed together.

      If specifying a qualifier filter, the capabilities must match that filter exactly. The filter supports the asterisk wildcard to match any value, e.g., {property: '*'}, or partial matching to find capabilities with at least the specified qualifier properties. Partial matching is enabled by appending the any-more entry to the qualifier, as following: {'*': '*'}.

    Returns Observable<T[]>

    An Observable that, when subscribed, emits the requested capabilities. It never completes and emits continuously when satisfying capabilities are registered or unregistered.

lookupIntentions$

  • Allows browsing the catalog of intentions that match the given filter.

    Parameters

    • Optional filter: ManifestObjectFilter

      Control which intentions to return. If no or an empty filter is given, no filtering takes place. Specified filter criteria are "AND"ed together.

      If specifying a qualifier filter, the intentions must match that filter exactly. The filter supports the asterisk wildcard to match any value, e.g., {property: '*'}, or partial matching to find intentions with at least the specified qualifier properties. Partial matching is enabled by appending the any-more entry to the qualifier, as following: {'*': '*'}.

    Returns Observable<Intention[]>

    An Observable that, when subscribed, emits the requested intentions. It never completes and emits continuously when satisfying intentions are registered or unregistered.

registerCapability

  • registerCapability<T>(capability: T): Promise<string>

  • Registers given capability. If the capability has public visibility, other applications can browse the capability and interact with it.

    Type parameters

    Parameters

    • capability: T

    Returns Promise<string>

    A Promise that resolves to the identity of the registered capability, or that rejects if the registration failed.

registerIntention

  • registerIntention(intention: Intention): Promise<string>

  • Registers the given intention, allowing the application to interact with public capabilities matching the intention.

    The intention can match multiple capabilities by using wildcards (such as * or ?) in the qualifier.

    This operation requires that the 'Intention Registration API' is enabled for your application.

    Parameters

    Returns Promise<string>

    A Promise that resolves to the identity of the registered intention, or that rejects if the registration failed.

unregisterCapabilities

  • Unregisters capabilities matching the given filter.

    You can only unregister capabilities of your application.

    Parameters

    • Optional filter: ManifestObjectFilter

      Control which capabilities to unregister by specifying filter criteria which are "AND"ed together. If not passing a filter, all capabilities of the requesting app are unregistered.

      If specifying a qualifier filter, the capabilities to unregister must match that filter exactly. The filter supports the asterisk wildcard to match any value, e.g., {property: '*'}, or partial matching to unregister capabilities with at least the specified qualifier properties. Partial matching is enabled by appending the any-more entry to the qualifier, as following: {'*': '*'}. Note that specifying a symbolic app name in the filter has no effect.

    Returns Promise<void>

    A Promise that resolves when unregistered the capability, or that rejects if the unregistration failed.

unregisterIntentions

  • Unregisters intentions matching the given filter.

    You can only unregister intentions of your application. This operation requires that the 'Intention Registration API' is enabled for your application.

    Parameters

    • Optional filter: ManifestObjectFilter

      Control which intentions to unregister by specifying filter criteria which are "AND"ed together. If not passing a filter, all intentions of the requesting app are unregistered.

      If specifying a qualifier filter, the intentions to unregister must match that filter exactly. The filter supports the asterisk wildcard to match any value, e.g., {property: '*'}, or partial matching to unregister intentions with at least the specified qualifier properties. Partial matching is enabled by appending the any-more entry to the qualifier, as following: {'*': '*'}. Note that specifying a symbolic app name in the filter has no effect.

    Returns Promise<void>

    A Promise that resolves when unregistered the intention, or that rejects if the unregistration failed.

Generated using TypeDoc