Plugin Class
Beta
Base Plugin class for writing a demand-loaded module.
see PluginAdmin for a description of how Plugins are loaded.
see Plugins
Methods
Name | Description | |
---|---|---|
constructor(name: string): Plugin | Constructor for base Plugin class | |
onExecute(_args: string[]): void Abstract | Method called immediately following the call to onLoad when the Plugin is first loaded, and also once for | |
onLoad(_args: string[]): void | Method called when the Plugin is first loaded. | |
reportReload(): boolean | When a Plugin has been loaded, and there is a subsequent call to load the same Plugin, returning false from this method prevents the system from reporting the reload. | |
resolveResourceUrl(relativeUrl: string): string | Returns a fully qualified resource URL (needed when the plugin is loaded from an external server | |
setI18n(defaultNamespace?: string, options?: I18NOptions): void | Can be used to set up a localization instance. |
Properties
Name | Type | Description | |
---|---|---|---|
i18n Accessor ReadOnly | I18N | Property that retrieves the localization instance specific to the Plugin. | |
name ConstructorProperty | string | the name of the plugin. |
Defined in
Last Updated: 05 June, 2020