@Role
public interface NotificationManager
Modifier and Type | Method and Description |
---|---|
List<org.xwiki.notifications.CompositeEvent> |
getEvents(String userId,
int expectedCount)
Return events to display as notifications concerning the specified user.
|
List<org.xwiki.notifications.CompositeEvent> |
getEvents(String userId,
int expectedCount,
Date untilDate,
Date fromDate,
List<String> blackList)
Return events to display as notifications concerning the specified user.
|
List<org.xwiki.notifications.CompositeEvent> |
getEvents(String userId,
int expectedCount,
Date untilDate,
List<String> blackList)
Return events to display as notifications concerning the specified user.
|
default List<org.xwiki.notifications.CompositeEvent> |
getEvents(String userId,
org.xwiki.notifications.NotificationFormat format,
int expectedCount,
Date untilDate,
boolean untilDateIncluded,
Date fromDate,
List<String> blackList)
Return events to display as notifications concerning the specified user.
|
List<org.xwiki.notifications.CompositeEvent> |
getEvents(String userId,
org.xwiki.notifications.NotificationFormat format,
int expectedCount,
Date untilDate,
Date fromDate,
List<String> blackList)
Return events to display as notifications concerning the specified user.
|
long |
getEventsCount(String userId,
int maxCount)
Return the number of events to display as notifications concerning the specified user.
|
List<NotificationPreference> |
getPreferences() |
List<NotificationPreference> |
getPreferences(String userId) |
void |
setStartDate(String userId,
Date startDate)
Set the start date for every notification preference of the given user.
|
List<org.xwiki.notifications.CompositeEvent> getEvents(String userId, int expectedCount) throws org.xwiki.notifications.NotificationException
userId
- id of the userexpectedCount
- the maximum events to returnorg.xwiki.notifications.NotificationException
- if error happensList<org.xwiki.notifications.CompositeEvent> getEvents(String userId, int expectedCount, Date untilDate, List<String> blackList) throws org.xwiki.notifications.NotificationException
userId
- id of the userexpectedCount
- the maximum events to returnuntilDate
- do not return events happened after this dateblackList
- list of ids of blacklisted events to not return (to not get already known events again)org.xwiki.notifications.NotificationException
- if error happensList<org.xwiki.notifications.CompositeEvent> getEvents(String userId, int expectedCount, Date untilDate, Date fromDate, List<String> blackList) throws org.xwiki.notifications.NotificationException
userId
- id of the userexpectedCount
- the maximum events to returnuntilDate
- do not return events happened after this datefromDate
- do not return events happened before this dateblackList
- list of ids of blacklisted events to not return (to not get already known events again)org.xwiki.notifications.NotificationException
- if error happensList<org.xwiki.notifications.CompositeEvent> getEvents(String userId, org.xwiki.notifications.NotificationFormat format, int expectedCount, Date untilDate, Date fromDate, List<String> blackList) throws org.xwiki.notifications.NotificationException
userId
- id of the userformat
- format of the notificationsexpectedCount
- the maximum events to returnuntilDate
- do not return events happened after this datefromDate
- do not return events happened before this dateblackList
- list of ids of blacklisted events to not return (to not get already known events again)org.xwiki.notifications.NotificationException
- if error happensdefault List<org.xwiki.notifications.CompositeEvent> getEvents(String userId, org.xwiki.notifications.NotificationFormat format, int expectedCount, Date untilDate, boolean untilDateIncluded, Date fromDate, List<String> blackList) throws org.xwiki.notifications.NotificationException
userId
- id of the userformat
- format of the notificationsexpectedCount
- the maximum events to returnuntilDate
- do not return events happened after this dateuntilDateIncluded
- true if the passed untilDate
should be includedfromDate
- do not return events happened before this dateblackList
- list of ids of blacklisted events to not return (to not get already known events again)org.xwiki.notifications.NotificationException
- if error happenslong getEventsCount(String userId, int maxCount) throws org.xwiki.notifications.NotificationException
userId
- id of the usermaxCount
- maximum number of events to countorg.xwiki.notifications.NotificationException
- if an error happensvoid setStartDate(String userId, Date startDate) throws org.xwiki.notifications.NotificationException
userId
- the id of the userstartDate
- the date before which we ignore notificationsorg.xwiki.notifications.NotificationException
- if an error happensList<NotificationPreference> getPreferences() throws org.xwiki.notifications.NotificationException
org.xwiki.notifications.NotificationException
- if an error happensList<NotificationPreference> getPreferences(String userId) throws org.xwiki.notifications.NotificationException
userId
- id of the userorg.xwiki.notifications.NotificationException
- if an error happensCopyright © 2004–2022 XWiki. All rights reserved.