org.everit.atlassian.restclient.jiracloud.v3.api

Class IssueWatchersApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.IssueWatchersApi

public class IssueWatchersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IssueWatchersApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addWatcher(String issueIdOrKey, String body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add watcher Adds a user as a watcher of an issue by passing the account ID of the user.
io.reactivex.Single<Watchers>	getIssueWatchers(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue watchers Returns the watchers for an issue.
io.reactivex.Completable	removeWatcher(String issueIdOrKey, Optional<String> username, Optional<String> accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete watcher Deletes a user as a watcher of an issue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IssueWatchersApi

public IssueWatchersApi(org.everit.http.restclient.RestClient restClient)

Method Detail

addWatcher

public io.reactivex.Single<Object> addWatcher(String issueIdOrKey,
                                              String body,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add watcher Adds a user as a watcher of an issue by passing the account ID of the user. For example, `\"5b10ac8d82e05b22cc7d4ef5\"`. If no user is specified the calling user is added. This operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * To add users other than themselves to the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

body - The account ID of the user. Note that username cannot be used due to privacy changes. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

getIssueWatchers

public io.reactivex.Single<Watchers> getIssueWatchers(String issueIdOrKey,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue watchers Returns the watchers for an issue. This operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * To see details of users on the watchlist other than themselves, *View voters and watchers* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Watchers>

removeWatcher

public io.reactivex.Completable removeWatcher(String issueIdOrKey,
                                              Optional<String> username,
                                              Optional<String> accountId,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete watcher Deletes a user as a watcher of an issue. This operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * To remove users other than themselves from the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable