react-native-notify-kit

react-native-notify-kit / NotificationIOS

Interface: NotificationIOS

Defined in: packages/react-native/src/types/NotificationIOS.ts:14

The interface for iOS specific options which are applied to a notification.

To learn more about iOS notifications, view the iOS documentation for full examples and usage.

Platform

ios

Properties

attachments?

optional attachments?: IOSNotificationAttachment[]

Defined in: packages/react-native/src/types/NotificationIOS.ts:23

Optional array of IOSNotificationAttachment interfaces.

Attachments allow audio, image, or video content to be displayed with the notification, enriching the user's experience.

View the Attachments documentation for more information and usage examples.

badgeCount?

optional badgeCount?: number | null

Defined in: packages/react-native/src/types/NotificationIOS.ts:28

The application badge count number. Set to null to indicate no change, or 0 to hide.

categoryId?

optional categoryId?: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:34

The id of a registered IOSCategory (via the setNotificationCategories API) that will be used to determine the appropriate actions to display for the notification.

communicationInfo?

optional communicationInfo?: IOSCommunicationInfo

Defined in: packages/react-native/src/types/NotificationIOS.ts:120

Optional property for communication notifications

Platform

ios iOS >= 15

critical?

optional critical?: boolean

Defined in: packages/react-native/src/types/NotificationIOS.ts:64

If the notification is a critical alert set this property to true; critical alerts will bypass the mute switch and also bypass Do Not Disturb.

Platform

ios iOS >= 12

criticalVolume?

optional criticalVolume?: number

Defined in: packages/react-native/src/types/NotificationIOS.ts:73

The optional audio volume of the critical sound; a float value between 0.0 and 1.0.

This property is not used unless the critical: true option is also set.

Platform

ios iOS >= 12

foregroundPresentationOptions?

optional foregroundPresentationOptions?: IOSForegroundPresentationOptions

Defined in: packages/react-native/src/types/NotificationIOS.ts:113

Optional property to customise how notifications are presented when the app is in the foreground.

By default, Notify Kit will show iOS notifications in heads-up mode if your app is currently in the foreground.

interruptionLevel?

optional interruptionLevel?: IOSNotificationInterruptionLevel

Defined in: packages/react-native/src/types/NotificationIOS.ts:56

Value that indicate the importance and delivery timing of a notification.

Platform

ios iOS >= 15

launchImageName?

optional launchImageName?: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:39

The launch image that will be used when the app is opened from this notification.

sound?

optional sound?: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:49

The name of the sound file to be played. The sound must be in the Library/Sounds folder of the app's data container or the Library/Sounds folder of an app group data container.

If the file is not found in a container, the system will look in the app's bundle.

Use 'default' to use the default system sound.

summaryArgument?

optional summaryArgument?: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:88

Kept for compatibility. No-op on supported iOS versions because notification summary arguments are ignored by iOS 15+.

Platform

ios iOS >= 12

Deprecated

May be removed in a future major release.

summaryArgumentCount?

optional summaryArgumentCount?: number

Defined in: packages/react-native/src/types/NotificationIOS.ts:97

Kept for compatibility. No-op on supported iOS versions because notification summary arguments are ignored by iOS 15+.

Platform

ios iOS >= 12

Deprecated

May be removed in a future major release.

targetContentId?

optional targetContentId?: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:106

The identifier for the window to be opened when the user taps a notification.

This value determines the window brought forward when the user taps this notification on iPadOS.

Platform

ios iOS >= 13

threadId?

optional threadId?: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:79

A unique id for the thread or conversation related to this notification. This will be used to visually group notifications together.