Step-by-step guide to setup APNS iOSpush notifications in your flutter app.
Starting from iOS version v1.0.0, we have introduced explicit push notification permission and option to add images in your notification. Also, introduced background mode for improved tracking of notification delivery.If you are using an iOS version older than v1.0.0 and upgrading to the new version. Please ensure to use the latest integration steps, especially for below methods:
Click on +capabilities and select Push Notifications and Background Modes
In Background Modes, select Remote Notifications option. We use background notifications to receive delivery reports when your app is in quit and background state. Refer doc to know more about background notification
Step 2: Register for push notification in AppDelegate.swift file
Call registerForPushNotifications method below the SuprSend SDK initialized code which will register the iOS device for push service
Copy
Ask AI
SuprSend.shared.configureWith(configuration: suprSendConfiguration , launchOptions: launchOptions) // init code which is already added at time of initialisationvar options: UNAuthorizationOptions = [.badge, .alert, .sound] // Add thisSuprSend.shared.registerForPushNotifications(options: options) // Add this
Explicit authorization allows you to display alerts, add a badge to the app icon, or play sounds whenever a notification is delivered. In this type of authorization, the request is made the first time user launches your app. If the user denies the request, you can’t send subsequent prompts to send the notification.
Explicit authorization is default authorization method as it automatically sets alert, sound and badge as soon as the user allows this request.
Provisional Authorization (Supported in iOS 12.0 and above) are sent quietly to the users —they don’t interrupt the user with a sound or banner. Also, they will not be shown when your app is in foreground. First time this type of notifications are sent, user is asked to “Keep” or “Turn off” the notifications. Further notifications continue to be sent if they click on “Keep”.Add below code in AppDelegate.swift file for provisional authorization.
Copy
Ask AI
SuprSend.shared.configureWith(configuration: suprSendConfiguration , launchOptions: launchOptions) // init code which is already added at time of initialisationvar options: UNAuthorizationOptions = [.badge, .alert, .sound, .provisional] // Add thisSuprSend.shared.registerForPushNotifications(options: options) // Add this
Step 4: Enable sending and tracking of push notifications
Receiving iOS APNS token sending to backend and listening for push notification and tracking user notification clicks can be done using the following snippet of code. Directly copy and paste it at end of the AppDelegate.swift file inside AppDelegate class.
iOS Push notifications only work on real devices so while developing/testing use real device to test it instead of simulators. From Xcode-15 push support can be tested in simulators as well.
For better notification status (delivered, seen) tracking this step is needed.
1
In Xcode go to File > New > Target
2
Select Notification Service Extension from the template list
3
Name your Notification Service
Then in Next popup give a suitable name to your notification service, select your team, select swift language and click finish.
4
A folder will be created with your given product name.
After clicking on Finish, a folder will be created with your given product name. Inside that there will be NotificationService.swift file like below.
5
Rename and Run the pod install
In your project podFile add following snippet. Replace <your notification service name> with the name given in step 3. After that, run pod install.
Copy
Ask AI
target '<your notification service name>' do use_frameworks! pod 'SuprsendCore' pod 'SuprSendSdk'end
6
Replace values with your Workspace Key and Workspace Secret.
Replace the content in NotificationService.swift file with below code. In this snippet on line 11, 12 replace values with your workspace key and workspace secret.
Copy
Ask AI
import UserNotificationsimport UIKitimport SuprSendSdkclass NotificationService: UNNotificationServiceExtension {var contentHandler: ((UNNotificationContent) -> Void)?var modifiedNotificationContent: UNMutableNotificationContent?private func track(request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) { let suprSendConfiguration = SuprSendSDKConfiguration( withKey: "your workspace key", secret: "your workspace secret" ) SuprSend.shared.configureWith(configuration: suprSendConfiguration , launchOptions: [:]) SuprSend.shared.didReceive(request, withContentHandler: contentHandler) }override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) { self.contentHandler = contentHandler modifiedNotificationContent = (request.content.mutableCopy() as? UNMutableNotificationContent) track(request: request, withContentHandler: contentHandler) if let modifiedNotificationContent = modifiedNotificationContent { // Modify the notification content here... // 1 guard let imageURLString = modifiedNotificationContent.userInfo["image_url"] as? String else { contentHandler(modifiedNotificationContent) return } getMediaAttachment(for: imageURLString) { [weak self] image in guard let self = self, let image = image, let fileURL = self.saveImageAttachment( image: image, forIdentifier: "attachment.png") else { contentHandler(modifiedNotificationContent) return } let imageAttachment = try? UNNotificationAttachment( identifier: "image", url: fileURL, options: nil) if let imageAttachment = imageAttachment { modifiedNotificationContent.attachments = [imageAttachment] } contentHandler(modifiedNotificationContent) } }}override func serviceExtensionTimeWillExpire() { // Called just before the extension will be terminated by the system. // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used. if let contentHandler = contentHandler, let bestAttemptContent = modifiedNotificationContent { contentHandler(bestAttemptContent) }}}extension NotificationService {private func saveImageAttachment(image: UIImage, forIdentifier identifier: String) -> URL? { let tempDirectory = URL(fileURLWithPath: NSTemporaryDirectory()) let directoryPath = tempDirectory.appendingPathComponent( ProcessInfo.processInfo.globallyUniqueString, isDirectory: true) do { try FileManager.default.createDirectory( at: directoryPath, withIntermediateDirectories: true, attributes: nil) let fileURL = directoryPath.appendingPathComponent(identifier) guard let imageData = image.pngData() else { return nil } try imageData.write(to: fileURL) return fileURL } catch { return nil }}private func getMediaAttachment(for urlString: String, completion: @escaping (UIImage?) -> Void) { // 1 guard let url = URL(string: urlString) else { completion(nil) return } let task = URLSession.shared.dataTask(with: url) { data, response, error in if error != nil { completion(nil) return } guard let data = data else { completion(nil) return } guard let image = UIImage(data: data) else { completion(nil) return } completion(image) } task.resume()}}
7
Final Step
Runner Target inside Build Phases, drag Embedded Foundation Extensions section and drop it below theCopy Bundle Resources section like in image.You are now all set to send push notifications. All you have to do is add iOS vendor configuration on SuprSend dashboard and your push notifications will be configured. Please refer vendor integration guide to integrate your apns push service.