react-native-notify-kit

react-native-notify-kit / IOSNotificationSettings

Interface: IOSNotificationSettings

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

An interface representing the current authorization status and notification-related settings for your app.

This interface is returned from requestPermission and getNotificationSettings.

View the Observing Settings documentation to learn more.

Platform

ios

Properties

alert

alert: IOSNotificationSetting

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

Enum describing if notifications will alert the user.

announcement

announcement: IOSNotificationSetting

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

Enum describing if notifications can be announced to the user via 3rd party services such as Siri.

For example, if the notification can be automatically read by Siri while the user is wearing AirPods.

authorizationStatus

authorizationStatus: AuthorizationStatus

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

Overall notification authorization status for the application.

badge

badge: IOSNotificationSetting

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

Enum describing if notifications can update the application badge.

carPlay

carPlay: IOSNotificationSetting

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

Enum describing if notifications can be displayed in a CarPlay environment.

criticalAlert

criticalAlert: IOSNotificationSetting

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

Enum describing if critical notifications are allowed.

inAppNotificationSettings

inAppNotificationSettings: IOSNotificationSetting

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

lockScreen

lockScreen: IOSNotificationSetting

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

Enum describing if notifications will be displayed on the lock screen.

notificationCenter

notificationCenter: IOSNotificationSetting

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

Enum describing if notifications will be displayed in the notification center.

showPreviews

showPreviews: IOSShowPreviewsSetting

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

Enum describing if notification previews will be shown.

sound

sound: IOSNotificationSetting

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

Enum describing if notifications can trigger a sound.