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

    Interface ItemStatusProvider

    interface ItemStatusProvider {
        eventItemStatusChanged: ListenableEvent<BasketItem, ItemStatusProvider>;
        dispose(): Promise<void>;
        fetchItemStatus(pItems: readonly BasketItem[]): Promise<void>;
        getItemStatusIcon(pItem: BasketItem): ItemStatusIcon | null | undefined;
    }

    Hierarchy (View Summary)

    Index
    eventItemStatusChanged: ListenableEvent<BasketItem, ItemStatusProvider>

    Will be triggered everytime the status of an item has changed (after it was fetched initially).

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

      Returns Promise<void>

    • Fetches the status for the given items. Afterwards getItemStatusIcon() no longer returns undefined for these items (except if the status has changed).

      Parameters

      • pItems: readonly BasketItem[]

      Returns Promise<void>

    • Returns the currently known status icon for the given item. If the status is unknown (was not fetched yet) undefined will be returned. If the item has no icon null will be returned.

      Parameters

      • pItem: BasketItem

      Returns ItemStatusIcon | null | undefined