@PublicApi public interface

NotificationBuilder

com.atlassian.jira.notification.NotificationBuilder

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

See Also

Summary

Public Methods
NotificationBuilder addRestrictGroup(String group)
If group restrictions are added, then the recipients must belong to at least one of the added groups.
NotificationBuilder addRestrictGroups(List<String> groups)
If group restrictions are added, then the recipients must belong to at least one of the added groups.
NotificationBuilder addRestrictPermission(Permissions.Permission permission)
If permission restrictions are added, then the recipients must belong to at least one of the added permissions.
NotificationBuilder addRestrictPermissions(List<Permissions.Permission> permissions)
If permission restrictions are added, then the recipients must belong to at least one of the added permissions.
NotificationBuilder addToEmail(String email)
NotificationBuilder addToEmails(List<String> emails)
NotificationBuilder addToGroup(String group)
NotificationBuilder addToGroups(List<String> groups)
NotificationBuilder addToUser(String user)
NotificationBuilder addToUsers(List<String> users)
List<String> getRestrictGroups()
String getTemplate()
ImmutableMap<String, Object> getTemplateParams()
List<String> getToEmails()
List<String> getToGroups()
List<String> getToUsers()
boolean isToAssignee()
boolean isToReporter()
boolean isToVoters()
boolean isToWatchers()
NotificationBuilder setTemplate(String template)
NotificationBuilder setTemplateParams(ImmutableMap<String, Object> params)
NotificationBuilder setToAssignee(boolean toReporter)
NotificationBuilder setToReporter(boolean toReporter)
NotificationBuilder setToVoters(boolean toVoters)
NotificationBuilder setToWatchers(boolean toWatchers)

Public Methods

public NotificationBuilder addRestrictGroup (String group)

If group restrictions are added, then the recipients must belong to at least one of the added groups.

Parameters
group the group to add
Returns
  • this
See Also

public NotificationBuilder addRestrictGroups (List<String> groups)

If group restrictions are added, then the recipients must belong to at least one of the added groups.

Parameters
groups a list of groups to be added
Returns
  • this
See Also

public NotificationBuilder addRestrictPermission (Permissions.Permission permission)

If permission restrictions are added, then the recipients must belong to at least one of the added permissions.

Parameters
permission the permission to add
Returns
  • this
See Also

public NotificationBuilder addRestrictPermissions (List<Permissions.Permission> permissions)

If permission restrictions are added, then the recipients must belong to at least one of the added permissions.

Parameters
permissions the list of permissions to add
Returns
  • this
See Also

public NotificationBuilder addToEmail (String email)

public NotificationBuilder addToEmails (List<String> emails)

public NotificationBuilder addToGroup (String group)

public NotificationBuilder addToGroups (List<String> groups)

public NotificationBuilder addToUser (String user)

public NotificationBuilder addToUsers (List<String> users)

public List<String> getRestrictGroups ()

public String getTemplate ()

public ImmutableMap<String, Object> getTemplateParams ()

public List<String> getToEmails ()

public List<String> getToGroups ()

public List<String> getToUsers ()

public boolean isToAssignee ()

public boolean isToReporter ()

public boolean isToVoters ()

public boolean isToWatchers ()

public NotificationBuilder setTemplate (String template)

public NotificationBuilder setTemplateParams (ImmutableMap<String, Object> params)

public NotificationBuilder setToAssignee (boolean toReporter)

public NotificationBuilder setToReporter (boolean toReporter)

public NotificationBuilder setToVoters (boolean toVoters)

public NotificationBuilder setToWatchers (boolean toWatchers)