PluginEventHandler¶
class PluginEventHandler¶
This handler is passed to each plugin instance to allow it to register callbacks for events or run new events.
Properties
| Name | Type | Description |
|---|---|---|
plugin |
FlotiqPluginInfo | Plugin info. |
registry |
FlotiqPluginsRegistry | Plugin registry. |
on |
on | Registers a callback for given event. |
run |
run | Runs an event with given params. |
unregister |
unregister | Unregisters all callbacks for given plugin. |
function FlotiqPluginCallback¶
A callback registered by plugins. Receives arbitrary parameters depending on event type.
Returns
- void
Parameters
| Name | Type | Description |
|---|---|---|
...params |
any[] |
function on¶
Registers a callback for given event.
Returns
- void
Parameters
| Name | Type | Description |
|---|---|---|
event |
string |
|
callback |
FlotiqPluginCallback |
function run¶
Runs an event with given params.
Returns
- void
Parameters
| Name | Type | Description |
|---|---|---|
event |
string |
|
params |
any[] |
function unregister¶
Unregisters all callbacks for given plugin.
Returns
- void