Technical reference

The Watch plugin extends Brightspot CMS with content watching capabilities, letting users monitor assets for changes and control who can manage watchers on behalf of other users.

Installation

Maven

<!-- Requires Brightspot 4.8 or later. -->
<dependency>
    <groupId>com.brightspot.watch</groupId>
    <artifactId>watch</artifactId>
    <version>2.2.0</version>
</dependency>

Gradle

// Requires Brightspot 4.8 or later.
implementation 'com.brightspot.watch:watch:2.2.0'

Gradle (Kotlin DSL)

// Requires Brightspot 4.8 or later.
implementation("com.brightspot.watch:watch:2.2.0")

API reference

ManageWatchersPermission

com.psddev.cms.watch.ManageWatchersPermission is an AdditionalPermission that gates the ability to add or remove watchers on behalf of other users. It appears under a role's Additional Permissions in the Tool Role editor.

Member	Description
MANAGE_WATCHERS_ID	The permission ID (manage_watchers) checked by hasPermission(String).
isManageWatchers()	Returns whether the permission is granted.

Manage Watchers permission and upgrading

Where the Manage Watchers permission lives, and whether it requires this plugin, depends on the Brightspot core version:

Brightspot version	Manage Watchers location	Requires this plugin
4.5.x	Not available.	N/A
4.7.0–4.7.32	Built into Brightspot core, under a role's UI permissions.	No
4.7.33 and later	Provided by this plugin, under a role's Additional Permissions.	Yes, v1.0.1 or later
4.8.0–4.8.11	Built into Brightspot core, under a role's UI permissions.	No
4.8.12 and later	Provided by this plugin, under a role's Additional Permissions.	Yes, v2.0.0 or later
5.0.x	Provided by this plugin, under a role's Additional Permissions.	Yes, v2.0.0 or later

note

The Manage Watchers permission was not available before Brightspot 4.7.3, and Brightspot core never included it in the 4.5.x line.

warning

If you're upgrading from a version where Manage Watchers was built into core (4.7.0–4.7.32 or 4.8.0–4.8.11) to a version where it isn't, add this plugin as a dependency at the version listed above, then re-grant the permission to any affected roles under Additional Permissions. The permission does not carry over automatically.