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

    Interface ProjectDataProvider

    Plugin which is used to provide additional project related data.

    • Plugin category = ProjectData
    interface ProjectDataProvider {
        isAvailable?: boolean;
        name: string;
        getTextBlocks(pLanguage: string): Promise<TextBlock[] | null>;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • Returns a list of text blocks which can be used by the user for the header and footer text. Will be called for every new project and if the quote language has changed.

      Parameters

      • pLanguage: string

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