Skip navigation links
B G H I N O P S T V 

B

build() - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 

G

getAllPreferences(DocumentReference) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceManager
Get a list of registered NotificationPreference for the given user.
getAllPreferences(WikiReference) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceManager
Get a list of registered and/or inherited NotificationPreference for the given wiki.
getCategory() - Method in interface org.xwiki.notifications.preferences.NotificationPreference
 
getDiffType() - Method in interface org.xwiki.notifications.preferences.email.NotificationEmailUserPreferenceManager
 
getDiffType(String) - Method in interface org.xwiki.notifications.preferences.email.NotificationEmailUserPreferenceManager
 
getDiffType() - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 
getDiffType(String) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 
getFormat() - Method in interface org.xwiki.notifications.preferences.NotificationPreference
 
getPreferences(DocumentReference, boolean, NotificationFormat) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceManager
Get a list of registered NotificationPreference for the given user.
getPreferencesForUser(DocumentReference) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceProvider
Get every registered NotificationPreference for the given user.
getPreferencesForWiki(WikiReference) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceProvider
Get every registered and/or inherited NotificationPreference for the given wiki.
getProperties() - Method in interface org.xwiki.notifications.preferences.NotificationPreference
 
getProviderHint() - Method in interface org.xwiki.notifications.preferences.NotificationPreference
The provider linked to a NotificationPreference is helpful as it permits the NotificationPreferenceManager to know where to save a given preference.
getProviderPriority() - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceProvider
Get the priority that the preferences given by this provider should have.
getStartDate() - Method in interface org.xwiki.notifications.preferences.NotificationPreference
 
getTarget() - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreference
 

H

hasAnyEnabledNotificationPreferences() - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 

I

isEventTypeEnabled(String, NotificationFormat, String) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 
isEventTypeEnabled(String, NotificationFormat) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 
isEventTypeEnabledForUser(String, NotificationFormat, UserReference) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 
isNotificationEnabled() - Method in interface org.xwiki.notifications.preferences.NotificationPreference
 

N

NotificationEmailDiffType - Enum in org.xwiki.notifications.preferences.email
Represent possible values for the "include diff" option of the user.
NotificationEmailInterval - Enum in org.xwiki.notifications.preferences
Several intervals to get notified by emails.
NotificationEmailUserPreferenceManager - Interface in org.xwiki.notifications.preferences.email
Configuration for the emails for each user.
NotificationPreference - Interface in org.xwiki.notifications.preferences
Represent a preference set by a user concerning a notification.
NotificationPreferenceCategory - Enum in org.xwiki.notifications.preferences
Define the category of the notification preference.
NotificationPreferenceManager - Interface in org.xwiki.notifications.preferences
Provide an interface for interacting with user notification preferences.
NotificationPreferenceProperty - Enum in org.xwiki.notifications.preferences
Possible properties that can be bound to a notification in order to characterize it.
NotificationPreferenceProvider - Interface in org.xwiki.notifications.preferences
Provides notifications preferences from multiple sources.
NotificationPreferenceScriptService - Class in org.xwiki.notifications.preferences.script
Script service for the notification preferences.
NotificationPreferenceScriptService() - Constructor for class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
 

O

org.xwiki.notifications.preferences - package org.xwiki.notifications.preferences
 
org.xwiki.notifications.preferences.email - package org.xwiki.notifications.preferences.email
 
org.xwiki.notifications.preferences.script - package org.xwiki.notifications.preferences.script
 

P

prepare() - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
Prepare the builder for a new instance.

S

saveNotificationPreferences(String, DocumentReference) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
Save preferences given as JSON.
saveNotificationPreferences(String) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
Update notification preferences of the given user.
saveNotificationPreferencesForCurrentWiki(String) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
Update notification preferences of the current wiki.
savePreferences(List<NotificationPreference>) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceManager
Save the given NotificationPreference.
savePreferences(List<NotificationPreference>) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceProvider
Save a given list of preferences.
setCategory(NotificationPreferenceCategory) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 
setEnabled(boolean) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
Define if the notification preference is enabled or not.
setFormat(NotificationFormat) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 
setProperties(Map<NotificationPreferenceProperty, Object>) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 
setProviderHint(String) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 
setStartDate(Date) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
Set the start date for the current user.
setStartDate(String, Date) - Method in class org.xwiki.notifications.preferences.script.NotificationPreferenceScriptService
Set the start date for every notification preference of the given user.
setStartDate(Date) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 
setStartDateForUser(DocumentReference, Date) - Method in interface org.xwiki.notifications.preferences.NotificationPreferenceManager
Update the start date for every notification preference that the user has.
setTarget(EntityReference) - Method in interface org.xwiki.notifications.preferences.TargetableNotificationPreferenceBuilder
 

T

TargetableNotificationPreference - Interface in org.xwiki.notifications.preferences
A notification preference can (most of the time) be targeted to a certain user, group or wiki.
TargetableNotificationPreferenceBuilder - Interface in org.xwiki.notifications.preferences

V

valueOf(String) - Static method in enum org.xwiki.notifications.preferences.email.NotificationEmailDiffType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.notifications.preferences.NotificationEmailInterval
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.notifications.preferences.NotificationPreferenceCategory
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.notifications.preferences.NotificationPreferenceProperty
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.notifications.preferences.email.NotificationEmailDiffType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.notifications.preferences.NotificationEmailInterval
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.notifications.preferences.NotificationPreferenceCategory
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.notifications.preferences.NotificationPreferenceProperty
Returns an array containing the constants of this enum type, in the order they are declared.
B G H I N O P S T V 
Skip navigation links

Copyright © 2004–2021 XWiki. All rights reserved.