The payload that configures notifications.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Notification Settings NotificationSettings An array of notification settings dictionaries. 1 subkey | array | required | — | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ Notification Setting NotificationSettingsItem 11 subkeys | dictionary | — | ✓Yes | iOS (9.3+)macOS (10.15+) | |
└─ └─ App Bundle Identifier BundleIdentifier The bundle identifier of the app to which to apply these notification settings.
Available in iOS 9.3 and later and macOS 10.15 and later. | string | required | — | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Enable Notifications NotificationsEnabled If `true`, enables notifications for this app.
Available in iOS 9.3 and later and macOS 10.15 and later. | boolean | optional | true | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Show in Notification Center ShowInNotificationCenter If `true`, enables notifications in the notification center for this app.
Available in iOS 9.3 and later and macOS 10.15 and later. | boolean | optional | true | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Show in Lock Screen ShowInLockScreen If `true`, enables notifications on the Lock Screen for this app.
Available in iOS 9.3 and later and macOS 10.15 and later. | boolean | optional | true | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Alert Type AlertType The type of alert for notifications for this app:
- `0`: None
- `1`: Temporary Banner
- `2`: Persistent Banner
Available in iOS 9.3 and later and macOS 10.15 and later. | integer | optional | 1 | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Badges Enabled BadgesEnabled If `true`, enables badges for this app.
Available in iOS 9.3 and later and macOS 10.15 and later. | boolean | optional | true | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Sounds Enabled SoundsEnabled If `true`, enables sounds for this app. | boolean | optional | true | ✓Yes | iOS (9.3+)macOS (10.15+) |
└─ └─ Show in CarPlay ShowInCarPlay If `true`, enables notifications in CarPlay for this app.
Available in iOS 12 and later. | boolean | optional | true | ✓Yes | iOS (12.0+) |
└─ └─ Critical Alert Enabled CriticalAlertEnabled If `true`, enables critical alerts that can ignore Do Not Disturb and ringer settings for this app.
Available in iOS 12 and later and macOS 10.15 and later. | boolean | optional | false | ✓Yes | iOS (12.0+) |
└─ └─ Grouping Type GroupingType The type of grouping for notifications for this app:
- `0`: Automatic: Group notifications into app-specified groups.
- `1`: By app: Group notifications into one group.
- `2`: Off: Don't group notifications.
Available in iOS 12 and later. | integer | optional | 0 | ✓Yes | iOS (12.0+) |
└─ └─ Preview Type PreviewType The type previews for notifications. This key overrides the value at Settings>Notifications>Show Previews.
- `0` - Always: Previews will be shown when the device is locked and unlocked
- `1` - When Unlocked: Previews will only be shown when the device is unlocked
- `2` - Never: Previews will never be shown
Available in iOS 14 and later. | integer | optional | — | ✓Yes | iOS (14.0+) |
