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

    Interface Catalog

    interface Catalog {
        isActive?: boolean;
        onInsertArticle:
            | (
                (
                    pArticle: ArticleCatalogItem | InsertInfo,
                    pOptions?: InsertArticleOptions,
                ) => Promise<void>
            )
            | undefined;
        onInsertContainer:
            | ((pCatalogItem: CatalogItem) => Promise<void>)
            | undefined;
        onInsertCustomArticle:
            | (
                (pArticle: CustomArticle, pUpdateItem?: BasketItem) => Promise<void>
            )
            | undefined;
        onInsertFile: ((pFile: CatalogFile) => Promise<void>) | undefined;
        dispose(): Promise<void>;
        getArticleNumberSuggestions(
            pParams: ArticleSearchParams,
        ): Promise<string[]>;
        getAvailableCatalogs(): Promise<CatalogDescription[]>;
        searchAndInsertArticle(
            pParams: ArticleSearchParams,
        ): Promise<boolean | MutipleArticleOptions>;
        setActive?(pActive: boolean): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    isActive?: boolean

    Optional activity state of this component. Initial component state should be inactive (false or undefined).

    onInsertArticle:
        | (
            (
                pArticle: ArticleCatalogItem | InsertInfo,
                pOptions?: InsertArticleOptions,
            ) => Promise<void>
        )
        | undefined
    onInsertContainer: ((pCatalogItem: CatalogItem) => Promise<void>) | undefined
    onInsertCustomArticle:
        | ((pArticle: CustomArticle, pUpdateItem?: BasketItem) => Promise<void>)
        | undefined
    onInsertFile: ((pFile: CatalogFile) => Promise<void>) | undefined
    • Called if this instance is no longer in use. Should be used to clean-up resources.

      Returns Promise<void>

    • Returns a list of suggested article numbers when a partial baseArticleNumber is given.

      Parameters

      Returns Promise<string[]>

    • Optional activity state handling for this component. E.g. can be used to disable/enable event handling. Will be set from the component host to activate or deactivate the component. Initial component state should be inactive (false or undefined).

      Parameters

      • pActive: boolean

      Returns Promise<void>