Package com.atlassian.gadgets.dashboard

Interface DashboardItemRepresentationService

@PublicApi
public interface DashboardItemRepresentationService

Service used to get representations of dashboard items.

It is useful when implementing custom dashboard views and using dashboard JavaScript API.

Since:

v3.11

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DashboardItemRepresentationService.RenderingContext	Context in which the dashboard item is rendered.

Method Summary

Modifier and Type	Method	Description
io.atlassian.fugue.Option<DashboardItemRepresentation>	getRepresentation(DashboardItemState itemState, DashboardItemRepresentationService.RenderingContext context)	Returns a dashboard item representation.

Method Details

getRepresentation

io.atlassian.fugue.Option<DashboardItemRepresentation> getRepresentation(DashboardItemState itemState,
 DashboardItemRepresentationService.RenderingContext context)

Returns a dashboard item representation. For details of what the representation means look at the DashboardItemRepresentation documentation.

Parameters:

itemState - dashboard item state

context - rendering context

Returns:

representation of the dashboard item or absent if the dashboard item cannot be rendered (conditions do not pass)