@PublicSpi public interface

UserFormat

com.atlassian.jira.plugin.profile.UserFormat
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

Provides a format to display a user on screen. This may be simply the user's full name surrounded by a link to the user's profile, or something more advanced such as the user's name and profile picture.

See Also

Summary

Constants
String VIEW_TEMPLATE The default velocity template name that is used to render the view.
Public Methods
String format(String userkey, String id)
Renders the formatted user for a given section on the screen.
String format(String userkey, String id, Map<String, Object> params)
Renders the formatted user for a given section on the screen.

Constants

public static final String VIEW_TEMPLATE

The default velocity template name that is used to render the view.

Constant Value: "view"

Public Methods

public String format (String userkey, String id)

Renders the formatted user for a given section on the screen. Please note that the username may be null (eg for empty fields, anonymous user's, etc) or the user may not exist. Implementations should handle these cases.

Extra context can be passed to the renderer via the id attribute. Ideally an implementation might include this id in the rendered output such that it can be used for test assertions.

The result should always be ready to display in an HTML response i.e. it should be HTML encoded if necessary.

Parameters
userkey the user's userkey to format.
id A value providing extra context to the rendering process.
Returns
  • the formatted user

public String format (String userkey, String id, Map<String, Object> params)

Renders the formatted user for a given section on the screen. Please note that the username may be null (eg for empty fields, anonymous user's, etc) or the user may not exist. Implementations should handle these cases.

Extra context can be passed to the renderer via the params attribute.

The result should always be ready to display in an HTML response i.e. it should be HTML encoded if necessary.

Parameters
userkey the user's userkey to format.
id A value providing extra context to the rendering process.
params Additional context to pass to the renderer
Returns
  • the formatted user