com.atlassian.servicedesk.api.comment

Interface ServiceDeskCommentService

@PublicApi
public interface ServiceDeskCommentService

This components provides the ability to create public and private comments for service projects.

Method Summary

Modifier and Type	Method and Description
ServiceDeskComment	createServiceDeskComment(com.atlassian.jira.user.ApplicationUser user, ServiceDeskCommentCreateParameters createParameters) Create a new service project comment with the provided ApplicationUser as the author
PagedResponse<ServiceDeskComment>	getCommentsOfRequest(com.atlassian.jira.user.ApplicationUser user, ServiceDeskCommentQuery commentQuery) Retrieve a page of ServiceDeskComment of a particular CustomerRequest
ServiceDeskComment	getServiceDeskCommentById(com.atlassian.jira.user.ApplicationUser user, Long commentId) Gets a ServiceDeskComment from a comment id.
ServiceDeskComment	getServiceDeskCommentByJiraComment(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.issue.comments.Comment comment) Gets a ServiceDeskComment from an associated Comment.
ServiceDeskCommentCreateParameters.Builder	newCreateBuilder() Return a new ServiceDeskCommentCreateParameters.Builder to build parameter to create comments
ServiceDeskCommentQuery.Builder	newQueryBuilder()

Method Detail

getServiceDeskCommentById

@Nonnull
ServiceDeskComment getServiceDeskCommentById(@Nonnull
                                                      com.atlassian.jira.user.ApplicationUser user,
                                                      @Nonnull
                                                      Long commentId)

Gets a ServiceDeskComment from a comment id. A ServiceDeskComment shares the same id as the underlying Jira Comment.

Parameters:

commentId - the id of the ServiceDeskComment

Returns:

the ServiceDeskComment with the given id if it exists.

Throws:

ServiceDeskServiceException - on error

getServiceDeskCommentByJiraComment

@Nonnull
ServiceDeskComment getServiceDeskCommentByJiraComment(@Nonnull
                                                               com.atlassian.jira.user.ApplicationUser user,
                                                               @Nonnull
                                                               com.atlassian.jira.issue.comments.Comment comment)

Gets a ServiceDeskComment from an associated Comment. Each ServiceDeskComment is associated with exactly one Comment.

Parameters:

comment - the JIRA Comment

Returns:

the ServiceDeskComment associated with the given Comment

Throws:

ServiceDeskServiceException - on error

newCreateBuilder

ServiceDeskCommentCreateParameters.Builder newCreateBuilder()

Return a new ServiceDeskCommentCreateParameters.Builder to build parameter to create comments

createServiceDeskComment

@Nonnull
ServiceDeskComment createServiceDeskComment(@Nonnull
                                                     com.atlassian.jira.user.ApplicationUser user,
                                                     @Nonnull
                                                     ServiceDeskCommentCreateParameters createParameters)

Create a new service project comment with the provided ApplicationUser as the author

Parameters:

user - the author of the comment

createParameters - contains comment body and visibility (public/internal)

Returns:

ServiceDeskComment if successful, or AnError if fail

Throws:

ServiceDeskServiceException - on error

newQueryBuilder

ServiceDeskCommentQuery.Builder newQueryBuilder()

Returns:

a new ServiceDeskCommentQuery.Builder to build comment query

getCommentsOfRequest

@Nonnull
PagedResponse<ServiceDeskComment> getCommentsOfRequest(@Nonnull
                                                                com.atlassian.jira.user.ApplicationUser user,
                                                                @Nonnull
                                                                ServiceDeskCommentQuery commentQuery)

Retrieve a page of ServiceDeskComment of a particular CustomerRequest

Parameters:

user - the user executing the query

commentQuery - the query to filter comments

Returns:

an AnError if failure, or a paged collection of ServiceDeskComment

Throws:

ServiceDeskServiceException - on error