com.atlassian.jira.plugins.share.rest
Class ShareResource

java.lang.Object
  extended by com.atlassian.jira.plugins.share.rest.ShareResource

public class ShareResource
extends Object

A REST resource that allows sharing various entities (Issues, Searchers, JQL) via e-mail.

Since:
v5.0

Constructor Summary
ShareResource(JiraAuthenticationContext authenticationContext, UserPreferencesManager userPreferencesManager, SearchRequestService searchRequestService, ShareService shareService, IssueService issueService)
           
 
Method Summary
 javax.ws.rs.core.Response shareIssue(String issueKey, ShareBean shareBean)
          Shares an issue via email with a number of users and email-addressees
 javax.ws.rs.core.Response shareSearch(ShareBean shareBean)
          Shares a jql search via e-mail.
 javax.ws.rs.core.Response shareSearchRequest(Long id, ShareBean shareBean)
          Shares a saved filter via e-mail.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShareResource

public ShareResource(JiraAuthenticationContext authenticationContext,
                     UserPreferencesManager userPreferencesManager,
                     SearchRequestService searchRequestService,
                     ShareService shareService,
                     IssueService issueService)
Method Detail

shareIssue

public javax.ws.rs.core.Response shareIssue(String issueKey,
                                            ShareBean shareBean)
Shares an issue via email with a number of users and email-addressees

Parameters:
issueKey - the issue to create the remote issue link for
shareBean - a shareBean to share an issue
Returns:
a 204 HTTP status if everything goes well, otherwise the Response contains the error details

shareSearchRequest

public javax.ws.rs.core.Response shareSearchRequest(Long id,
                                                    ShareBean shareBean)
Shares a saved filter via e-mail.

Parameters:
id - the id of the filter being looked up
shareBean - A ShareBean containing information for the share operation
Returns:
a Response

shareSearch

public javax.ws.rs.core.Response shareSearch(ShareBean shareBean)
Shares a jql search via e-mail.

Parameters:
shareBean - A ShareBean containing information for the share operation
Returns:
a Response


Copyright © 2002-2014 Atlassian. All Rights Reserved.