org.everit.atlassian.restclient.jiracloud.v2.api

Class IssueCommentsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.IssueCommentsApi

public class IssueCommentsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Comment>	addComment(String issueIdOrKey, Comment requestBody, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add comment Adds a comment to an issue.
io.reactivex.Completable	deleteComment(String issueIdOrKey, String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete comment Deletes a comment.
io.reactivex.Single<Comment>	getComment(String issueIdOrKey, String id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get comment Returns a comment.
io.reactivex.Single<PageOfComments>	getComments(String issueIdOrKey, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> orderBy, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get comments Returns all comments for an issue.
io.reactivex.Single<PageBeanComment>	getCommentsByIds(IssueCommentListRequestBean issueCommentListRequestBean, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get comments by IDs Returns a [paginated](#pagination) list of just the comments for a list of comments specified by comment IDs.
io.reactivex.Single<Comment>	updateComment(String issueIdOrKey, String id, Comment requestBody, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update comment Updates a comment.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCommentsApi

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

Method Detail

addComment

public io.reactivex.Single<Comment> addComment(String issueIdOrKey,
                                               Comment requestBody,
                                               Optional<String> expand,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add comment Adds a comment to an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment 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)

requestBody - (required)

expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. (optional)

restRequestEnhancer -

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

Returns:

Single<Comment>

deleteComment

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

Delete comment Deletes a comment. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Delete all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any comment or *Delete own comments* to delete comment created by the user, * If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters:

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

id - The ID of the comment. (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

getComment

public io.reactivex.Single<Comment> getComment(String issueIdOrKey,
                                               String id,
                                               Optional<String> expand,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get comment Returns a comment. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters:

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

id - The ID of the comment. (required)

expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. (optional)

restRequestEnhancer -

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

Returns:

Single<Comment>

getComments

public io.reactivex.Single<PageOfComments> getComments(String issueIdOrKey,
                                                       Optional<Long> startAt,
                                                       Optional<Integer> maxResults,
                                                       Optional<String> orderBy,
                                                       Optional<String> expand,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get comments Returns all comments for an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Comments are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.

Parameters:

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

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 50)

orderBy - [Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date. (optional)

expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. (optional)

restRequestEnhancer -

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

Returns:

Single<PageOfComments>

getCommentsByIds

public io.reactivex.Single<PageBeanComment> getCommentsByIds(IssueCommentListRequestBean issueCommentListRequestBean,
                                                             Optional<String> expand,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get comments by IDs Returns a [paginated](#pagination) list of just the comments for a list of comments specified by comment IDs. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Comments are returned where the user: * has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

issueCommentListRequestBean - The list of comment IDs. (required)

expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: * `renderedBody` Returns the comment body rendered in HTML. * `properties` Returns the comment's properties. (optional)

restRequestEnhancer -

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

Returns:

Single<PageBeanComment>

updateComment

public io.reactivex.Single<Comment> updateComment(String issueIdOrKey,
                                                  String id,
                                                  Comment requestBody,
                                                  Optional<String> expand,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update comment Updates a comment. 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 containing the comment is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any comment or *Edit own comments* to update comment created by the user. * If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters:

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

id - The ID of the comment. (required)

requestBody - (required)

expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. (optional)

restRequestEnhancer -

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

Returns:

Single<Comment>