Hierarchy

  • PluginDescriptor

Properties

category: PluginCategory
iconName: undefined | string

Optional icon defined by name.

iconUrl: undefined | string

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.

subCategory: undefined | string
vendor: string
version: string

Methods

  • Returns the absolute path to the plugin.

    Returns string

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

    Returns undefined | string

  • 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

Generated using TypeDoc