public class

SingleUser

extends AbstractNotificationType
java.lang.Object
   ↳ com.atlassian.jira.notification.type.AbstractNotificationType
     ↳ com.atlassian.jira.notification.type.SingleUser

Summary

Constants
String DESC
Public Constructors
SingleUser(JiraAuthenticationContext jiraAuthenticationContext)
Public Methods
boolean doValidation(String key, Map parameters)
Validate the configuration (the argument in getRecipients(com.atlassian.jira.event.issue.IssueEvent, String)) when it is entered in the "Add Notification" page.
String getArgumentDisplay(String argument)
Obtains the user-friendly display for the argument.
String getArgumentValue(String displayValue)
Obtains the raw parameter value to save for the given user entry user-friendly display value.
String getDisplayName()
List<NotificationRecipient> getRecipients(IssueEvent event, String userKey)
String getType()
Type identifier (currently unused).
[Expand]
Inherited Methods
From class com.atlassian.jira.notification.type.AbstractNotificationType
From class java.lang.Object
From interface com.atlassian.jira.notification.NotificationType

Constants

public static final String DESC

Constant Value: "Single_User"

Public Constructors

public SingleUser (JiraAuthenticationContext jiraAuthenticationContext)

Public Methods

public boolean doValidation (String key, Map parameters)

Validate the configuration (the argument in getRecipients(com.atlassian.jira.event.issue.IssueEvent, String)) when it is entered in the "Add Notification" page. For instance, a group notification type might check if the entered group exists.

Parameters
key Key of relevant value in parameters
parameters HTML form parameters (only the keyed entry is relevant).
Returns
  • Whether the entered value is valid for this type.

public String getArgumentDisplay (String argument)

Obtains the user-friendly display for the argument. For example, returns a username for a key.

Parameters
argument Raw configuration value
Returns
  • Formatted configuration value.

public String getArgumentValue (String displayValue)

Obtains the raw parameter value to save for the given user entry user-friendly display value. For example, the user picker displays a username, but this needs to be stored in the configuration parameter as the user's key, instead.

Parameters
displayValue Value entered into the form (username, for example)
Returns
  • raw configuration value.

public String getDisplayName ()

public List<NotificationRecipient> getRecipients (IssueEvent event, String userKey)

public String getType ()

Type identifier (currently unused).

Returns
  • Eg. "group"