com.atlassian.jira.plugin.aboutpagepanel

Interface AboutPagePanelModuleDescriptor

All Superinterfaces:

JiraResourcedModuleDescriptor<Void>, com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware

All Known Implementing Classes:

AboutPagePanelModuleDescriptorImpl

@ExperimentalApi
public interface AboutPagePanelModuleDescriptor
extends JiraResourcedModuleDescriptor<Void>

Defines a plugin point for displaying information on the application About page. At least one of introduction, licenses-location, and conclusion must be defined; multiple entries will be displayed in that order.

Example

The two web resources define the locations of the templates for the introduction and conclusion sections. In most cases these are necessary and should give a path to a soy file in your plugin.

The module-keys in the introduction and conclusion elements define the modules from which to load the templates. These are typically the plugin key, followed by a colon (:), then followed by the key of module defining the templates to use.

The function defines the function that is to be called from the template file located at the module-key.

The licenses location element is a path to the bom.csv file inside the plugin.

Since:

6.0.2

Method Summary

Modifier and Type	Method and Description
String	getPluginSectionHtml() Gets the rendered HTML for this plugin, to be displayed on the About page.

Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

getHtml, getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Method Detail

getPluginSectionHtml

String getPluginSectionHtml()

Gets the rendered HTML for this plugin, to be displayed on the About page.

Returns:

the rendered HTML for this plugin