[**@notifee/react-native**](react-native/reference/index)

***

[@notifee/react-native](react-native/reference/index) / NotificationIOS

# Interface: NotificationIOS

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

To learn more about iOS notifications, view the [iOS](/react-native/iOS/introduction)
documentation for full examples and usage.

## Platform

ios

## Properties

### attachments?

> `optional` **attachments**: [`IOSNotificationAttachment`](react-native/reference/Interface.IOSNotificationAttachment)\[]

Optional array of [IOSNotificationAttachment](/react-native/reference/iosnotificationattachment) interfaces.

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

View the [Attachments](/react-native/ios/appearances#attachments) documentation for more information
and usage examples.

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:23](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L23)

***

### badgeCount?

> `optional` **badgeCount**: `null` | `number`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:28](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L28)

***

### categoryId?

> `optional` **categoryId**: `string`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:34](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L34)

***

### communicationInfo?

> `optional` **communicationInfo**: [`IOSCommunicationInfo`](react-native/reference/Interface.IOSCommunicationInfo)

Optional property for communication notifications

#### Platform

ios iOS >= 15

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:125](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L125)

***

### critical?

> `optional` **critical**: `boolean`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:64](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L64)

***

### criticalVolume?

> `optional` **criticalVolume**: `number`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:73](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L73)

***

### foregroundPresentationOptions?

> `optional` **foregroundPresentationOptions**: [`IOSForegroundPresentationOptions`](react-native/reference/Interface.IOSForegroundPresentationOptions)

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

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:118](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L118)

***

### interruptionLevel?

> `optional` **interruptionLevel**: [`IOSNotificationInterruptionLevel`](react-native/reference/TypeAlias.IOSNotificationInterruptionLevel)

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

#### Platform

ios iOS >= 15

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:56](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L56)

***

### launchImageName?

> `optional` **launchImageName**: `string`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:39](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L39)

***

### sound?

> `optional` **sound**: `string`

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.

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:49](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L49)

***

### summaryArgument?

> `optional` **summaryArgument**: `string`

The argument that is inserted in the IOSCategory.summaryFormat for this notification.

See `IOSCategory.summaryFormat`.

#### Platform

ios iOS >= 12

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:88](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L88)

***

### summaryArgumentCount?

> `optional` **summaryArgumentCount**: `number`

A number that indicates how many items in the summary are being represented.

For example if a messages app sends one notification for 3 new messages in a group chat,
the summaryArgument could be the name of the group chat and the summaryArgumentCount should be 3.

If set, value cannot be 0 or less.

See `IOSCategory.summaryFormat`.

#### Platform

ios iOS >= 12

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:102](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L102)

***

### targetContentId?

> `optional` **targetContentId**: `string`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:111](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L111)

***

### threadId?

> `optional` **threadId**: `string`

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

#### Defined in

[packages/react-native/src/types/NotificationIOS.ts:79](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationIOS.ts#L79)