|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.mail.notification.listeners.NotificationData
public class NotificationData
Data that is related to a set of notifications about a change in the system. This is a like a template for all the notifications that are sent for a single event.
NotificationContext
Constructor Summary | |
---|---|
NotificationData(com.atlassian.user.User modifier,
boolean shouldNotifyOnOwnActions,
ConfluenceEntityObject permissionEntity)
|
|
NotificationData(com.atlassian.user.User modifier,
boolean shouldNotifyOnOwnActions,
ConfluenceEntityObject permissionEntity,
String subject,
String templateName,
Collection<DataSource> templateImageDataSources)
|
Method Summary | |
---|---|
void |
addAllToContext(Map<String,Serializable> map)
|
void |
addDoNotNotifyAgain(String userName)
|
void |
addTemplateImage(DataSource dataSource)
Adds a datasource to the current set of datasources for all emails. |
void |
addToContext(String key,
Serializable value)
|
NotificationContext |
cloneContext()
Returns a copy of the common context for this Notification that can be used to populate a single email. |
boolean |
doNotNotifyAgain(String userName)
|
NotificationContext |
getCommonContext()
|
Map<String,Object> |
getContext()
Deprecated. Use getCommonContext().getMap() instead |
com.atlassian.user.User |
getModifier()
|
ConfluenceEntityObject |
getPermissionEntity()
User must have VIEW permission on this entity in order to receive the notification. |
String |
getSubject()
|
ArrayList<DataSource> |
getTemplateImageDataSources()
Deprecated. Single emails may add datasources, therefore this method mustn't be used anymore. Use NotificationContext.getTemplateImageDataSources()
instead. |
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 |
---|
public NotificationData(com.atlassian.user.User modifier, boolean shouldNotifyOnOwnActions, ConfluenceEntityObject permissionEntity)
modifier
- user who triggered the event that led to creating a notification.public NotificationData(com.atlassian.user.User modifier, boolean shouldNotifyOnOwnActions, ConfluenceEntityObject permissionEntity, String subject, String templateName, Collection<DataSource> templateImageDataSources)
Method Detail |
---|
public Map<String,Object> getContext()
getCommonContext().getMap()
instead
public void addToContext(String key, Serializable value)
public void addAllToContext(Map<String,Serializable> map)
public String getTemplateName()
public String getSubject()
public com.atlassian.user.User getModifier()
public void setSubject(String subject)
public void setTemplateName(String templateName)
public boolean doNotNotifyAgain(String userName)
public void addDoNotNotifyAgain(String userName)
public ConfluenceEntityObject getPermissionEntity()
public String toString()
toString
in class Object
public void addTemplateImage(DataSource dataSource)
dataSource
- the datasourceif you intend to add the
image for one notification only.
public NotificationContext cloneContext()
public NotificationContext getCommonContext()
public ArrayList<DataSource> getTemplateImageDataSources()
NotificationContext.getTemplateImageDataSources()
instead.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |