com.atlassian.confluence.plugins.dailysummary.content
Class SummaryEmailPanelData

java.lang.Object
  com.atlassian.confluence.plugins.dailysummary.content.SummaryEmailPanelData

public class SummaryEmailPanelData
extends Object

This class is used to pass context information back to the summary email. Plugins should populate this class in their providers getContext method, and add it to the list of data held in the context under the key SummaryEmailProperties.CXT_PANEL_DATA

Nested Class Summary

static class

SummaryEmailPanelData.Builder Builder class for the immutable SummaryEmailPanelData

Method Summary

static SummaryEmailPanelData.Builder	builder(String webPanelKey)
List<DataSource>	getImageDatasources() get image datasources to be attached to the email.
String	getWebPanelKey() the web panel key should identify the webpanel component that this is data for.
boolean	hasContent() A flag indicating whether this component has content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasContent

public boolean hasContent()

A flag indicating whether this component has content. It is used by the summary email to determine if the email needs to be sent. If no plugin reports that they have content, no email will be sent.

Returns:

this

getImageDatasources

public List<DataSource> getImageDatasources()

get image datasources to be attached to the email.

Returns:

this

getWebPanelKey

public String getWebPanelKey()

the web panel key should identify the webpanel component that this is data for.

builder

public static SummaryEmailPanelData.Builder builder(String webPanelKey)