AboutPagePanelModuleDescriptor

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

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.

Summary

[Expand] Inherited Methods
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor String getHtml(String resourceName) String getHtml(String resourceName, Map<String, ?> startingParams) I18nHelper getI18nBean() void writeHtml(String resourceName, Map<String, ?> startingParams, Writer writer)
From interface com.atlassian.plugin.ModuleDescriptor void destroy() void destroy(Plugin arg0) boolean equals(Object arg0) String getCompleteKey() String getDescription() String getDescriptionKey() String getI18nNameKey() String getKey() Float getMinJavaVersion() T getModule() Class<T> getModuleClass() String getName() Map<String, String> getParams() Plugin getPlugin() String getPluginKey() int hashCode() void init(Plugin arg0, Element arg1) boolean isBroken() boolean isEnabled() boolean isEnabledByDefault() boolean isSystemModule() boolean satisfiesMinJavaVersion() void setBroken()
From interface com.atlassian.plugin.Resourced ResourceDescriptor getResourceDescriptor(String arg0, String arg1) List<ResourceDescriptor> getResourceDescriptors() @Deprecated List<ResourceDescriptor> getResourceDescriptors(String arg0) ResourceLocation getResourceLocation(String arg0, String arg1)