@PublicApi public interface

IssueEventManager

com.atlassian.jira.event.issue.IssueEventManager
Known Indirect Subclasses

@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).

Class Overview

Component responsible for dispatching issue events.

Summary

Public Methods
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, GenericValue changelog, boolean sendMail, boolean subtasksUpdated)
Dispatch event of given type.
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, Map params)
Dispatch event of given type with custom parameters.
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog)
Dispatch event of given type.
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, boolean sendMail)
Dispatch event of given type.
void dispatchEvent(Long eventTypeId, Issue issue, Map<StringObject> params, User remoteUser, boolean sendMail)
Dispatch event of given type with custom parameters.
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, Map params, boolean sendMail)
Dispatch event of given type with custom parameters.
void dispatchEvent(Long eventTypeId, Issue issue, Map params, User remoteUser)
Dispatch event of given type with custom parameters.
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, boolean sendMail)
Dispatch event of given type, configuring whether or not a mail notification should be sent (useful e.g.
void dispatchEvent(Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, Map params, boolean sendMail, boolean subtasksUpdated)
Dispatch event of given type with custom parameters.

Public Methods

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, GenericValue changelog, boolean sendMail, boolean subtasksUpdated)

Dispatch event of given type.

Parameters
eventTypeId type of event
issue affected issue
remoteUser remoteUser user initiating the event
changelog attached changeGroup for this event
sendMail whether or not a mail notification should be sent
subtasksUpdated if subtask have been modified.

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, Map params)

Dispatch event of given type with custom parameters.

Parameters
eventTypeId type of event
issue affected issue
remoteUser remoteUser user initiating the event
comment comment for this event
worklog worklog for this event
changelog attached changeGroup for this event
params custom event parameters

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog)

Dispatch event of given type.

Parameters
eventTypeId type of event
issue affected issue
remoteUser remoteUser user initiating the event
comment comment for this event
worklog worklog for this event
changelog An attached changeGroup for this event

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, boolean sendMail)

Dispatch event of given type.

Parameters
eventTypeId type of event
issue affected issue
remoteUser remoteUser user initiating the event
comment comment for this event
worklog worklog for this event
changelog attached changeGroup for this event
sendMail whether or not a mail notification should be sent

public void dispatchEvent (Long eventTypeId, Issue issue, Map<StringObject> params, User remoteUser, boolean sendMail)

Dispatch event of given type with custom parameters.

Parameters
eventTypeId type of event
issue affected issue
params custom event parameters
remoteUser user initiating the event
sendMail whether or not a mail notification should be sent

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, Map params, boolean sendMail)

Dispatch event of given type with custom parameters.

Parameters
eventTypeId type of event
issue affected issue
remoteUser remoteUser user initiating the event
comment comment for this event
worklog worklog for this event
changelog attached changeGroup for this event
params custom event parameters
sendMail whether or not a mail notification should be sent

public void dispatchEvent (Long eventTypeId, Issue issue, Map params, User remoteUser)

Dispatch event of given type with custom parameters.

Parameters
eventTypeId type of event
issue affected issue
params custom event parameters
remoteUser user initiating the event

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, boolean sendMail)

Dispatch event of given type, configuring whether or not a mail notification should be sent (useful e.g. for bulk edit).

Parameters
eventTypeId type of event
issue affected issue
remoteUser user initiating the event
sendMail whether or not a mail notification should be sent

public void dispatchEvent (Long eventTypeId, Issue issue, User remoteUser, Comment comment, Worklog worklog, GenericValue changelog, Map params, boolean sendMail, boolean subtasksUpdated)

Dispatch event of given type with custom parameters.

Parameters
eventTypeId type of event
issue affected issue
remoteUser remoteUser user initiating the event
comment comment for this event
worklog worklog for this event
changelog attached changeGroup for this event
params custom event parameters
sendMail whether or not a mail notification should be sent
subtasksUpdated if subtask have been modified.