Skip navigation links
A C F G I L N O Q R S V 

A

add(Event, int) - Method in class org.xwiki.notifications.CompositeEvent
Add an event to the composite event.
add(EventStatus) - Method in class org.xwiki.notifications.CompositeEventStatus
Add an event status to the object.
areEmailsEnabled() - Method in interface org.xwiki.notifications.NotificationConfiguration
 
areEmailsEnabled() - Method in class org.xwiki.notifications.script.NotificationScriptService
Get the status of the module.

C

CompositeEvent - Class in org.xwiki.notifications
A group of similar events that compose a "composite" event.
CompositeEvent(Event) - Constructor for class org.xwiki.notifications.CompositeEvent
Construct a CompositeEvent.
CompositeEvent(CompositeEvent) - Constructor for class org.xwiki.notifications.CompositeEvent
Copy constructor of CompositeEvent.
CompositeEventStatus - Class in org.xwiki.notifications
Combine all event statuses of a composite event.
CompositeEventStatus(CompositeEvent) - Constructor for class org.xwiki.notifications.CompositeEventStatus
Construct a composite event status.
CompositeEventStatusManager - Interface in org.xwiki.notifications
Compute composite event statuses.

F

filterEvent(Event, DocumentReference, NotificationFormat) - Method in interface org.xwiki.notifications.NotificationFilter
Enable or disable an event in the notification list (post-filter).

G

generateEmailSubject(CompositeEvent) - Method in interface org.xwiki.notifications.email.NotificationEmailRenderer
 
getApplicationId() - Method in class org.xwiki.notifications.NotificationPreference
 
getCompositeEvent() - Method in class org.xwiki.notifications.CompositeEventStatus
 
getCompositeEventStatuses(List<CompositeEvent>, String) - Method in interface org.xwiki.notifications.CompositeEventStatusManager
Get the list of statuses concerning the given composite events and the current user.
getCompositeEventStatuses(List<CompositeEvent>) - Method in class org.xwiki.notifications.script.NotificationScriptService
Get the list of statuses concerning the given composite events and the current user.
getDates() - Method in class org.xwiki.notifications.CompositeEvent
 
getDocument() - Method in class org.xwiki.notifications.CompositeEvent
 
getEventIds() - Method in class org.xwiki.notifications.CompositeEvent
 
getEvents() - Method in class org.xwiki.notifications.CompositeEvent
 
getEvents(String, boolean, int) - Method in interface org.xwiki.notifications.NotificationManager
Return events to display as notifications concerning the specified user.
getEvents(String, boolean, int, Date, List<String>) - Method in interface org.xwiki.notifications.NotificationManager
Return events to display as notifications concerning the specified user.
getEvents(String, boolean, int, Date, Date, List<String>) - Method in interface org.xwiki.notifications.NotificationManager
Return events to display as notifications concerning the specified user.
getEvents(String, NotificationFormat, boolean, int, Date, Date, List<String>) - Method in interface org.xwiki.notifications.NotificationManager
Return events to display as notifications concerning the specified user.
getEvents(boolean, int) - Method in class org.xwiki.notifications.script.NotificationScriptService
 
getEvents(boolean, int, Date, String[]) - Method in class org.xwiki.notifications.script.NotificationScriptService
 
getEvents(boolean, int, Date, List<String>) - Method in class org.xwiki.notifications.script.NotificationScriptService
 
getEventsCount(String, boolean, int) - Method in interface org.xwiki.notifications.NotificationManager
Return the number of events to display as notifications concerning the specified user.
getEventsCount(boolean, int) - Method in class org.xwiki.notifications.script.NotificationScriptService
Return the number of events to display as notifications concerning the current user.
getEventStatuses(List<Event>) - Method in class org.xwiki.notifications.script.NotificationScriptService
Get the list of statuses concerning the given events and the current user.
getEventType() - Method in class org.xwiki.notifications.NotificationPreference
 
getFeed(int, boolean) - Method in class org.xwiki.notifications.script.NotificationScriptService
Get the RSS notifications feed of the given user.
getFeed(String, int, boolean) - Method in class org.xwiki.notifications.script.NotificationScriptService
Get the RSS notifications feed of the given user.
getFormat() - Method in class org.xwiki.notifications.NotificationPreference
 
getGroupId() - Method in class org.xwiki.notifications.CompositeEvent
 
getPreferences() - Method in interface org.xwiki.notifications.NotificationManager
 
getPreferences(String) - Method in interface org.xwiki.notifications.NotificationManager
 
getSimilarityBetweenEvents() - Method in class org.xwiki.notifications.CompositeEvent
 
getStatus() - Method in class org.xwiki.notifications.CompositeEventStatus
 
getSupportedEvents() - Method in interface org.xwiki.notifications.NotificationDisplayer
 
getType() - Method in class org.xwiki.notifications.CompositeEvent
 
getUsers() - Method in class org.xwiki.notifications.CompositeEvent
 

I

isEnabled() - Method in interface org.xwiki.notifications.NotificationConfiguration
 
isEnabled() - Method in class org.xwiki.notifications.script.NotificationScriptService
Get the status of the module.
isNotificationEnabled() - Method in class org.xwiki.notifications.NotificationPreference
 

L

liveNotificationsGraceTime() - Method in interface org.xwiki.notifications.NotificationConfiguration
Get the number of minutes for the notification emails grace time.

N

NotificationConfiguration - Interface in org.xwiki.notifications
Get the configuration options concerning the Notification module.
NotificationDisplayer - Interface in org.xwiki.notifications
Display a notification.
NotificationEmailInterval - Enum in org.xwiki.notifications.email
Several intervals to get notified by emails.
NotificationEmailRenderer - Interface in org.xwiki.notifications.email
Render a notification for email sendings.
NotificationException - Exception in org.xwiki.notifications
Exception specific to the notifications module.
NotificationException(String) - Constructor for exception org.xwiki.notifications.NotificationException
Construct a NotificationException.
NotificationException(String, Throwable) - Constructor for exception org.xwiki.notifications.NotificationException
Construct a NotificationException.
NotificationFilter - Interface in org.xwiki.notifications
Enable or disable notifications from the event stream (for customization purpose).
NotificationFormat - Enum in org.xwiki.notifications
The different formats for notifications.
NotificationManager - Interface in org.xwiki.notifications
Get notifications for users.
NotificationPreference - Class in org.xwiki.notifications
Represent a preference set by a user concerning a given type of event.
NotificationPreference(String, String, boolean) - Constructor for class org.xwiki.notifications.NotificationPreference
Construct a NotificationPreference.
NotificationPreference(String, String, boolean, NotificationFormat) - Constructor for class org.xwiki.notifications.NotificationPreference
Construct a NotificationPreference.
NotificationRenderer - Interface in org.xwiki.notifications
Render an event as a notification.
NotificationRSSManager - Interface in org.xwiki.notifications.rss
Allows a complete RSS feed to be properly rendered.
NotificationRSSRenderer - Interface in org.xwiki.notifications.rss
Display a notification in a RSS format.
NotificationScriptService - Class in org.xwiki.notifications.script
Script services for the notifications.
NotificationScriptService() - Constructor for class org.xwiki.notifications.script.NotificationScriptService
 

O

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

Q

queryFilterAND(DocumentReference, NotificationFormat, String) - Method in interface org.xwiki.notifications.NotificationFilter
HQL code to inject in the query to fetch notifications from the event stream, inside an "AND" statement (can dismiss everything).
queryFilterOR(DocumentReference, NotificationFormat, String) - Method in interface org.xwiki.notifications.NotificationFilter
HQL code to inject in the query to fetch notifications from the event stream, inside an "OR" statement (cannot dismiss everything).
queryFilterParams(DocumentReference, NotificationFormat) - Method in interface org.xwiki.notifications.NotificationFilter
Parameters to add to the query using bindValue().

R

remove(Event) - Method in class org.xwiki.notifications.CompositeEvent
Remove an event from the current object.
render(CompositeEvent) - Method in interface org.xwiki.notifications.NotificationRenderer
Generate a rendering Block for a given event to display as notification.
render(CompositeEvent) - Method in class org.xwiki.notifications.script.NotificationScriptService
Generate a rendering Block for a given event to display as notification.
renderFeed(List<CompositeEvent>) - Method in interface org.xwiki.notifications.rss.NotificationRSSManager
Render a complete RSS feed.
renderHTML(CompositeEvent) - Method in interface org.xwiki.notifications.email.NotificationEmailRenderer
 
renderNotification(CompositeEvent) - Method in interface org.xwiki.notifications.NotificationDisplayer
Render a notification.
renderNotification(CompositeEvent) - Method in interface org.xwiki.notifications.rss.NotificationRSSRenderer
Render a specific composite event.
renderPlainText(CompositeEvent) - Method in interface org.xwiki.notifications.email.NotificationEmailRenderer
 

S

saveEventStatus(String, boolean) - Method in class org.xwiki.notifications.script.NotificationScriptService
Save a status for the current user.
setStartDate(String, Date) - Method in interface org.xwiki.notifications.NotificationManager
Set the start date for the given user.
setStartDate(Date) - Method in class org.xwiki.notifications.script.NotificationScriptService
Set the start date for the current user.
setStartDate(String, Date) - Method in class org.xwiki.notifications.script.NotificationScriptService
Set the start date for the given user.

V

valueOf(String) - Static method in enum org.xwiki.notifications.email.NotificationEmailInterval
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.notifications.NotificationFormat
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.notifications.email.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.NotificationFormat
Returns an array containing the constants of this enum type, in the order they are declared.
A C F G I L N O Q R S V 
Skip navigation links

Copyright © 2004–2017 XWiki. All rights reserved.