com.atlassian.jira.event.issue

Class MentionIssueEvent

java.lang.Object

com.atlassian.jira.event.issue.MentionIssueEvent

Direct Known Subclasses:

MentionIssueCommentEvent

@PublicApi
 @ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public class MentionIssueEvent
extends Object

When a user mentions another user on an issue via the @username or [~username] syntax this event will be fired. It contains the user that added the comment or description, all users mentioned, the issue as well as the text in which the mentions occurred. Finally it also contains the fieldId of the field in which users were mentioned.

Since:

v5.0

Constructor Summary

Constructors

Constructor and Description
MentionIssueEvent(Issue issue, ApplicationUser fromUser, Set<ApplicationUser> toUsers, Set<NotificationRecipient> recipients, String mentionText, String fieldId, Set<NotificationRecipient> currentRecipients)
MentionIssueEvent(Issue issue, ApplicationUser fromUser, Set<ApplicationUser> toUsers, String mentionText, String fieldId, Set<NotificationRecipient> currentRecipients) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<NotificationRecipient>	getCurrentRecipients() Deprecated.
String	getFieldId()
ApplicationUser	getFromUser()
Issue	getIssue()
String	getMentionText()
Set<NotificationRecipient>	getRecipients() Returns the recipients that should receive an email for this mention, after de-duplicating users that already received an email for an action in this bundle.
Set<ApplicationUser>	getToUsers() Returns the set of mentioned users, after permission checks.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MentionIssueEvent

@Deprecated
public MentionIssueEvent(Issue issue,
                                     ApplicationUser fromUser,
                                     Set<ApplicationUser> toUsers,
                                     String mentionText,
                                     String fieldId,
                                     @Nullable
                                     Set<NotificationRecipient> currentRecipients)

Deprecated.

MentionIssueEvent

public MentionIssueEvent(Issue issue,
                         ApplicationUser fromUser,
                         Set<ApplicationUser> toUsers,
                         Set<NotificationRecipient> recipients,
                         String mentionText,
                         String fieldId,
                         @Nullable
                         Set<NotificationRecipient> currentRecipients)

Method Detail

getIssue

public Issue getIssue()

getFromUser

public ApplicationUser getFromUser()

getToUsers

public Set<ApplicationUser> getToUsers()

Returns the set of mentioned users, after permission checks.

getRecipients

public Set<NotificationRecipient> getRecipients()

Returns the recipients that should receive an email for this mention, after de-duplicating users that already received an email for an action in this bundle.

Since:

8.9

getMentionText

public String getMentionText()

getFieldId

public String getFieldId()

getCurrentRecipients

@Deprecated
 @Nullable
public Set<NotificationRecipient> getCurrentRecipients()

Deprecated.

Returns the recipients that are already receiving an email for the event that triggered this mention (such as issue commented event, etc.).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object