ReactAndroid/com.facebook.react.uimanager.events/Event

Event

abstract class Event<T : Event?>

A UI event that can be dispatched to JS.

For dispatching events getEventData should be used. Once event object is passed to the EventDispatched it should no longer be used as EventDispatcher may decide to recycle that object (by calling dispose).

If you need advanced customizations and overriding only getEventData doesn't work for you, you must override both dispatch and dispatchModern. Both of these will be deleted in the distant future and it is highly recommended to use only getEventData.

Old, pre-Fabric Events only used viewTag as the identifier, but Fabric needs surfaceId as well as viewTag. You may use UIManagerHelper.getSurfaceId on a Fabric-managed View to get the surfaceId. Fabric will work without surfaceId - making Event backwards-compatible - but Events without SurfaceId are slightly slower to propagate.

Inheritors

ViewGroupClickEvent

ContentSizeChangeEvent

DrawerClosedEvent

DrawerOpenedEvent

DrawerSlideEvent

DrawerStateChangedEvent

Types

EventAnimationDriverMatchSpec

interface EventAnimationDriverMatchSpec

Functions

open fun canCoalesce(): Boolean

open fun coalesce(otherEvent: T): T

Given two events, coalesce them into a single event that will be sent to JS instead of two separate events.

open fun ~~dispatch~~(rctEventEmitter: RCTEventEmitter)

Dispatch this event to JS using the given event emitter.

open fun dispatchModern(rctEventEmitter: RCTModernEventEmitter)

Dispatch this event to JS using a V2 EventEmitter.

getCoalescingKey

open fun getCoalescingKey(): Short

getEventAnimationDriverMatchSpec

open fun getEventAnimationDriverMatchSpec(): Event.EventAnimationDriverMatchSpec

abstract fun getEventName(): String

fun getSurfaceId(): Int

fun getTimestampMs(): Long

open fun getUniqueID(): Int

fun getViewTag(): Int

open fun onDispose()

Called when the EventDispatcher is done with an event, either because it was dispatched or because it was coalesced with another Event.