com.atlassian.jira.issue.comments.pin

Interface CommentPinManager

All Known Implementing Classes:

DefaultCommentPinManager

public interface CommentPinManager

The CommentPinManager is used to retrieve and pin comments in Jira.

Method Summary

Modifier and Type	Method and Description
List<CommentPinDTO>	getPinnedComments(long issueId) Returns list of pinned comments for given issue
boolean	isFeatureEnabled() Checks if feature flag is enabled
boolean	isFeatureEnabledForServiceDesk() Checks if dedicated feature flag is enabled for JSM
boolean	isPinned(long commentId) Checks if given comment is pinned
CommentPinDTO	pinComment(long issueId, long commentId, String userKey, java.time.Instant created) Pins comment in given issue
void	unpinComment(long commentId) Unpins comment

Method Detail

pinComment

CommentPinDTO pinComment(long issueId,
                         long commentId,
                         String userKey,
                         java.time.Instant created)

Pins comment in given issue

Parameters:

issueId - of issue which has comment to pin

commentId - to pin

userKey -

created - time of action execution

Returns:

unpinComment

void unpinComment(long commentId)

Unpins comment

Parameters:

commentId - to unpin

isPinned

boolean isPinned(long commentId)

Checks if given comment is pinned

Parameters:

commentId -

Returns:

true if given comment is pinned, otherwise false

getPinnedComments

List<CommentPinDTO> getPinnedComments(long issueId)

Returns list of pinned comments for given issue

Parameters:

issueId -

Returns:

list of pinned comments for given issue

isFeatureEnabled

boolean isFeatureEnabled()

Checks if feature flag is enabled

Returns:

true if feature flag is enabled, otherwise false

isFeatureEnabledForServiceDesk

boolean isFeatureEnabledForServiceDesk()

Checks if dedicated feature flag is enabled for JSM

Returns:

true if feature flag is enabled, otherwise false