iOS Rich Push Message

This feature is supported in Flutter SDK 2.23.0 and above.

To display push messages with images in an iOS app, add a Notification Service Extension and complete the configuration below.

For more details about iOS Rich Push Notifications, refer to Rich Push Notification.

1

Add Notification Service Extension to App

Open the project by opening /ios/Runner.xcworkspace in Xcode, then select File > New > Target... from the top menu and choose Notification Service Extension as shown below.

Enter an appropriate name and click Finish.

Swift Package Manager Configuration

If you are using Swift Package Manager in Flutter, add the Hackle framework to the Extension.

CocoaPods Configuration

2

Configure Minimum Deployment

If the minimum supported version differs between the app and the extension, images may not display depending on the app version.

ex) If the App minimum supported version is iOS 15 and the Extension minimum supported version is iOS 18:

• iOS 15 and above but below iOS 18: images are not displayed.

• iOS 18 and above: images are displayed.

The Notification Service Extension requires a minimum supported version separate from the app.

It is recommended to set Minimum Deployment to the same version as the app.

3

Integrate with Hackle SDK

Add Image to Push Message

Add the handleRichNotification function inside the didReceive function to handle push images.

Swift

import UserNotifications
import Hackle

class NotificationService: UNNotificationServiceExtension {

    var defaultNotificationContent: UNNotificationContent?
    var contentHandler: ((UNNotificationContent) -> Void)?

    override func didReceive(
      _ request: UNNotificationRequest,
      withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
    ) {
        self.defaultNotificationContent = request.content
        self.contentHandler = contentHandler

        if Hackle.handleRichNotification(request: request, contentHandler: contentHandler) {
            return
        }

        contentHandler(request.content)
    }

    override func serviceExtensionTimeWillExpire() {
      if let contentHandler = contentHandler,
         let defaultNotificationContent = defaultNotificationContent {
            contentHandler(defaultNotificationContent)
        }
    }
}

Objective-C