Package com.atlassian.jira.webtests.ztests.email

Class ShareClient

java.lang.Object

com.atlassian.jira.testkit.client.RestApiClient

com.atlassian.jira.webtests.ztests.email.ShareClient

public class ShareClient
extends com.atlassian.jira.testkit.client.RestApiClient

A REST client used to talk to the share e-mail rest resource.

Since:

v5.0

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.testkit.client.RestApiClient

com.atlassian.jira.testkit.client.RestApiClient.BackdoorLoggingFilter, com.atlassian.jira.testkit.client.RestApiClient.JsonMediaTypeFilter, com.atlassian.jira.testkit.client.RestApiClient.RestCall

Field Summary

Fields inherited from class com.atlassian.jira.testkit.client.RestApiClient

REST_VERSION

Constructor Summary

Constructors

Constructor	Description
ShareClient(JIRAEnvironmentData environmentData)

Method Summary

Modifier and Type	Method	Description
com.atlassian.jira.testkit.client.restclient.ParsedResponse	shareIssue(String issueKey, Set<String> usernames, Set<String> emails, String message)	Shares an issue with the given key with the users and email addresses specified.
com.atlassian.jira.testkit.client.restclient.ParsedResponse	shareSavedSearch(String searchRequestId, Set<String> usernames, Set<String> emails, String message)	Shares a saved search (filter) with the given id with the users and email addresses specified.
com.atlassian.jira.testkit.client.restclient.ParsedResponse	shareSearchQuery(String jql, Set<String> usernames, Set<String> emails, String message)	Shares a search query with the users and email addresses specified.

Methods inherited from class com.atlassian.jira.testkit.client.RestApiClient

anonymous, authenticate, authoriseWithOAuth2, authoriseWithOAuth2, cleanUp, client, createResource, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getCredentialsProvider, getEnvironmentData, loginAs, loginAs, registerResponse, resourceRoot, resourceRoot, setOf, toResponse, toResponse, toResponse, withCredentialsProvider

Methods inherited from class java.lang.Object

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

Constructor Details

ShareClient

public ShareClient(JIRAEnvironmentData environmentData)

Method Details

shareIssue

public com.atlassian.jira.testkit.client.restclient.ParsedResponse shareIssue(String issueKey,
 Set<String> usernames,
 @Nullable
 Set<String> emails,
 String message)

Shares an issue with the given key with the users and email addresses specified.

Parameters:

issueKey - the issue key of the issue to share

usernames - JIRA users to share with

emails - email addresses to share with

message - A message to send with the share email

Returns:

a Response

shareSavedSearch

public com.atlassian.jira.testkit.client.restclient.ParsedResponse shareSavedSearch(String searchRequestId,
 Set<String> usernames,
 @Nullable
 Set<String> emails,
 String message)

Shares a saved search (filter) with the given id with the users and email addresses specified.

Parameters:

searchRequestId - the id of the saved SearchRequest to share

usernames - JIRA users to share with

emails - email addresses to share with

message - A message to send with the share email

Returns:

a Response

shareSearchQuery

public com.atlassian.jira.testkit.client.restclient.ParsedResponse shareSearchQuery(String jql,
 Set<String> usernames,
 @Nullable
 Set<String> emails,
 String message)

Shares a search query with the users and email addresses specified.

Parameters:

jql - the jql query to share

usernames - JIRA users to share with

emails - email addresses to share with

message - A message to send with the share email

Returns:

a Response