java.lang.Object | ||
↳ | com.atlassian.jira.event.AbstractEvent | |
↳ | com.atlassian.jira.event.issue.IssueEvent |
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).
@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).
Basic representation of something that happens to an Issue, such as a modification or comment. Event listeners register to receive these.
TheIssueEvent
object thrown as a result of an edit operation, may now return null from a
getChangeLog()
call. This can occur when a user chooses to edit an issue but only leaves a comment and
makes no other changes to the issue.
Prior to 3.5.2 no event was fired in this case and this was identified as a bug (JRA-9415) and has since been fixed.
Check any calls to getChangeLog()
for null.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | SEND_MAIL |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
BASE_URL_PARAM_NAME | Key of event parameter holding the application's base URL. | ||||||||||
CHANGE_HISTORY_PARAM_NAME | In case of issue delete events, a param with this key will store list of this issue's change history as a list of
ChangeHistoryItem objects. |
||||||||||
COMMENTS_PARAM_NAME | In case of issue delete events, a param with this key will store list of this issue's comments as a list of
Comment objects. |
||||||||||
CUSTOM_FIELDS_PARAM_NAME | In case of issue delete events, a param with this key may store the custom field values of the deleted issue. | ||||||||||
WATCHERS_PARAM_NAME |
In case of issue delete events, a param with this key may store list of this issue's watchers as a list of
User objects. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.atlassian.jira.event.AbstractEvent
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a new IssueEvent with a given list of parameters.
| |||||||||||
Allows configuration of whether the mail notification should be sent
| |||||||||||
Create a new IssueEvent with a given list of parameters.
| |||||||||||
Create a new IssueEvent with a given list of parameters.
| |||||||||||
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Note: this will not compare the time stamps of two events - only everything else.
| |||||||||||
Returns the user who initiated this event.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.atlassian.jira.event.AbstractEvent
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.event.JiraEvent
| |||||||||||
From interface
com.atlassian.jira.event.issue.IssueRelatedEvent
|
Key of event parameter holding the application's base URL.
In case of issue delete events, a param with this key will store list of this issue's change history as a list of
ChangeHistoryItem
objects.
In case of issue delete events, a param with this key will store list of this issue's comments as a list of
Comment
objects.
User
objects.
NOTE: this parameter is not guaranteed to exist so explicit check in the event parameters map must
be performed by the clients. If not found, the value may be retrieved via
getWatchers(com.atlassian.jira.issue.Issue)
.
Create a new IssueEvent with a given list of parameters.
issue | the issue this event refers to |
---|---|
params | parameters that can be retrieved by the Listener |
user | the user who has initiated this event |
eventTypeId | the type ID of this event |
Allows configuration of whether the mail notification should be sent
issue | the issue this event refers to |
---|---|
params | parameters that can be retrieved by the Listener |
user | the user who has initiated this event |
eventTypeId | the type ID of this event |
sendMail | configure whether mail notifications should be sent |
Create a new IssueEvent with a given list of parameters.
This event also has an attached changeGroup, comment and worklog (any of which may be null).issue | The issue this event refers to |
---|---|
user | the user who has initiated this event |
comment | A comment for this event |
worklog | A worklog for this event |
changeGroup | An attached changeGroup for this event |
params | Parameters that can be retrieved by the Listener |
eventTypeId | the type ID of this event |
Create a new IssueEvent with a given list of parameters.
This event also has an attached changeGroup, comment and worklog (any of which may be null).issue | the issue this event refers to |
---|---|
user | the user who has initiated this event |
comment | comment for this event |
worklog | A worklog for this event |
changeGroup | an attached changeGroup for this event |
params | parameters that can be retrieved by the Listener |
eventTypeId | the type ID of this event |
sendMail | configure whether mail notifications should be sent |
Note: this will not compare the time stamps of two events - only everything else.
Returns the user who initiated this event.