Class orion.pluginregistry.Plugin
Represents a single plugin in the plugin registry.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.core/web/orion/pluginregistry.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Creates a new plugin.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the headers of this plugin.
|
|
|
Returns the URL location of this plugin.
|
|
|
Returns the service references provided by this plugin.
|
|
|
getState()
Returns this plugin's current state.
|
|
|
setParent(parent)
Sets the parent of this plugin.
|
|
|
Uninstalls this plugin.
|
At any given time, a plugin is in exactly one of the following six states:
"uninstalled"- The plugin has been uninstalled and may not be used.
The
uninstalledstate is only visible after a plugin has been uninstalled; the plugin is unusable, but references to itsPluginobject may still be available and used for introspection. "installed"- The plugin is installed, but not yet resolved.
"resolved"- The plugin is resolved and is able to be started.
Note that the plugin is not active yet. A plugin must be in the
resolvedstate before it can be started.The
resolvedstate is reserved for future use. Future versions of the framework may require successful dependency resolution before moving a plugin to theresolvedstate. "starting"- The plugin is in the process of starting.
A plugin is in the
startingstate when its #start method has been called but has not yet resolved. Once the start call resolves, the plugin has successfully started and moves to theactivestate.If the plugin has a lazy activation policy, it may remain in the
startingstate for some time until the activation is triggered. "stopping"- The plugin is in the process of stopping.
A plugin is in the
stoppingstate when its #stop method has been called but not yet resolved. Once the stop call resolves, the plugin moves to theresolvedstate. "active"- The plugin is running. It has been successfully started and activated.
In the
activestate, any services the plugin provides are available for use.
- Returns:
- {Object} The plugin headers.
- Returns:
- {String} The URL of this plugin.
- Returns:
- {orion.serviceregistry.ServiceReference[]} The service references provided by this plugin.
- Returns:
- {String} This plugin's state.
- Parameters:
- {DOMElement} parent Optional, Default: null
- the plugin parent.
nullputs the plugin in the default parent of the plugin registry
- Returns:
- {orion.Promise} A promise that will resolve when the plugin parent has been set.
- Returns:
- {orion.Promise} A promise that will resolve when the plugin has been uninstalled.