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

EventDetail

An interface representing the different detail values which can be provided with a notification event.


View the Events documentation to learn more.

Properties

blocked

Android Only

The notification blocked status of your entire application.

blocked?: undefined | false | true;

The blocked detail is available when the event type is EventType.APP_BLOCKED.

channel

Android Only

The channel that had its block state changed.

channel?: NativeAndroidChannel;

Note that if the channel no longer exists during the time the event was sent the channel property will be undefined.

The channel detail is available when the event type is EventType.CHANNEL_BLOCKED.

channelGroup

Android Only

The channel group that had its block state changed.

channelGroup?: NativeAndroidChannelGroup;

Note that if the channel no longer exists during the time the event was sent the channel group property will be undefined.

The channel group detail is available when the event type is EventType.CHANNEL_GROUP_BLOCKED.

input

Android Only

The input from a notification action.

input?: undefined | string;

The input detail is available when the EventType is:

notification

The notification this event relates to.

notification?: Notification;

The notification details is available when the EventType is one of:

pressAction

The press action which triggered the event.

pressAction?: NotificationPressAction;

If a press action caused the event, this property will be available allowing you to retrieve the action ID and perform logic.

The press action details is available when the EventType is one of:


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.