@PublicSpi
public interface UserFormat
UserFormatModuleDescriptor
,
UserFormats
Modifier and Type | Field and Description |
---|---|
static String |
VIEW_TEMPLATE
The default velocity template name that is used to render the view.
|
Modifier and Type | Method and Description |
---|---|
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.
|
static final String VIEW_TEMPLATE
String format(String userkey, String id)
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.
userkey
- the user's userkey to format.id
- A value providing extra context to the rendering process.String format(String userkey, String id, Map<String,Object> params)
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.
userkey
- the user's userkey to format.id
- A value providing extra context to the rendering process.params
- Additional context to pass to the rendererCopyright © 2002-2024 Atlassian. All Rights Reserved.