react-native-notify-kit

react-native-notify-kit / EventDetail

Interface: EventDetail

Defined in: packages/react-native/src/types/Notification.ts:392

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

View the Events documentation to learn more.

Properties

blocked?

optional blocked: boolean

Defined in: packages/react-native/src/types/Notification.ts:461

The notification blocked status of your entire application.

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

Platform

android API Level >= 28

channel?

optional channel: NativeAndroidChannel

Defined in: packages/react-native/src/types/Notification.ts:441

The channel that had its block state changed.

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.

Platform

android API Level >= 28

channelGroup?

optional channelGroup: NativeAndroidChannelGroup

Defined in: packages/react-native/src/types/Notification.ts:452

The channel group that had its block state changed.

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.

Platform

android API Level >= 28

input?

optional input: string

Defined in: packages/react-native/src/types/Notification.ts:430

The input from a notification action.

The input detail is available when the EventType is:

• EventType.ACTION_PRESS
• The notification quick action has input enabled. View AndroidInput for more details.

Platform

android API Level >= 20

notification?

optional notification: Notification

Defined in: packages/react-native/src/types/Notification.ts:405

The notification this event relates to.

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

• EventType.DISMISSED
• EventType.PRESS
• EventType.ACTION_PRESS
• EventType.DELIVERED
• EventType.TRIGGER_NOTIFICATION_CREATED
• EventType.FG_ALREADY_EXIST

pressAction?

optional pressAction: NotificationPressAction

Defined in: packages/react-native/src/types/Notification.ts:418

The press action which triggered the event.

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:

• EventType.PRESS
• EventType.ACTION_PRESS