public class

ShareResource

extends Object
java.lang.Object
   ↳ com.atlassian.jira.plugins.share.rest.ShareResource

Class Overview

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

Summary

Public Constructors
@Autowired ShareResource(JiraAuthenticationContext authenticationContext, UserPreferencesManager userPreferencesManager, SearchRequestService searchRequestService, ShareService shareService, IssueService issueService)
Public Methods
Response shareIssue(String issueKey, ShareBean shareBean)
Shares an issue via email with a number of users and email-addressees
Response shareSearch(ShareBean shareBean)
Shares a jql search via e-mail.
Response shareSearchRequest(Long id, ShareBean shareBean)
Shares a saved filter via e-mail.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

@Autowired public ShareResource (JiraAuthenticationContext authenticationContext, UserPreferencesManager userPreferencesManager, SearchRequestService searchRequestService, ShareService shareService, IssueService issueService)

Public Methods

public 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

public Response shareSearch (ShareBean shareBean)

Shares a jql search via e-mail.

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

public 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