API to manipulate a user's WatchList.

Description

Please see the Script Service API's public methods from the source.

The script service is accessible using the watchlist name. Below, is an example in velocity:

$services.watchlist

The Script Service API uses enums as parameters, so if you want to use it in velocity, you will benefit from XWiki's Velocity uberspectors and just pass the enum value as a string. Example:

$services.watchlist.isWatched("DOCUMENT")

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-watchlist-api 12.5.1):

• org.xwiki.platform:xwiki-platform-oldcore 12.5.1
• org.xwiki.platform:xwiki-platform-diffplugin 12.5.1
• org.xwiki.platform:xwiki-platform-scheduler-api 12.5.1
• org.xwiki.platform:xwiki-platform-image-api 12.5.1
• org.xwiki.platform:xwiki-platform-mail-send-default 12.5.1
• org.xwiki.platform:xwiki-platform-activitystream-api 12.5.1