Class Index | File Index

Classes


Class orion.pluginregistry.PluginRegistry

The Orion plugin registry
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.core/web/orion/pluginregistry.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.pluginregistry.PluginRegistry(serviceRegistry, opt_storage, opt_visible)
Creates a new plugin registry.
Method Summary
Method Attributes Method Name and Description
 
Returns the installed plugin with the given URL.
 
Returns all installed plugins.
 
installPlugin(url, optManifest)
Installs the plugin at the given location into the plugin registry.
 
Starts the plugin registry.
 
stop()
Shuts down the plugin registry.
Event Summary
Event Attributes Event Name and Description
 
Dispatched when a plugin has been installed.
 
Dispatched when a plugin is starting due to a lazy activation.
 
Dispatched when a plugin has been resolved.
 
Dispatched when a plugin is started.
 
Dispatched when a plugin is starting.
 
Dispatched when a plugin is stopped.
 
Dispatched when a plugin is stopping.
 
Dispatched when a plugin has been uninstalled.
 
Dispatched when a plugin has been updated.
Class Detail
orion.pluginregistry.PluginRegistry(serviceRegistry, opt_storage, opt_visible)
Creates a new plugin registry. The plugin registry maintains a list of orion.pluginregistry.Plugins, which can provide services to the given serviceRegistry.

The plugin registry dispatches plugin events when one of its plugins changes state. Each such event contains a plugin field giving the affected orion.pluginregistry.Plugin.

Parameters:
{orion.serviceregistry.ServiceRegistry} serviceRegistry
The service registry to register plugin-provided services with.
{Object} opt_storage Optional, Default: localStorage
Target object to read and write plugin metadata from.
{Boolean} opt_visible Optional, Default: false
Whether a loaded plugin's iframe will be displayed. By default it is not displayed.
Method Detail
{orion.pluginregistry.Plugin} getPlugin()
Returns the installed plugin with the given URL.
Returns:
{orion.pluginregistry.Plugin} The installed plugin matching the given URL, or null if no such plugin is installed.

{orion.pluginregistry.Plugin[]} getPlugins()
Returns all installed plugins.
Returns:
{orion.pluginregistry.Plugin[]} An array of all installed plugins.

{orion.Promise} installPlugin(url, optManifest)
Installs the plugin at the given location into the plugin registry.
Parameters:
{String} url
The location of the plugin.
{Object} optManifest Optional
The plugin metadata.
Returns:
{orion.Promise} A promise that will resolve when the plugin has been installed.

{orion.Promise} start()
Starts the plugin registry.
Returns:
{orion.Promise} A promise that will resolve when the registry has been fully started.

{orion.Promise} stop()
Shuts down the plugin registry.
Returns:
{orion.Promise} A promise that will resolve when the registry has been stopped.
Event Detail
installed()
Dispatched when a plugin has been installed. The type of this event is "installed".

lazy_activation()
Dispatched when a plugin is starting due to a lazy activation. The type of this event is "lazy activation".

resolved()
Dispatched when a plugin has been resolved. The type of this event is "resolved".

started()
Dispatched when a plugin is started. The type of this event is "started".

starting()
Dispatched when a plugin is starting. The type of this event is "starting".

stopped()
Dispatched when a plugin is stopped. The type of this event is "stopped".

stopping()
Dispatched when a plugin is stopping. The type of this event is "stopping".

uninstalled()
Dispatched when a plugin has been uninstalled. The type of this event is "uninstalled".

updated()
Dispatched when a plugin has been updated. The type of this event is "updated".

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 18 2017 12:15:12 GMT-0500 (EST)