<!--
{
  "availability" : [
    "iOS: 8.0.0 -",
    "iPadOS: 8.0.0 -",
    "macCatalyst: 13.1.0 -",
    "macOS: 10.10.0 -",
    "tvOS: -",
    "visionOS: 1.0.0 -",
    "watchOS: 6.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "CloudKit",
  "identifier" : "/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "CloudKit"
    ],
    "preciseIdentifier" : "c:objc(cs)CKNotificationInfo"
  },
  "title" : "CKSubscription.NotificationInfo"
}
-->

# CKSubscription.NotificationInfo

An object that describes the configuration of a subscription’s push notifications.

```
class NotificationInfo
```

## Overview

When configuring a subscription, use this class to specify the type of push notifications you want to generate when conditions meet the subscription’s trigger. You can provide content that the system displays to the user, describe the sounds to play, and indicate whether the app’s icon has a badge. You can request that the notification include information about the record that triggers it.

When your app receives a push notification that a subscription generates, instantiate an instance of [`CKNotification`](/documentation/CloudKit/CKNotification) using the [`init(fromRemoteNotificationDictionary:)`](/documentation/CloudKit/CKNotification/init(fromRemoteNotificationDictionary:)) method and pass the notification’s payload. The object that the method returns contains the data you specify when configuring the subscription.

For more information about push notification alerts and how they display to the user, see [Apple Push Notification Service](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html#//apple_ref/doc/uid/TP40008194-CH100) in [Local and Remote Notification Programming Guide](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/index.html#//apple_ref/doc/uid/TP40008194).

> Note: If you don’t set any of the ``doc://com.apple.cloudkit/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/alertBody``, ``doc://com.apple.cloudkit/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/soundName``, or ``doc://com.apple.cloudkit/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/shouldBadge`` properties, CloudKit sends the push notification using a lower priority and doesn’t display any content to the user.

## Topics

### Creating Notification Information

[`init(alertBody:alertLocalizationKey:alertLocalizationArgs:title:titleLocalizationKey:titleLocalizationArgs:subtitle:subtitleLocalizationKey:subtitleLocalizationArgs:alertActionLocalizationKey:alertLaunchImage:soundName:desiredKeys:shouldBadge:shouldSendContentAvailable:shouldSendMutableContent:category:collapseIDKey:)`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/init(alertBody:alertLocalizationKey:alertLocalizationArgs:title:titleLocalizationKey:titleLocalizationArgs:subtitle:subtitleLocalizationKey:subtitleLocalizationArgs:alertActionLocalizationKey:alertLaunchImage:soundName:desiredKeys:shouldBadge:shouldSendContentAvailable:shouldSendMutableContent:category:collapseIDKey:))

Creates a notification with the specified values.

### Grouping Notifications

[`category`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/category)

The name of the action group that corresponds to this notification.

[`collapseIDKey`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/collapseIDKey)

A value that the system uses to coalesce unseen push notifications.

### Displaying Badges

[`shouldBadge`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/shouldBadge)

A Boolean value that determines whether an app’s icon badge increments its value.

### Accessing the Notification Alert

[`alertBody`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/alertBody)

The text for the notification’s alert.

[`alertLocalizationKey`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/alertLocalizationKey)

The key that identifies the localized string for the notification’s alert.

[`alertLocalizationArgs`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/alertLocalizationArgs)

The fields for building a notification’s alert.

[`alertLocalizationArgs`](/documentation/CloudKit/CKNotificationInfo/alertLocalizationArgs)

The fields for building a notification’s alert.

[`alertActionLocalizationKey`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/alertActionLocalizationKey)

The key that identifies the localized string for the notification’s action.

[`alertLaunchImage`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/alertLaunchImage)

The filename of an image to use as a launch image.

[`soundName`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/soundName)

The filename of the sound file to play when a notification arrives.

### Accessing the Notification Info

[`shouldSendContentAvailable`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/shouldSendContentAvailable)

A Boolean value that indicates whether the push notification includes the content available flag.

[`shouldSendMutableContent`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/shouldSendMutableContent)

A Boolean value that indicates whether the push notification sets the mutable content flag.

### Accessing the Record’s Data

[`desiredKeys`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/desiredKeys)

The names of fields to include in the push notification’s payload.

[`desiredKeys`](/documentation/CloudKit/CKNotificationInfo/desiredKeys)

The names of fields to include in the push notification’s payload.

### Accessing the Notification Title

[`title`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/title)

The notification’s title.

[`titleLocalizationKey`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/titleLocalizationKey)

The key that identifies the localized string for the notification’s title.

[`titleLocalizationArgs`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/titleLocalizationArgs)

The fields for building a notification’s title.

[`titleLocalizationArgs`](/documentation/CloudKit/CKNotificationInfo/titleLocalizationArgs)

The fields for building a notification’s title.

### Accessing the Notification Subtitle

[`subtitle`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/subtitle)

The notification’s subtitle.

[`subtitleLocalizationKey`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/subtitleLocalizationKey)

The key that identifies the localized string for the notification’s subtitle.

[`subtitleLocalizationArgs`](/documentation/CloudKit/CKSubscription/NotificationInfo-swift.class/subtitleLocalizationArgs)

The fields for building a notification’s subtitle.

[`subtitleLocalizationArgs`](/documentation/CloudKit/CKNotificationInfo/subtitleLocalizationArgs)

The fields for building a notification’s subtitle.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)