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

    Extension for customer picker which is used as a data provider.

    • Plugin category = ProjectCustomerPickerExtension
    • Plugin sub category = CustomerProvider
    interface CustomerProviderExtension {
        eventFiltersChanged: ListenableEvent<void, CustomerProviderExtension>;
        isAvailable?: boolean;
        name: string;
        getCustomers(
            pFilterValues: ReadonlyMap<string, string>,
        ): Promise<CustomerInfo[]>;
        getFilters(pContext: EaiwsContext): Promise<FilterDefinition[] | null>;
        getMenuActions?(): MenuAction[];
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    • Plugin
      • CustomerProviderExtension
    Index
    eventFiltersChanged: ListenableEvent<void, CustomerProviderExtension>

    Event which should be triggered if the filters have changed e.g. name or options have changed

    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • Queries a list of customers using the provided filters.

      Parameters

      • pFilterValues: ReadonlyMap<string, string>

        Key -> value map for the query filters.

      Returns Promise<CustomerInfo[]>

    • Returns a list of available filters for this provider.

      Parameters

      • pContext: EaiwsContext

      Returns Promise<FilterDefinition[] | 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>