com.atlassian.confluence.mail.notification

Interface NotificationManager

All Known Implementing Classes:

DefaultNotificationManager

public interface NotificationManager

Method Summary

Modifier and Type	Method and Description
Notification	addContentNotification(com.atlassian.user.User user, ContentEntityObject content)
Notification	addDailyReportNotfication(com.atlassian.user.User user)
boolean	addLabelNotification(com.atlassian.user.User user, Label label)
Notification	addPageNotification(com.atlassian.user.User user, AbstractPage page) Deprecated. since 5.3. Use addContentNotification(com.atlassian.user.User, com.atlassian.confluence.core.ContentEntityObject) instead.
Notification	addSpaceNotification(com.atlassian.user.User user, Space space)
Notification	addSpaceNotification(com.atlassian.user.User user, Space space, ContentTypeEnum type) Add a space notification for a particular content type.
List<Notification>	findNotificationsByFollowing(com.atlassian.user.User modifier) Retrieves the list of Network Notifications for Users who are following the given User.
Iterable<Long>	findPageAndSpaceNotificationIdsFromSpace(Space space) Retrieves ids of all notifications in a space.
Notification	getDailyReportNotificationForUser(com.atlassian.user.User user)
List<Notification>	getDailyReportNotifications()
Notification	getNetworkNotificationForUser(com.atlassian.user.User user)
Notification	getNotificationByUserAndContent(com.atlassian.user.User user, ContentEntityObject content)
Notification	getNotificationByUserAndPage(com.atlassian.user.User user, AbstractPage page) Deprecated. since 5.3. Use getNotificationByUserAndContent(com.atlassian.user.User, com.atlassian.confluence.core.ContentEntityObject) instead.
Notification	getNotificationByUserAndSpace(com.atlassian.user.User user, Space space) Return a notification if the user is watching the entire space.
Notification	getNotificationByUserAndSpace(com.atlassian.user.User user, String spaceKey) Return a notification if the user is watching the entire space with the given spaceKey.
Notification	getNotificationByUserAndSpaceAndType(com.atlassian.user.User user, Space space, ContentTypeEnum type)
List<Notification>	getNotificationsByContent(ContentEntityObject content)
List<Notification>	getNotificationsByLabel(Label label)
List<Notification>	getNotificationsByPage(AbstractPage page) Deprecated. since 5.3. Use getNotificationsByContent(com.atlassian.confluence.core.ContentEntityObject) instead.
List<Notification>	getNotificationsBySpace(Space space) Deprecated. Since 3.5 - use getNotificationsBySpaceAndType(Space, ContentTypeEnum)
List<Notification>	getNotificationsBySpaceAndType(Space space, ContentTypeEnum type)
List<Notification>	getNotificationsByUser(com.atlassian.user.User user)
Notification	getSiteBlogNotificationForUser(com.atlassian.user.User user)
List<Notification>	getSiteBlogNotifications()
boolean	isUserWatchingPageOrSpace(com.atlassian.user.User user, Space space, AbstractPage page) Returns true if: a) the user is watching the AbstractPage b) the user is watching the space, or c) the user is watching the contentType of the AbstractPage for the Space
boolean	isWatchingContent(com.atlassian.user.User user, ContentEntityObject content) Returns true if the given user is directly watching the given content.
boolean	isWatchingLabel(com.atlassian.user.User user, Label label)
void	removeAllNotificationsForSpace(Space space) Remove all of the notifications set up for this space.
void	removeAllNotificationsForUser(com.atlassian.user.User user) Remove all of the notifications setup for this user.
void	removeContentNotification(com.atlassian.user.User user, ContentEntityObject content)
void	removeDailyReportNotification(com.atlassian.user.User user)
void	removeLabelNotification(com.atlassian.user.User user, Label label)
void	removeNotification(Notification notification)
void	removeSpaceNotification(com.atlassian.user.User user, Space space)
void	setNetworkNotificationForUser(com.atlassian.user.User user, boolean watchingNetwork)
void	setSiteBlogNotificationForUser(com.atlassian.user.User user, boolean globalBlogWatchForUser)

Method Detail

getNotificationsByUser

List<Notification> getNotificationsByUser(com.atlassian.user.User user)

getNotificationsByContent

List<Notification> getNotificationsByContent(ContentEntityObject content)

getNotificationByUserAndContent

Notification getNotificationByUserAndContent(com.atlassian.user.User user,
                                             ContentEntityObject content)

getNotificationsBySpaceAndType

List<Notification> getNotificationsBySpaceAndType(Space space,
                                                  ContentTypeEnum type)

getNotificationByUserAndSpace

Notification getNotificationByUserAndSpace(com.atlassian.user.User user,
                                           String spaceKey)

Return a notification if the user is watching the entire space with the given spaceKey.

Note that notifications with specified ContentTypeEnum values will not be returned. Use getNotificationByUserAndSpaceAndType(com.atlassian.user.User, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.search.service.ContentTypeEnum) instead.

getNotificationByUserAndSpace

Notification getNotificationByUserAndSpace(com.atlassian.user.User user,
                                           Space space)

Return a notification if the user is watching the entire space.

Note that notifications with specified ContentTypeEnum values will not be returned. Use getNotificationByUserAndSpaceAndType(com.atlassian.user.User, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.search.service.ContentTypeEnum) instead.

