@Role
@Unstable
public interface NotificationFilter
Modifier and Type | Method and Description |
---|---|
boolean |
filterEvent(Event event,
org.xwiki.model.reference.DocumentReference user,
NotificationFormat format)
Enable or disable an event in the notification list (post-filter).
|
String |
queryFilterAND(org.xwiki.model.reference.DocumentReference user,
NotificationFormat format,
String type)
HQL code to inject in the query to fetch notifications from the event stream, inside an "AND" statement (can
dismiss everything).
|
String |
queryFilterOR(org.xwiki.model.reference.DocumentReference user,
NotificationFormat format,
String type)
HQL code to inject in the query to fetch notifications from the event stream, inside an "OR" statement (cannot
dismiss everything).
|
Map<String,Object> |
queryFilterParams(org.xwiki.model.reference.DocumentReference user,
NotificationFormat format)
Parameters to add to the query using bindValue().
|
boolean filterEvent(Event event, org.xwiki.model.reference.DocumentReference user, NotificationFormat format)
event
- an eventuser
- the user interested in the notificationformat
- format of the notificationString queryFilterOR(org.xwiki.model.reference.DocumentReference user, NotificationFormat format, String type)
user
- the user interested in the notificationsformat
- format of the notificationtype
- event type to filterString queryFilterAND(org.xwiki.model.reference.DocumentReference user, NotificationFormat format, String type)
user
- the user interested in the notificationsformat
- format of the notificationtype
- event type to filterMap<String,Object> queryFilterParams(org.xwiki.model.reference.DocumentReference user, NotificationFormat format)
user
- the user interested in the notificationsformat
- format of the notificationCopyright © 2004–2017 XWiki. All rights reserved.