Summary: Methods | [Expand All]
@PublicSpi public interface

PluggableProjectOperation

com.atlassian.jira.plugin.projectoperation.PluggableProjectOperation
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

A simple interface to create project operation plugins. These will be shown at the bottom of the project operation screen.

IMPORTANT NOTE: This plugin type is only available for internal use. Please refrain from using this, as the backwards compatibility of this plugin type will NOT be maintained in the future.

Summary

Public Methods
String getHtml(Project project, User user)
Get the HTML to present on screen
void init(ProjectOperationModuleDescriptor descriptor)
boolean showOperation(Project project, User user)
Whether or not to show this operation for the given project and user.

Public Methods

public String getHtml (Project project, User user)

Get the HTML to present on screen

Parameters
project Provide the project in case we need any project specific information to render the HTML
user The currently logged in user
Returns
  • HTML representation for this project operation.

public void init (ProjectOperationModuleDescriptor descriptor)

public boolean showOperation (Project project, User user)

Whether or not to show this operation for the given project and user.

Parameters
project Project being viewed
user The currently logged in user
Returns
  • true, if the link should be shown