com.atlassian.jira.issue.watchers.WatcherManager |
Known Indirect Subclasses |
Clients of @PublicApi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicApi
as per each product's API policy as long as the client does not implement/extend
@PublicApi
interfaces or classes (refer to each product's API policy for the exact
guarantee---usually binary compatibility is guaranteed at least across minor versions).
@PublicApi
interfaces and classes are not designed to be implemented or extended by clients,
we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not
affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces
annotated with @PublicSpi
are safe to extend/implement).
Allows watching of issues. I.e.: Users watching an issue will receive notifications for every update of the issue.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Retrieve the list of usernames of users watching the given issue
| |||||||||||
Returns the number of users watching this issue.
| |||||||||||
Retrieve list of users that are currently watching this issue (including the current user).
| |||||||||||
Retrieve list of users that are currently watching this issue (including the current user).
| |||||||||||
Determine whether the current user is already watching the issue or not
| |||||||||||
Remove all watches for a given user
| |||||||||||
Enable watching of a list of issues for the user supplied.
| |||||||||||
Enable watching of a particular issue for the user supplied.
| |||||||||||
Disable watching of a particular issue for the user supplied.
| |||||||||||
Disable watching of a list of issues for the user supplied.
|
Retrieve the list of usernames of users watching the given issue
issue | issue being watched |
---|
DataAccessException | if cannot retrieve watchers |
---|
Returns the number of users watching this issue.
issue | issue being watched |
---|
Retrieve list of users that are currently watching this issue (including the current user).
issue | issue being watched |
---|
Retrieve list of users that are currently watching this issue (including the current user).
issue | issue being watched |
---|---|
userLocale | the locale of the user making this call, this is used for sorting the list values. |
Determine whether the current user is already watching the issue or not
user | user |
---|---|
issue | issue being watched |
Remove all watches for a given user
user | The user that has most probably been deleted |
---|
Enable watching of a list of issues for the user supplied.
This means the user will receive updates for any modifications to the issues. Note, that this will not check if a user has the BROWSE_ISSUE permission. Notifications will however only be sent to users who have the appropriate permissions. Adding a permission check here would complicate updating permission schemes a lot, as it would have to update issues' watchers lists.
This bulk method is more performant than calling the single version multiple times, as it indexes the issues in bulk rather than one at a time.
user | user that starts watching the given issues |
---|---|
issues | the list of issues to watch |
taskContext | a context through which progress can be reported back |
Enable watching of a particular issue for the user supplied.
This means the user will receive updates for any modifications to the issue. Note, that this will not check if a user has the BROWSE_ISSUE permission. Notifications will however only be sent to users who have the appropriate permissions. Adding a permission check here would complicate updating permission schemes a lot, as it would have to update issue's watchers lists.
user | user that starts watching the given issue |
---|---|
issue | issue being watched |
Disable watching of a particular issue for the user supplied.
user | user that stops watching the given issue |
---|---|
issue | issue being watched |
Disable watching of a list of issues for the user supplied.
This bulk method is more performant than calling the single version multiple times, as it indexes the issues in bulk rather than one at a time.
user | user that stops watching the given issues |
---|---|
issues | list of issues being watched |
taskContext | a context through which progress can be reported back |