@Role
public interface NotificationFilterPreferenceProvider
NotificationFilterPreference
from multiple sources.Modifier and Type | Method and Description |
---|---|
void |
deleteFilterPreference(DocumentReference user,
String filterPreferenceId)
Delete a filter preference.
|
Set<NotificationFilterPreference> |
getFilterPreferences(DocumentReference user)
Get every registered
NotificationFilterPreference for the given user. |
void |
saveFilterPreferences(DocumentReference user,
Set<NotificationFilterPreference> filterPreferences)
Save a given set of filter preferences.
|
void |
setFilterPreferenceEnabled(DocumentReference user,
String filterPreferenceId,
boolean enabled)
Enable or disable a filter preference.
|
void |
setStartDateForUser(DocumentReference user,
Date startDate)
Update the start date for every notification preference that the user has.
|
Set<NotificationFilterPreference> getFilterPreferences(DocumentReference user) throws NotificationException
NotificationFilterPreference
for the given user.user
- the user for which to retrieve the notification preferencesNotificationException
- if an error happenedvoid saveFilterPreferences(DocumentReference user, Set<NotificationFilterPreference> filterPreferences) throws NotificationException
user
- the user for which to save the notification preferencesfilterPreferences
- the NotificationFilterPreference
to saveNotificationException
- if an error occurredvoid deleteFilterPreference(DocumentReference user, String filterPreferenceId) throws NotificationException
user
- the user for which to save the notification preferencesfilterPreferenceId
- id of the filter preferenceNotificationException
- if an error happensvoid setFilterPreferenceEnabled(DocumentReference user, String filterPreferenceId, boolean enabled) throws NotificationException
user
- the user for which to save the notification preferencesfilterPreferenceId
- id of the filter preferenceenabled
- either or not the filter preference should be enabledNotificationException
- if an error happensvoid setStartDateForUser(DocumentReference user, Date startDate) throws NotificationException
user
- the user to usestartDate
- the new start dateNotificationException
- if an error occursCopyright © 2004–2021 XWiki. All rights reserved.