|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MentionService
Responsible for publishing MentionIssueEvent
when a user has mentioned
other users on an issue.
Method Summary | |
---|---|
boolean |
isUserAbleToMention(com.atlassian.crowd.embedded.api.User remoteUser)
Whether the specified user is able to mention other users in a JIRA issue. |
void |
sendCommentMentions(com.atlassian.crowd.embedded.api.User remoteUser,
Set<NotificationRecipient> currentRecipients,
Comment comment,
Comment originalComment)
Given a comment object this method will look for any mentions using the MentionFinder and send e-mails to
all users mentioned. |
void |
sendIssueCreateMentions(com.atlassian.crowd.embedded.api.User remoteUser,
Set<NotificationRecipient> currentRecipients,
Issue issue)
Given an issue object this method will look for any mentions in the description field using the MentionFinder and send e-mails to
all users mentioned. |
void |
sendIssueEditMentions(com.atlassian.crowd.embedded.api.User remoteUser,
Set<NotificationRecipient> currentRecipients,
Issue issue,
Comment comment)
Given an issue that has just been edited and an optional edit comment this method sends mention e-mails to all users mentioned in either the new issue description or option edit comment. |
Method Detail |
---|
void sendCommentMentions(com.atlassian.crowd.embedded.api.User remoteUser, Set<NotificationRecipient> currentRecipients, Comment comment, Comment originalComment)
MentionFinder
and send e-mails to
all users mentioned.
Sending mentions can not be performed by anonymous users. The user sending the mentions must have browse users
permission and all users mentioned must have permission to browse the issue. Otherwise no e-mails will be sent.
remoteUser
- The currently logged in user performing this operation.currentRecipients
- A set of recipients already being notified for this mention.comment
- the comment to scan for text.originalComment
- If a comment was edited provied the original comment so that a comparison can be carried out to only send mentions to new users. May be nullvoid sendIssueCreateMentions(com.atlassian.crowd.embedded.api.User remoteUser, Set<NotificationRecipient> currentRecipients, Issue issue)
MentionFinder
and send e-mails to
all users mentioned.
Sending mentions can not be performed by anonymous users. The user sending the mentions must have browse users
permission and all users mentioned must have permission to browse the issue. Otherwise no e-mails will be sent.
remoteUser
- The currently logged in user performing this operation.currentRecipients
- A set of recipients already being notified for this mention.issue
- the issue whose description will be scanned for metions.void sendIssueEditMentions(com.atlassian.crowd.embedded.api.User remoteUser, Set<NotificationRecipient> currentRecipients, Issue issue, Comment comment)
remoteUser
- The currently logged in user performing this operation.currentRecipients
- A set of recipients already being notified for this mention.issue
- the issue whose description will be scanned for metions.comment
- An optional comment for the editboolean isUserAbleToMention(com.atlassian.crowd.embedded.api.User remoteUser)
remoteUser
- The user to check mention permissions for.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |