public class NotificationData extends Object
NotificationContext
Constructor and Description |
---|
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) |
Modifier and Type | Method and Description |
---|---|
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.
|
NotificationContext |
cloneContextForRecipient(ConfluenceUser recipient)
Returns a copy of the common context for this Notification that can be used to populate a single email for
the specified recipient.
|
boolean |
doNotNotifyAgain(String userName) |
NotificationContext |
getCommonContext() |
com.atlassian.user.User |
getModifier() |
ConfluenceEntityObject |
getPermissionEntity()
User must have VIEW permission on this entity in order to receive the notification.
|
String |
getSubject() |
String |
getTemplateName() |
void |
setSubject(String subject) |
void |
setTemplateName(String templateName) |
String |
toString() |
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)
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 void addTemplateImage(DataSource dataSource)
dataSource
- the datasourceif you intend to add the
image for one notification only.
public NotificationContext cloneContext()
Use cloneContextForRecipient(ConfluenceUser)
if possible.
public NotificationContext cloneContextForRecipient(ConfluenceUser recipient)
public NotificationContext getCommonContext()
Copyright © 2003–2020 Atlassian. All rights reserved.