register Method

Registers a Plugin with the PluginAdmin. This method is called by the Plugin when it is first loaded. This method verifies that the required versions of the iModel.js system modules are loaded. If those requirements are met, then the onLoad and onExecute methods of the Plugin will be called (See: Plugin). If not, no further action is taken and the Plugin is not active.

register(plugin: Plugin): string[] | undefined

Parameter Type Description
plugin Plugin a newly instantiated subclass of Plugin.

Returns - an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.

Defined in

Last Updated: 08 January, 2020