com.atlassian.jira.reactions

Class DefaultCommentReactionsService

java.lang.Object

com.atlassian.jira.reactions.DefaultCommentReactionsService

All Implemented Interfaces:

Startable, CommentReactionsService

public class DefaultCommentReactionsService
extends Object
implements CommentReactionsService, Startable

Since:

8.17, 8.21 added the product type key to identify if reactions are coming from Jira or JSM projects

Constructor Summary

Constructors

Constructor and Description
DefaultCommentReactionsService(CommentReactionManager commentReactionManager, UserManager userManager, PermissionManager permissionManager, CommentService commentService, CommentReactionsEnabledService commentReactionsEnabledService, CommentPermissionManager commentPermissionManager, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<ReactionSummary>	addReaction(ApplicationUser loggedInUser, long commentId, String emojiId) Checks whether the user already reacted to the comment with given emoji, and if not, adds a reaction.
ServiceOutcome<ReactionSummary>	deleteReaction(ApplicationUser loggedInUser, Long commentId, String emojiId) Deletes a reaction.
ServiceOutcome<ReactionSummary>	getDetailedReaction(ApplicationUser loggedInUser, Long commentId, String emoji) Gets the details of the reaction containing Unicode of the emoji and a list of users who reacted with it.
ServiceOutcome<Collection<ReactionSummary>>	getReactions(ApplicationUser loggedInUser, Collection<Long> commentIds) Gets all reactions for a given comment.
void	onCommentDeleted(CommentDeletedEvent event)
void	start() This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommentReactionsService

public DefaultCommentReactionsService(CommentReactionManager commentReactionManager,
                                      UserManager userManager,
                                      PermissionManager permissionManager,
                                      CommentService commentService,
                                      CommentReactionsEnabledService commentReactionsEnabledService,
                                      CommentPermissionManager commentPermissionManager,
                                      com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

start

public void start()

Description copied from interface: Startable

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

onCommentDeleted

@EventListener
public void onCommentDeleted(CommentDeletedEvent event)

getReactions

@Nonnull
public ServiceOutcome<Collection<ReactionSummary>> getReactions(@Nonnull
                                                                         ApplicationUser loggedInUser,
                                                                         Collection<Long> commentIds)

Description copied from interface: CommentReactionsService

Gets all reactions for a given comment.

Specified by:

getReactions in interface CommentReactionsService

Parameters:

loggedInUser - the user performing operation

commentIds - comments ids

Returns:

a collection of ReactionSummary

getDetailedReaction

public ServiceOutcome<ReactionSummary> getDetailedReaction(@Nonnull
                                                           ApplicationUser loggedInUser,
                                                           Long commentId,
                                                           String emoji)

Description copied from interface: CommentReactionsService

Gets the details of the reaction containing Unicode of the emoji and a list of users who reacted with it.

Specified by:

getDetailedReaction in interface CommentReactionsService

Parameters:

loggedInUser - the user performing operation

commentId - the ID of the comment

emoji - Unicode of the emoji

Returns:

the ReactionSummary object

addReaction

public ServiceOutcome<ReactionSummary> addReaction(@Nonnull
                                                   ApplicationUser loggedInUser,
                                                   long commentId,
                                                   String emojiId)

Description copied from interface: CommentReactionsService

Checks whether the user already reacted to the comment with given emoji, and if not, adds a reaction.

Specified by:

addReaction in interface CommentReactionsService

Parameters:

loggedInUser - the user performing operation

commentId - the ID of the comment

emojiId - Unicode of the emoji

Returns:

the updated ReactionSummary for given emoji and given comment

deleteReaction

public ServiceOutcome<ReactionSummary> deleteReaction(@Nonnull
                                                      ApplicationUser loggedInUser,
                                                      Long commentId,
                                                      String emojiId)

Description copied from interface: CommentReactionsService

Deletes a reaction. If there are duplicated reactions in the database, all matching records will be deleted.

Specified by:

deleteReaction in interface CommentReactionsService

Parameters:

loggedInUser - the user performing operation

commentId - the ID of the comment

emojiId - Unicode of the emoji

Returns:

the updated ReactionSummary for given emoji and given comment