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

    Interface IntegrationPlugin

    Integration activity. createComponent has to return an instance of Integration.

    • Plugin category = Integration
    interface IntegrationPlugin {
        isAvailable?: boolean;
        name: string;
        userSettingsStorage?: UserSettingsStorage | null;
        createComponent(
            pHost: ActivityHost,
            pOptions?: ActivityOptions,
        ): Promise<Activity>;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    userSettingsStorage?: UserSettingsStorage | null

    Optional settings storage which is used to store the user settings.

    • Will be called once after the plugin was loaded.

      Parameters

      • pDescriptor: PluginDescriptor

        Plugin descriptor for this plugin.

      • pSettings: unknown

        Optional plugin specific settings which may be defined as part of the application settings.

      Returns Promise<void>