The documentation is currently a work in progress whilst the product is in alpha.

EventType

An enum representing an event type, defined on Event.


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

Members

ACTION_PRESS

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

APP_BLOCKED

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

CHANNEL_BLOCKED

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

CHANNEL_GROUP_BLOCKED

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

DELIVERED

Event type sent when a notification has been delivered to the device. For scheduled notifications, this event is sent at the point when the schedule executes, not when a the schedule 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

Event type is sent when the user dismisses a notification. This is triggered via the user swiping the notification from the notification shade or performing "Clear all" notifications.

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

PRESS

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.

UNKNOWN

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.


Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.