@ExperimentalApi public interface

AboutPagePanelModuleDescriptor

implements JiraResourcedModuleDescriptor<T>
com.atlassian.jira.plugin.aboutpagepanel.AboutPagePanelModuleDescriptor
Known Indirect Subclasses

@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

Public Methods
String getPluginSectionHtml()
Gets the rendered HTML for this plugin, to be displayed on the About page.
[Expand]
Inherited Methods
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced

Public Methods

public String getPluginSectionHtml ()

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

Returns
  • the rendered HTML for this plugin