@PublicApi public class

MentionIssueEvent

extends Object
java.lang.Object
   ↳ com.atlassian.jira.event.issue.MentionIssueEvent
Known Direct Subclasses

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Summary

Public Constructors
MentionIssueEvent(Issue issue, User fromUser, Set<User> toUsers, String mentionText, String fieldId, Set<NotificationRecipient> currentRecipients)
Public Methods
boolean equals(Object o)
Set<NotificationRecipient> getCurrentRecipients()
String getFieldId()
User getFromUser()
Issue getIssue()
String getMentionText()
Set<User> getToUsers()
int hashCode()
String toString()
Protected Methods
boolean _equals(MentionIssueEvent that)
ToStringBuilder buildToString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MentionIssueEvent (Issue issue, User fromUser, Set<User> toUsers, String mentionText, String fieldId, Set<NotificationRecipient> currentRecipients)

Public Methods

public boolean equals (Object o)

public Set<NotificationRecipient> getCurrentRecipients ()

public String getFieldId ()

public User getFromUser ()

public Issue getIssue ()

public String getMentionText ()

public Set<User> getToUsers ()

public int hashCode ()

public String toString ()

Protected Methods

protected boolean _equals (MentionIssueEvent that)

protected ToStringBuilder buildToString ()