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

Class IssueVotesApi

java.lang.Object

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

public class IssueVotesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addVote(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add vote Adds the user's vote to an issue.
io.reactivex.Single<Votes>	getVotes(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get votes Returns details about the votes on an issue.
io.reactivex.Completable	removeVote(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete vote Deletes a user's vote from an issue.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueVotesApi

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

Method Detail

addVote

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

Add vote Adds the user's vote to an issue. This is the equivalent of the user clicking *Vote* on an issue in Jira. This operation requires the **Allow users to vote on 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.

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<Object>

getVotes

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

Get votes Returns details about the votes on an issue. This operation requires the **Allow users to vote on 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. Note that users with the necessary permissions for this operation but without the *View voters and watchers* project permissions are not returned details in the `voters` field.

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<Votes>

removeVote

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

Delete vote Deletes a user's vote from an issue. This is the equivalent of the user clicking *Unvote* on an issue in Jira. This operation requires the **Allow users to vote on 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.

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:

Completable