Package org.xwiki.notifications.rest

Interface NotificationsResource

public interface NotificationsResource

Retrieve notifications.

Since:

10.4RC1

Version:

$Id: 53a19c6bdbf13b03b1c4344905c32a6baed6ee30 $

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getNotifications(String useUserPreferences, String userId, String untilDate, boolean untilDateIncluded, String blackList, String pages, String spaces, String wikis, String users, String count, String displayOwnEvents, String displayMinorEvents, String displaySystemEvents, String displayReadEvents, String displayReadStatus, String tags, String currentWiki, String async, String asyncId)	Get notifications for the given parameters.
javax.ws.rs.core.Response	getNotificationsCount(String useUserPreferences, String userId, String pages, String spaces, String wikis, String users, String count, String displayOwnEvents, String displayMinorEvents, String displaySystemEvents, String displayReadEvents, String displayReadStatus, String tags, String currentWiki, String async, String asyncId)	Get the number of notifications for the given parameters.
String	getNotificationsRSS(String useUserPreferences, String userId, String untilDate, String blackList, String pages, String spaces, String wikis, String users, String count, String displayOwnEvents, String displayMinorEvents, String displaySystemEvents, String displayReadEvents, String displayReadStatus, String tags, String currentWiki)	Get notifications RSS for the given parameters.
javax.ws.rs.core.Response	postNotifications()	Get notifications matching the given parameters.

Method Detail

getNotifications

javax.ws.rs.core.Response getNotifications(String useUserPreferences,
                                           String userId,
                                           String untilDate,
                                           boolean untilDateIncluded,
                                           String blackList,
                                           String pages,
                                           String spaces,
                                           String wikis,
                                           String users,
                                           String count,
                                           String displayOwnEvents,
                                           String displayMinorEvents,
                                           String displaySystemEvents,
                                           String displayReadEvents,
                                           String displayReadStatus,
                                           String tags,
                                           String currentWiki,
                                           String async,
                                           String asyncId)
                                    throws Exception

Get notifications for the given parameters.

Returns:

notifications

Throws:

Exception - if an error occurs

getNotificationsCount

javax.ws.rs.core.Response getNotificationsCount(String useUserPreferences,
                                                String userId,
                                                String pages,
                                                String spaces,
                                                String wikis,
                                                String users,
                                                String count,
                                                String displayOwnEvents,
                                                String displayMinorEvents,
                                                String displaySystemEvents,
                                                String displayReadEvents,
                                                String displayReadStatus,
                                                String tags,
                                                String currentWiki,
                                                String async,
                                                String asyncId)
                                         throws Exception

Get the number of notifications for the given parameters.

Returns:

notifications

Throws:

Exception - if an error occurs

Since:

10.11.4, 11.2

getNotificationsRSS

String getNotificationsRSS(String useUserPreferences,
                           String userId,
                           String untilDate,
                           String blackList,
                           String pages,
                           String spaces,
                           String wikis,
                           String users,
                           String count,
                           String displayOwnEvents,
                           String displayMinorEvents,
                           String displaySystemEvents,
                           String displayReadEvents,
                           String displayReadStatus,
                           String tags,
                           String currentWiki)
                    throws Exception

Get notifications RSS for the given parameters. Since the URL and the return type is different, I had no choice but duplicating the same parameters than getNotifications().

Returns:

the RSS feed as a string

Throws:

Exception - if an error occurs

Since:

10.6RC1

postNotifications

javax.ws.rs.core.Response postNotifications()
                                     throws Exception

Get notifications matching the given parameters. The POST method is used to allow large content in the parameters. For example, the parameter "blackList" could be very long, and the associated URL with the GET method would be too long (generating HTTP 414 error). Note: in the interface, we do not list the parameters, because Restlet does not support @FormParam... See: https://github.com/restlet/restlet-framework-java/issues/1120

Returns:

notifications

Throws:

Exception - if an error occurs

Since:

10.8RC1, 10.8.1, 9.11.8