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

    Interface CustomCatalogExtension

    Extension for the catalog which is used to provide custom catalogs.

    • Plugin category = CatalogExtension
    • Plugin sub category = CustomCatalog
    interface CustomCatalogExtension {
        eventCatalogsChanged?: ListenableEvent<void, CustomCatalogExtension>;
        isAvailable?: boolean;
        name: string;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
        queryArticle(pQuery: ArticleQuery): Promise<CustomArticle>;
        queryCatalogArticles(
            pQuery: CatalogArticlesQuery,
        ): Promise<CustomCatalogArticle[]>;
        queryCatalogs(pQuery: CatalogQuery): Promise<CustomCatalog[]>;
    }

    Hierarchy (View Summary)

    • Plugin
      • CustomCatalogExtension
    Index
    eventCatalogsChanged?: ListenableEvent<void, CustomCatalogExtension>

    Event wich should be triggered if the catalogs returned by queryCatalogs have changed.

    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • 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>