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

    Interface PluginDescriptor

    interface PluginDescriptor {
        category: PluginCategory;
        iconName: string | undefined;
        iconUrl: string | undefined;
        isDefault: boolean;
        name: string;
        path: string;
        requiredUserContext: string | null;
        sortWeight: number;
        subCategory: string | undefined;
        vendor: string;
        version: string;
        getAbsolutePath(): string;
        getDescription(): string | undefined;
        getTitle(): string;
    }
    Index
    category: PluginCategory
    iconName: string | undefined

    Optional icon defined by name.

    iconUrl: string | undefined

    Optional icon defined by an image url.

    isDefault: boolean

    True if this plugin is a default plugin. If multiple plugins exist for the same plugin category default plugins have lower priority. This is only relevant for plugin categories that support only a single implementation at runtime (e.g. Catalog).

    name: string

    Name of the plugin.

    path: string

    Relative path of the plugin.

    requiredUserContext: string | null

    Required user context type. If defined and the context is not available the plugin will be ignored. (e.g. pCon.login). * can be used to accept every conext.

    User.context

    sortWeight: number

    Defines the order of plugins with the same plugin category. The higher the value, the higher the priority of the plugin for the sorting. The default value is -100. Note: Not all plugin categories support this.

    subCategory: string | undefined
    vendor: string
    version: string
    • Returns the absolute path to the plugin.

      Returns string

    • Returns the description of the plugin using the current application language.

      Returns string | undefined

    • Returns the title of the plugin using the current application language. The name is returned if the plugin does not define a title.

      Returns string