com.atlassian.confluence.mail.notification.listeners
Class NotificationData

java.lang.Object
  com.atlassian.confluence.mail.notification.listeners.NotificationData

All Implemented Interfaces:

Serializable

public class NotificationData
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

NotificationData(com.atlassian.user.User modifier, boolean shouldNotifyOnOwnActions, ConfluenceEntityObject permissionEntity)

Method Summary

void	addAllToContext(Map<String,Serializable> map)
void	addDoNotNotifyAgain(String userName)
void	addRightFooterLink(String url, String labelKey) Add a link that appears in the bottom-right of the notification.
void	addTemplateImage(DataSource dataSource)
void	addToContext(String key, Serializable value)
boolean	doNotNotifyAgain(String userName)
Map<String,Serializable>	getContext()
com.atlassian.user.User	getModifier()
ConfluenceEntityObject	getPermissionEntity() User must have VIEW permission on this entity in order to receive the notification.
List<List<String>>	getRightFooterLinks() Returns the list of subscription links for the bottom-right of each notification.
String	getSubject()
ArrayList<DataSource>	getTemplateImageDataSources()
String	getTemplateName()
void	setSubject(String subject)
void	setTemplateName(String templateName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationData

public NotificationData(com.atlassian.user.User modifier,
                        boolean shouldNotifyOnOwnActions,
                        ConfluenceEntityObject permissionEntity)

Parameters:

modifier - user who triggered the event that led to creating a notification.

Method Detail

getContext

public Map<String,Serializable> getContext()

addToContext

public void addToContext(String key,
                         Serializable value)

addAllToContext

public void addAllToContext(Map<String,Serializable> map)

getTemplateName

public String getTemplateName()

getSubject

public String getSubject()

getModifier

public com.atlassian.user.User getModifier()

setSubject

public void setSubject(String subject)

setTemplateName

public void setTemplateName(String templateName)

doNotNotifyAgain

public boolean doNotNotifyAgain(String userName)

addDoNotNotifyAgain

public void addDoNotNotifyAgain(String userName)

getPermissionEntity

public ConfluenceEntityObject getPermissionEntity()

User must have VIEW permission on this entity in order to receive the notification.

toString

public String toString()

Overrides:

toString in class Object

addTemplateImage

public void addTemplateImage(DataSource dataSource)

getTemplateImageDataSources

public ArrayList<DataSource> getTemplateImageDataSources()

addRightFooterLink

public void addRightFooterLink(String url,
                               String labelKey)

Add a link that appears in the bottom-right of the notification.

Parameters:

url - the URL for the link, relative to the instance (context path will be prepended)

labelKey - the i18n key for the label

getRightFooterLinks

public List<List<String>> getRightFooterLinks()

Returns the list of subscription links for the bottom-right of each notification. Each item is a two-item list consisting of the relative URL and label i18n key.

All the returned lists are immutable.

See Also:

addRightFooterLink(String, String)