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

    Interface ProjectCustomerPickerPlugin

    The ProjectCustomerPickerPlugin allows the user to select a customer.

    • Plugin category = ProjectCustomerPicker
    interface ProjectCustomerPickerPlugin {
        isAvailable?: boolean;
        name: string;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
        pickAddress?(
            pAddressType: AddressType,
            pOptions: ProjectCustomerPickerOptions,
        ): Promise<boolean>;
        pickAddressData?(
            pAddressType: AddressType,
            pOptions: ProjectCustomerPickerOptions,
        ): Promise<AddressData | null>;
        pickCustomer(pOptions: ProjectCustomerPickerOptions): Promise<boolean>;
    }

    Hierarchy (View Summary)

    • Plugin
      • ProjectCustomerPickerPlugin
    Index
    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • 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>

    • Opens the customer picker to select an address. The selected address will be used as the adddress with the specified type for the current project. Returns false if the user didn't select an address.

      Parameters

      Returns Promise<boolean>

    • Opens the customer picker to select an address. The selected address will not be assigned to the current project. Returns null if the user didn't select an address.

      Parameters

      Returns Promise<AddressData | null>

    • Opens the customer picker which enables the user to select a customer for the project. Returns false if the user didn't select a customer.

      Parameters

      Returns Promise<boolean>