react-native-notify-kit

react-native-notify-kit / IOSNotificationCategory

Interface: IOSNotificationCategory

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

A interface representing a notification category created via setNotificationCategories.

At minimum, a category must be created with a unique identifier, all other properties are optional.

View the Categories documentation to learn more.

Platform

ios

Properties

actions?

optional actions?: IOSNotificationCategoryAction[]

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

allowAnnouncement?

optional allowAnnouncement?: boolean

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

Kept for compatibility. No-op on supported iOS versions because announcement category options are ignored by iOS 15+.

Defaults to false.

Deprecated

May be removed in a future major release.

allowInCarPlay?

optional allowInCarPlay?: boolean

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

Allow notifications in this category to be displayed in a CarPlay environment.

Defaults to false.

hiddenPreviewsBodyPlaceholder?

optional hiddenPreviewsBodyPlaceholder?: string

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

hiddenPreviewsShowSubtitle?

optional hiddenPreviewsShowSubtitle?: boolean

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

hiddenPreviewsShowTitle?

optional hiddenPreviewsShowTitle?: boolean

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

id

id: string

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

The unique ID for the category.

intentIdentifiers?

optional intentIdentifiers?: IOSIntentIdentifier[]

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

Intent identifiers used by the system to provide category context to Siri.

Use IOSIntentIdentifier.START_CALL for call categories. Legacy START_AUDIO_CALL and START_VIDEO_CALL values remain accepted for source compatibility, but both map to Apple's unified start call intent identifier. Categories read back from iOS can return START_CALL for call intents.

summaryFormat?

optional summaryFormat?: string

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

Specify a custom format for the summary text, which is visible when notifications are grouped together.

View the Summary Text documentation to learn more.