@PublicApi
public interface EventDispatchOption
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 EventType.ISSUE_UPDATED_ID
event.
Modifier and Type | Interface and Description |
---|---|
static class |
EventDispatchOption.EventDispatchOptionImpl |
static class |
EventDispatchOption.Factory
A simple convenience object that will allow you to easily construct an EventDispatchOption.
|
Modifier and Type | Field and Description |
---|---|
static EventDispatchOption |
DO_NOT_DISPATCH
Use this when you do not want an event to be dispatched.
|
static EventDispatchOption |
ISSUE_ASSIGNED
Use this when you want to dispatch an
EventType.ISSUE_ASSIGNED_ID event. |
static EventDispatchOption |
ISSUE_DELETED
Use this when you want to dispatch an
EventType.ISSUE_DELETED_ID event. |
static EventDispatchOption |
ISSUE_UPDATED
Use this when you want to dispatch an
EventType.ISSUE_UPDATED_ID event. |
Modifier and Type | Method and Description |
---|---|
Long |
getEventTypeId()
Used to specify the event type this option is configured to express.
|
boolean |
isEventBeingSent()
This should be false if you do not want to dispatch an event, otherwise the event specified by
getEventTypeId() will be used. |
static final EventDispatchOption DO_NOT_DISPATCH
static final EventDispatchOption ISSUE_UPDATED
EventType.ISSUE_UPDATED_ID
event.static final EventDispatchOption ISSUE_ASSIGNED
EventType.ISSUE_ASSIGNED_ID
event.static final EventDispatchOption ISSUE_DELETED
EventType.ISSUE_DELETED_ID
event.boolean isEventBeingSent()
getEventTypeId()
will be used.Long getEventTypeId()
Copyright © 2002-2017 Atlassian. All Rights Reserved.