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

Class IssueCommentListApi

java.lang.Object

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

public class IssueCommentListApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBeanComment>	getCommentsByIds(IssueCommentListRequestBean issueCommentListRequestBean, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get comments by IDs Returns the comments for a list of comment IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCommentListApi

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

Method Detail

getCommentsByIds

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

Get comments by IDs

Returns the comments for a list of comment IDs.

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:

• has Browse projects project permission for the project containing the comment.
• If issue-level security 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 to include additional information about comments in the response. This parameter accepts multiple values separated by a comma:

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