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

    Interface InfoProvider

    Extension for the item info which is used to display additional item information

    • Plugin category = ItemInfoExtension
    • Plugin sub category = InfoProvider
    interface InfoProvider {
        eventItemInfoChanged?: ListenableEvent<BasketItem, InfoProvider>;
        isAvailable?: boolean;
        name: string;
        getItemInfo(
            pItem: BasketItem,
            pEditor: ProjectEditor,
        ): Promise<Information[]>;
        getItemInfoTypes(pItem: BasketItem): InformationType[] | null;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    eventItemInfoChanged?: ListenableEvent<BasketItem, InfoProvider>

    Optional event which can be implemented to trigger an update if the information for an item has changed.

    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • Returns the available information types for the given item. Note: pItem.getCachedItemProperies() can be used to get the item properties.

      Parameters

      • pItem: BasketItem

      Returns InformationType[] | null

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