getNotificationByUserAndSpaceAndType

Notification getNotificationByUserAndSpaceAndType(com.atlassian.user.User user,
                                                  Space space,
                                                  ContentTypeEnum type)

addContentNotification

@Nullable
Notification addContentNotification(com.atlassian.user.User user,
                                              ContentEntityObject content)

addSpaceNotification

@Nullable
Notification addSpaceNotification(com.atlassian.user.User user,
                                            Space space)

removeSpaceNotification

void removeSpaceNotification(com.atlassian.user.User user,
                             Space space)

Since:

5.9.1

removeContentNotification

void removeContentNotification(com.atlassian.user.User user,
                               ContentEntityObject content)

isWatchingContent

boolean isWatchingContent(@Nullable
                          com.atlassian.user.User user,
                          @Nullable
                          ContentEntityObject content)

Returns true if the given user is directly watching the given content.

Returns false if either the user or the content is null.

Parameters:

user - user to check

content - content to check

Returns:

true if the given user is directly watching the given content

Since:

5.3

addLabelNotification

boolean addLabelNotification(com.atlassian.user.User user,
                             Label label)

removeLabelNotification

void removeLabelNotification(com.atlassian.user.User user,
                             Label label)

isWatchingLabel

boolean isWatchingLabel(com.atlassian.user.User user,
                        Label label)

getNotificationsByLabel

List<Notification> getNotificationsByLabel(Label label)

addSpaceNotification

@Nullable
Notification addSpaceNotification(com.atlassian.user.User user,
                                            Space space,
                                            ContentTypeEnum type)

Add a space notification for a particular content type. For example, watch only blogs in a space.

addDailyReportNotfication

Notification addDailyReportNotfication(com.atlassian.user.User user)

removeDailyReportNotification

void removeDailyReportNotification(com.atlassian.user.User user)

removeNotification

void removeNotification(Notification notification)

isUserWatchingPageOrSpace

boolean isUserWatchingPageOrSpace(com.atlassian.user.User user,
                                  Space space,
                                  AbstractPage page)

Returns true if: a) the user is watching the AbstractPage b) the user is watching the space, or c) the user is watching the contentType of the AbstractPage for the Space

This method can be used to check if a user is watching a page directly or indirectly.

removeAllNotificationsForUser

void removeAllNotificationsForUser(com.atlassian.user.User user)

Remove all of the notifications setup for this user. This includes space, page and daily report notifications.

removeAllNotificationsForSpace

void removeAllNotificationsForSpace(Space space)

Remove all of the notifications set up for this space.

getDailyReportNotifications

List<Notification> getDailyReportNotifications()

getDailyReportNotificationForUser

Notification getDailyReportNotificationForUser(com.atlassian.user.User user)

getSiteBlogNotificationForUser

Notification getSiteBlogNotificationForUser(com.atlassian.user.User user)

getNetworkNotificationForUser

Notification getNetworkNotificationForUser(com.atlassian.user.User user)

setSiteBlogNotificationForUser

void setSiteBlogNotificationForUser(com.atlassian.user.User user,
                                    boolean globalBlogWatchForUser)

setNetworkNotificationForUser

void setNetworkNotificationForUser(com.atlassian.user.User user,
                                   boolean watchingNetwork)

getSiteBlogNotifications

List<Notification> getSiteBlogNotifications()

findNotificationsByFollowing

List<Notification> findNotificationsByFollowing(com.atlassian.user.User modifier)

Retrieves the list of Network Notifications for Users who are following the given User. That is, all Notifications that return true from Notification.isNetwork() and belong to somebody who is following modifier via a Connection.

Parameters:

modifier - usually a user who has modified a piece of content.

Returns:

notifications for anybody subscribed to network notifications who follows modifier.

See Also:

Connection

findPageAndSpaceNotificationIdsFromSpace

Iterable<Long> findPageAndSpaceNotificationIdsFromSpace(Space space)

Retrieves ids of all notifications in a space. This is useful for large-scale operations such as space exports. The result includes all notifications for the space, including notifications for pages in the space.

Parameters:

space - a space to find the notifications for

Returns:

ids of all the notifications in the space.

Since:

4.2

getNotificationsByPage

@Deprecated
List<Notification> getNotificationsByPage(AbstractPage page)

Deprecated. since 5.3. Use getNotificationsByContent(com.atlassian.confluence.core.ContentEntityObject) instead.

getNotificationsBySpace

@Deprecated
List<Notification> getNotificationsBySpace(Space space)

Deprecated. Since 3.5 - use getNotificationsBySpaceAndType(Space, ContentTypeEnum)

Return all notifications for a space, regardless of content type.

getNotificationByUserAndPage

@Deprecated
Notification getNotificationByUserAndPage(com.atlassian.user.User user,
                                                      AbstractPage page)

Deprecated. since 5.3. Use getNotificationByUserAndContent(com.atlassian.user.User, com.atlassian.confluence.core.ContentEntityObject) instead.

addPageNotification

@Deprecated
Notification addPageNotification(com.atlassian.user.User user,
                                             AbstractPage page)

Deprecated. since 5.3. Use addContentNotification(com.atlassian.user.User, com.atlassian.confluence.core.ContentEntityObject) instead.