pCon.basket - Plugin Development
    Preparing search index...

    Interface PluginComponent

    interface PluginComponent {
        isActive?: boolean;
        dispose(): Promise<void>;
        setActive?(pActive: boolean): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    isActive?: boolean

    Optional activity state of this component. Initial component state should be inactive (false or undefined).

    • Called if this instance is no longer in use. Should be used to clean-up resources.

      Returns Promise<void>

    • Optional activity state handling for this component. E.g. can be used to disable/enable event handling. Will be set from the component host to activate or deactivate the component. Initial component state should be inactive (false or undefined).

      Parameters

      • pActive: boolean

      Returns Promise<void>