Enumeration: EventType

An enum representing an event type, defined on Event.

View the Events documentation to learn more about foreground and background events.

Enumeration Members

ACTION_PRESS

ACTION_PRESS: 2

Event type is sent when a user presses a notification action.

APP_BLOCKED

APP_BLOCKED: 4

Event is sent when the user changes the notification blocked state for the entire application or when the user opens the application settings.

Platform

android API Level >= 28

CHANNEL_BLOCKED

CHANNEL_BLOCKED: 5

Event type is sent when the user changes the notification blocked state for a channel in the application.

Platform

android API Level >= 28

CHANNEL_GROUP_BLOCKED

CHANNEL_GROUP_BLOCKED: 6

Event type is sent when the user changes the notification blocked state for a channel group in the application.

Platform

android API Level >= 28

DELIVERED

DELIVERED: 3

Event type sent when a notification has been delivered to the device. For trigger notifications, this event is sent at the point when the trigger executes, not when a the trigger notification is created.

It's important to note even though a notification has been delivered, it may not be shown to the user. For example, they may have notifications disabled on the device/channel/app.

DISMISSED

DISMISSED: 0

Event type is sent when the user dismisses a notification. This is triggered via the user swiping the notification from the notification shade.

On Android, the event is also sent when performing "Clear all" notifications unlike on iOS.

This event is not sent when a notification is cancelled or times out.

FG_ALREADY_EXIST

FG_ALREADY_EXIST: 8

ANDROID ONLY

Event type is sent when a notification wants to start a foreground service but a foreground service is already started.

PRESS

PRESS: 1

Event type is sent when a notification has been pressed by the user.

On Android, notifications must include an android.pressAction property for this event to trigger.

On iOS, this event is always sent when the user presses a notification.

TRIGGER_NOTIFICATION_CREATED

TRIGGER_NOTIFICATION_CREATED: 7

Event type is sent when a notification trigger is created.

UNKNOWN

UNKNOWN: -1

An unknown event was received.

This event type is a failsafe to catch any unknown events from the device. Please report an issue with a reproduction so it can be correctly handled.