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

    Interface CatalogItemFilterExtension

    Extension for the catalog which is used to filter the displayed catalog items.

    • Plugin category = CatalogExtension
    • Plugin sub category = CatalogItemFilter
    interface CatalogItemFilterExtension {
        isAvailable?: boolean;
        name: string;
        requiredResourceTypes?: string[];
        filterCatalogItems(
            pItems: readonly CatalogItem[],
            pOptions: FilterCatalogItemsOptions,
        ): CatalogItem[];
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    • Plugin
      • CatalogItemFilterExtension
    Index
    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    requiredResourceTypes?: string[]

    Optional list of catalog item resource types which can be used to request additional resources that are necessary for filtering the catalog items.

    • 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>