Skip to main content

PluginEntry

This class represents a WebAPI plugin entry, providing a structure to register and manage plugins within the system. It defines the plugin's unique identifier, the task types it supports, and an instance of the plugin loader. It also includes flags to designate a plugin as the default for unknown task types or specific task types when multiple plugins are registered.

Attributes

AttributeTypeDescription
IDpluginsCore.TaskTypeID/Name of the plugin. This will be used to identify this plugin and has to be unique in the entire system. All functions like enabling and disabling a plugin use this ID.
SupportedTaskTypes[]pluginsCore.TaskTypeA list of all the task types for which this plugin is applicable.
PluginLoaderPluginLoaderAn instance of the plugin.
IsDefaultboolBoolean that indicates if this plugin can be used as the default for unknown task types. There can only be one default in the system.
DefaultForTaskTypes[]pluginsCore.TaskTypeA list of all task types for which this plugin should be default handler when multiple registered plugins support the same task type. This must be a subset of RegisteredTaskTypes and at most one default per task type is supported.