@dxos/app-framework - v0.8.3
    Preparing search index...

    Interface PluginManager

    Interface for the Plugin Manager.

    interface PluginManager {
        "[ManagerTypeId]": typeof PluginManager.ManagerTypeId;
        activation: PubSub<ActivationMessage>;
        active: Atom<readonly string[]>;
        capabilities: CapabilityManager.CapabilityManager;
        core: Atom<readonly string[]>;
        enabled: Atom<readonly string[]>;
        eventsFired: Atom<readonly string[]>;
        modules: Atom<readonly PluginModule[]>;
        pendingReset: Atom<readonly string[]>;
        plugins: Atom<readonly Plugin.Plugin[]>;
        registry: Registry;
        activate(
            event: string | ActivationEvent.ActivationEvent,
            params?: { after?: string; before?: string },
        ): Effect<boolean, Error>;
        add(id: string): Effect<Plugin.Plugin, Error>;
        deactivate(id: string): Effect<boolean, Error>;
        disable(id: string): Effect<boolean, Error>;
        enable(id: string): Effect<boolean, Error>;
        getActive(): readonly string[];
        getCore(): readonly string[];
        getEnabled(): readonly string[];
        getEventsFired(): readonly string[];
        getModules(): readonly PluginModule[];
        getPendingReset(): readonly string[];
        getPlugins(): readonly Plugin.Plugin[];
        remove(id: string): boolean;
        reset(
            event: string | ActivationEvent.ActivationEvent,
        ): Effect<boolean, Error>;
        shutdown(): Effect<boolean, Error>;
    }
    Index

    Properties

    [ManagerTypeId] activation active capabilities core enabled eventsFired modules pendingReset plugins registry

    Methods

    activate add deactivate disable enable getActive getCore getEnabled getEventsFired getModules getPendingReset getPlugins remove reset shutdown

    Properties

    "[ManagerTypeId]": typeof PluginManager.ManagerTypeId
    activation: PubSub<ActivationMessage>
    active: Atom<readonly string[]>
    capabilities: CapabilityManager.CapabilityManager
    core: Atom<readonly string[]>
    enabled: Atom<readonly string[]>
    eventsFired: Atom<readonly string[]>
    modules: Atom<readonly PluginModule[]>
    pendingReset: Atom<readonly string[]>
    plugins: Atom<readonly Plugin.Plugin[]>
    registry: Registry

    Methods

    • Shuts down the manager by deactivating all active modules in reverse activation order, clearing all capabilities, and resetting lifecycle bookkeeping. Plugins, core, enabled, and modules remain intact so the manager can be reused.

      Returns Effect<boolean, Error>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods