com.atlassian.servicedesk.api.comment

Interface ServiceDeskCommentService

@ExperimentalApi
 @PublicApi
public interface ServiceDeskCommentService

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

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment>	createInternalComment(com.atlassian.jira.user.ApplicationUser user, ValidatedInternalCommentParameters commentParameters) Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment>	createPublicComment(com.atlassian.jira.user.ApplicationUser user, ValidatedPublicCommentParameters commentParameters) Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment>	createServiceDeskComment(com.atlassian.jira.user.ApplicationUser user, ServiceDeskCommentCreateParameters createParameters) Create a new Service Desk comment with the provided ApplicationUser as the author
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<ServiceDeskComment>>	getCommentsOfRequest(com.atlassian.jira.user.ApplicationUser user, ServiceDeskCommentQuery commentQuery) Retrieve a page of ServiceDeskComment of a particular CustomerRequest
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment>	getServiceDeskCommentById(com.atlassian.jira.user.ApplicationUser user, Long commentId) Gets a ServiceDeskComment from a comment id.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment>	getServiceDeskCommentByJiraComment(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.issue.comments.Comment comment) Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)
ServiceDeskCommentCreateParameters.Builder	newCreateBuilder() Return a new ServiceDeskCommentCreateParameters.Builder to build parameter to create comments
ServiceDeskCommentQuery.Builder	newQueryBuilder()
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ValidatedInternalCommentParameters>	validateInternalComment(com.atlassian.jira.user.ApplicationUser user, CreateInternalCommentParameters commentPublicParameters) Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ValidatedPublicCommentParameters>	validatePublicComment(com.atlassian.jira.user.ApplicationUser user, CreatePublicCommentParameters commentInternalParameters) Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)

Method Detail

validatePublicComment

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ValidatedPublicCommentParameters> validatePublicComment(@Nonnull
                                                                                                                                                             com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                             @Nonnull
                                                                                                                                                             CreatePublicCommentParameters commentInternalParameters)

Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)

Validates whether a public comment with the given user and comment parameters can be made. Will perform the necessary checks and return a ValidatedPublicCommentParameters if the user is able to make a comment with the given comment parameters

Parameters:

user - the user to make the comment

commentInternalParameters - the comment parameters

Returns:

a validated object that can be used to make a public comment

validateInternalComment

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ValidatedInternalCommentParameters> validateInternalComment(@Nonnull
                                                                                                                                                                 com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                                 @Nonnull
                                                                                                                                                                 CreateInternalCommentParameters commentPublicParameters)

Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)

Validates whether a comment with the given user and comment parameters can be made. Will perform the necessary checks and return a ValidatedInternalCommentParameters if the user is able to make a comment with the given comment parameters

Parameters:

user - the user to make the comment

commentPublicParameters - the comment parameters

Returns:

a validated object that can be used to make a internal comment

createPublicComment

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment> createPublicComment(@Nonnull
                                                                                                                                             com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                             @Nonnull
                                                                                                                                             ValidatedPublicCommentParameters commentParameters)

Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)

Creates a public Comment against a com.atlassian.jira.issue.Issue

Parameters:

user - the user making the comment

commentParameters - the comment parameters used to create the comment

Returns:

the newly created ServiceDeskComment

createInternalComment

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment> createInternalComment(@Nonnull
                                                                                                                                               com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                               @Nonnull
                                                                                                                                               ValidatedInternalCommentParameters commentParameters)

Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)

Creates an internal Comment against a com.atlassian.jira.issue.Issue An error will be returned if the user does not have permission to create a public comment or if the comment parameters fail validation. An error will also be returned if the issue specified does not belong to an active Service Desk.

Parameters:

user - the user making the comment

commentParameters - the comment parameters used to create the comment

Returns:

the newly created ServiceDeskComment

getServiceDeskCommentById

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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.

getServiceDeskCommentByJiraComment

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment> getServiceDeskCommentByJiraComment(@Nonnull
                                                                                                                                                            com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                            @Nonnull
                                                                                                                                                            com.atlassian.jira.issue.comments.Comment comment)

Deprecated. use createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters)

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

newCreateBuilder

ServiceDeskCommentCreateParameters.Builder newCreateBuilder()

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

createServiceDeskComment

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDeskComment> createServiceDeskComment(@Nonnull
                                                                                                                                     com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                     @Nonnull
                                                                                                                                     ServiceDeskCommentCreateParameters createParameters)

Create a new Service Desk 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

newQueryBuilder

ServiceDeskCommentQuery.Builder newQueryBuilder()

Returns:

a new ServiceDeskCommentQuery.Builder to build comment query

getCommentsOfRequest

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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