Interface Framework

The Framework (or 'system' bundle) is a special instance of a bundle. It has the id === 0 and some special methods

interface Framework {
    equals(other: Bundle): boolean;
    getAllRequiredBundles(skip?: (bundle: Bundle) => boolean): Bundle[];
    getBundleContext(): BundleContext;
    getBundleId(): number;
    getHeaders(locale?: string): BundleHeaders;
    getI18n(): I18N;
    getI18N(): I18N;
    getId(): number;
    getLocation(): string;
    getNamespace(): string;
    getRegisteredServices(): ServiceReference[];
    getRequiredBundleEntries(): {
        bundle: Bundle;
        policy: "optional"
        | "mandatory";
    }[];
    getRequiredBundles(): Bundle[];
    getResourceURL(path: string, otherBundleName?: string): string;
    getServicesInUse(): ServiceReference[];
    getState(): BundleState;
    getStateTitle(): keyof BundleStates;
    getSymbolicName(): string;
    getVersion(): SemVer;
    init(): Promise<Framework>;
    isFrameworkStarted(): boolean;
    setHeader(name: string, value: unknown): this;
    start(): Promise<Framework>;
    stop(): Promise<Framework>;
    uninstall(): Bundle | Promise<Bundle>;
}

Hierarchy (View Summary)

Methods

equals getAllRequiredBundles getBundleContext getBundleId getHeaders getI18n getI18N getId getLocation getNamespace getRegisteredServices getRequiredBundleEntries getRequiredBundles getResourceURL getServicesInUse getState getStateTitle getSymbolicName getVersion init isFrameworkStarted setHeader start stop uninstall

Methods

equals

  • equals(other: Bundle): boolean

  • Check if the bundle equals another bundle

    Parameters

    • other: Bundle

      the other bundle

    Returns boolean

    true if the bundle is equal to the other bundle.

getAllRequiredBundles

  • getAllRequiredBundles(skip?: (bundle: Bundle) => boolean): Bundle[]

  • Lookup all required bundles with an optional skip filter.

    Parameters

    • Optionalskip: (bundle: Bundle) => boolean

      a function that will determine if a bundle should be skipped (optional)

    Returns Bundle[]

    an array of required bundles.

getBundleContext

getBundleId

  • getBundleId(): number

  • Get the ID of the bundle.

    Returns number

    the bundle ID.

    Deprecated

    Use getId() instead.

getHeaders

  • getHeaders(locale?: string): BundleHeaders

  • Provides access to the manifest metadata.

    Parameters

    • Optionallocale: string

      e.g. de, en (optional)

    Returns BundleHeaders

    the bundle header metadata.

getI18n

  • getI18n(): I18N

  • Provides access to the i18n data of the bundle.

    Returns I18N

    Deprecated

    Use get getI18N() (with a capital N) instead.

getI18N

  • getI18N(): I18N

  • Provides access to the i18n data of the bundle.

    Returns I18N

    the i18n data

getId

  • getId(): number

  • Get the ID of the bundle.

    Returns number

    the bundle ID.

getLocation

  • getLocation(): string

  • Get the location of the bundle. The location is the path in the JS Registry backend

    Returns string

    the location

getNamespace

  • getNamespace(): string

  • Get the namespace of the bundle. Typically, it is the same as the symbolic name.

    Returns string

    the namespace

getRegisteredServices

getRequiredBundleEntries

  • getRequiredBundleEntries(): { bundle: Bundle; policy: "optional"
    | "mandatory" }[]

  • Lookup all required bundles together with their usage policy (mandatory or optional).

    Returns { bundle: Bundle; policy: "optional" | "mandatory" }[]

    an array of bundles and their usage policy.

getRequiredBundles

  • getRequiredBundles(): Bundle[]

  • Lookup all installed dependencies of the bundle.

    Returns Bundle[]

    an array of bundles that are dependencies.

getResourceURL

  • getResourceURL(path: string, otherBundleName?: string): string

  • Creates a URL to a given path, located in this or another bundle.

    Parameters

    • path: string

      resource path

    • OptionalotherBundleName: string

      name of another bundle (optional).

    Returns string

    resolved URL to given path.

getServicesInUse

getState

  • getState(): BundleState

  • Get the current state value of this bundle.

    Returns BundleState

    the current bundle state as number

getStateTitle

getSymbolicName

  • getSymbolicName(): string

  • Get the symbolic name (unique ID) of the bundle.

    Returns string

    the name

getVersion

  • getVersion(): SemVer

  • Get the version of the bundle.

    Returns SemVer

    the semantic version

init

  • init(): Promise<Framework>

  • Initialize the framework bundle.

    Returns Promise<Framework>

    a promise resolving to the initialized framework

isFrameworkStarted

  • isFrameworkStarted(): boolean

  • Indicate, if the framework is started.

    Returns boolean

    true if the framework is started.

setHeader

  • setHeader(name: string, value: unknown): this

  • Set a property in the bundle manifest. This method is for internal use only! Please never change the bundle's manifest data.

    Parameters

    • name: string

      manifest key

    • value: unknown

      new value.

    Returns this

    the bundle

start

  • start(): Promise<Framework>

  • Start the framework bundle.

    Returns Promise<Framework>

    a promise resolving to the started framework

stop

  • stop(): Promise<Framework>

  • Stops the framework bundle.

    Returns Promise<Framework>

    a promise resolving to the stopped framework

uninstall

  • uninstall(): Bundle | Promise<Bundle>

  • Uninstalls the bundle.

    Returns Bundle | Promise<Bundle>

    a promise resolving to the bundle or the bundle itself.

Settings

Member Visibility

On This Page

Methods