public interface NotificationFilterPreference
NotificationFilterPreference
is nothing else than a combination of those parameters.Modifier and Type | Method and Description |
---|---|
Set<String> |
getEventTypes() |
String |
getFilterName() |
NotificationFilterType |
getFilterType() |
String |
getId() |
Set<NotificationFormat> |
getNotificationFormats() |
String |
getPage() |
String |
getPageOnly() |
String |
getProviderHint() |
Date |
getStartingDate() |
String |
getUser() |
String |
getWiki() |
default Optional<String> |
getWikiId()
getWiki() , getPage() , getPageOnly() and getUser() are analyzed (in this
order) to find the wiki identifier. |
boolean |
isActive()
A filter preference can either be active or passive.
|
boolean |
isEnabled() |
default boolean |
isFromWiki(String wikiId)
Return
true if the filter preference is related to a given wiki. |
void |
setEnabled(boolean enabled) |
String getId()
String getFilterName()
String getProviderHint()
NotificationFilterPreferenceProvider
associated with this preference.boolean isEnabled()
boolean isActive()
NotificationFilter
.
On the other hand, a passive (non-active) notification filter should not automatically trigger the retrieval of
notifications.NotificationFilterType getFilterType()
Set<NotificationFormat> getNotificationFormats()
NotificationFormat
for which the filter should be applied.Date getStartingDate()
Set<String> getEventTypes()
String getUser()
String getPageOnly()
String getPage()
String getWiki()
void setEnabled(boolean enabled)
enabled
- if the preference is enabled or not@Unstable default boolean isFromWiki(String wikiId)
true
if the filter preference is related to a given wiki. This is the case if getWiki()
returns wikiId
, or if getPage()
, getPageOnly()
or getUser()
are containing the
wiki identifier.wikiId
- a wiki identifiertrue
if the notification filter preference is related to a given wiki, false
otherwise@Unstable default Optional<String> getWikiId()
getWiki()
, getPage()
, getPageOnly()
and getUser()
are analyzed (in this
order) to find the wiki identifier. The first non-null value is used.Optional.empty()
if no
wiki identifier can be foundCopyright © 2004–2022 XWiki. All rights reserved.