Package com.atlassian.jira.rest.internal.v2.user

Class MentionResource

java.lang.Object

com.atlassian.jira.rest.internal.v2.user.MentionResource

@Path("user/mention")
@Consumes("application/json")
@Produces("application/json")
public class MentionResource
extends Object

Internal resources backing @mentions.

Since:

v7.2

Constructor Summary

Constructors

Constructor	Description
MentionResource(EmailFormatter emailFormatter, I18nHelper.BeanFactory beanFactory, IssueFinder issueFinder, JiraAuthenticationContext authContext, JiraBaseUrls jiraBaseUrls, MentionableUserSearcher mentionableUserSearch, TimeZoneManager timeZoneManager, AvatarService avatarService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	search(String query, String issueKey, Integer maxResults)	Returns a list of users who are relevant to the issue and match the query string.

Methods inherited from class java.lang.Object

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

Constructor Details

MentionResource

@Inject
public MentionResource(EmailFormatter emailFormatter,
 I18nHelper.BeanFactory beanFactory,
 IssueFinder issueFinder,
 JiraAuthenticationContext authContext,
 JiraBaseUrls jiraBaseUrls,
 MentionableUserSearcher mentionableUserSearch,
 TimeZoneManager timeZoneManager,
 AvatarService avatarService)

Method Details

search

@GET
@Path("search")
public javax.ws.rs.core.Response search(@QueryParam("query")
 String query,
 @QueryParam("issueKey")
 String issueKey,
 @QueryParam("maxResults")
 Integer maxResults)

Returns a list of users who are relevant to the issue and match the query string. The users are sorted by 'relevance' to the issue, with most relevant appearing first in the list.

Parameters:

query - The username filter, no users returned if left blank

issueKey - The issue key for the issue being edited we need to find viewable users for.

maxResults - The maximum number of users to return (defaults to 50). The maximum allowed value is 100.

Returns:

a Response with the users matching the query