Watchlist API

Last modified by Admin on 2017/10/05 15:23

cogAPI to manipulate a user's WatchList.
TypeJAR
Developed by

XWiki Development Team

Active Installs0
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Installable with the Extension Manager

Description

This module is still under development.

Until its components stabilize, 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). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

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 9.8.1):

  • org.xwiki.platform:xwiki-platform-oldcore 9.8.1
  • org.xwiki.platform:xwiki-platform-diffplugin 9.8.1
  • org.xwiki.platform:xwiki-platform-scheduler-api 9.8.1
  • org.xwiki.platform:xwiki-platform-mail-send-default 9.8.1
  • org.xwiki.platform:xwiki-platform-activitystream-api 9.8.1
Tags:
Created by Eduard Moraru on 2015/03/16 12:35
    

Get Connected