Interface Plugins
- All Known Implementing Classes:
PluginsImpl
public interface Plugins
This is a utility class that uses UPM's restful interface
to find out info about installed plugins and enable/disable them
All of these functions will try to return you to the page you were on before calling them.
- Since:
- v4.3
-
Method Summary
Modifier and TypeMethodDescriptionboolean
canDisablePlugin
(String pluginKey) Is it possible to disable a plugin.boolean
canDisablePluginModule
(String pluginKey, String completeModuleKey) Is it possible to disable a module of a plugin.void
disablePlugin
(String pluginKey) Tries to disable a plugin (so long as it is installed).void
disablePluginModule
(String pluginKey, String completeModuleKey) Tries to disable a module within a plugin.void
enablePlugin
(String pluginKey) Tries to enable a plugin (so long as it is installed).void
enablePluginModule
(String pluginKey, String completeModuleKey) Tries to enable a module within a plugin.boolean
isPluginDisabled
(String pluginKey) Is a plugin disabled.boolean
isPluginEnabled
(String pluginKey) Is a plugin enabled.boolean
isPluginInstalled
(String pluginKey) Checks if the plugin is found in the UPM.boolean
isPluginModuleDisabled
(String pluginKey, String completeModuleKey) Is a module of a plugin disabled.boolean
isPluginModuleEnabled
(String pluginKey, String completeModuleKey) Is a module of a plugin enabled.Gets an instance of the reference dependent plugin.Gets an instance of the reference language pack plugin.Gets an instance of the reference plugin.
-
Method Details
-
isPluginInstalled
Checks if the plugin is found in the UPM.- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugin- Returns:
- if the plugin is installed on the instance.
-
canDisablePluginModule
Is it possible to disable a module of a plugin.- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugincompleteModuleKey
- - the key for the module eg. com.atlassian.examplePlugin:exampleModule- Returns:
- if the module is able to be disabled (ie. optional)
-
canDisablePlugin
Is it possible to disable a plugin.- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugin- Returns:
- if the plugin is able to be disabled (ie. optional)
-
enablePlugin
Tries to enable a plugin (so long as it is installed).- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugin
-
disablePlugin
Tries to disable a plugin (so long as it is installed).- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugin
-
enablePluginModule
Tries to enable a module within a plugin.- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugincompleteModuleKey
- - the key for the module eg. com.atlassian.examplePlugin:exampleModule
-
disablePluginModule
Tries to disable a module within a plugin.- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugincompleteModuleKey
- - the key for the module eg. com.atlassian.examplePlugin:exampleModule
-
isPluginEnabled
Is a plugin enabled.- Parameters:
pluginKey
- - the key of the plugin to check eg. com.atlassian.examplePlugin- Returns:
- true if the plugin is enabled; otherwise, false.
-
isPluginDisabled
Is a plugin disabled.- Parameters:
pluginKey
- - the key of the plugin to check eg. com.atlassian.examplePlugin- Returns:
- true if the plugin is disabled; otherwise, false.
-
isPluginModuleEnabled
Is a module of a plugin enabled.- Parameters:
pluginKey
- - the key for the plugin eg. com.atlassian.examplePlugincompleteModuleKey
- - the key for the module eg. com.atlassian.examplePlugin:exampleModule- Returns:
- true if the module is enabled; otherwise, false.
-
isPluginModuleDisabled
Is a module of a plugin disabled.- Parameters:
pluginKey
- - the key of the plugin eg. com.atlassian.examplePlugincompleteModuleKey
- - the key of the module to check eg. com.atlassian.examplePlugin:exampleModule- Returns:
- true if the module is disabled; otherwise, false.
-
referencePlugin
ReferencePlugin referencePlugin()Gets an instance of the reference plugin.- Returns:
- an instance of the reference plugin.
-
referenceDependentPlugin
ReferenceDependentPlugin referenceDependentPlugin()Gets an instance of the reference dependent plugin.- Returns:
- an instance of the reference dependent plugin.
-
referenceLanguagePack
ReferenceLanguagePack referenceLanguagePack()Gets an instance of the reference language pack plugin.- Returns:
- an instance of the reference language pack plugin.
-