com.atlassian.jira.event.type.EventDispatchOption |
Known Indirect Subclasses |
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).
Defines an event dispatch strategy to use when updating issues.
A client caller may want to skip dispatching an event or they may want to specify which event should be fired.
The DO_NOT_DISPATCH
event is to be used if an event should not be dispatched. ISSUE_UPDATED
is the
default behavior and will dispatch a ISSUE_UPDATED_ID
event.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
EventDispatchOption.EventDispatchOptionImpl | |||||||||||
EventDispatchOption.Factory | A simple convenience object that will allow you to easily construct an EventDispatchOption. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DO_NOT_DISPATCH | Use this when you do not want an event to be dispatched. | ||||||||||
ISSUE_ASSIGNED | Use this when you want to dispatch an ISSUE_ASSIGNED_ID event. |
||||||||||
ISSUE_DELETED | Use this when you want to dispatch an ISSUE_DELETED_ID event. |
||||||||||
ISSUE_UPDATED | Use this when you want to dispatch an ISSUE_UPDATED_ID event. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Used to specify the event type this option is configured to express.
| |||||||||||
This should be false if you do not want to dispatch an event, otherwise the event specified by
getEventTypeId() will be used. |
Use this when you do not want an event to be dispatched.
Use this when you want to dispatch an ISSUE_ASSIGNED_ID
event.
Use this when you want to dispatch an ISSUE_DELETED_ID
event.
Use this when you want to dispatch an ISSUE_UPDATED_ID
event.
Used to specify the event type this option is configured to express.
This should be false if you do not want to dispatch an event, otherwise the event specified by getEventTypeId()
will be used.