iOS Push Setup (APNs)

Prerequisites

Integration of SuprSend Flutter SDK
Configuring iOS vendor form in SuprSend dashboard

Example can be found in the example/ app.

Step 1: Add capabilities in iOS application

Open ios/Runner.xcworkspace, select the Runner target → Signing & Capabilities, click + Capability, and add Push Notifications.

Add Background Modes the same way, then tick Remote notifications. This lets APNs wake the app so delivery of background notifications can be tracked.

Step 2: Ask permission and register for push notification

In ios/Runner/AppDelegate.swift, set the notification center delegate, request permission, and register with APNs inside didFinishLaunchingWithOptions:

import UIKit
import Flutter
import UserNotifications
import SuprSendSwift

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)

    // Request notification permission and register for the APNs token.
    UNUserNotificationCenter.current().delegate = self
    UNUserNotificationCenter.current().requestAuthorization(
      options: [.alert, .sound, .badge]
    ) { granted, _ in
      if granted {
        DispatchQueue.main.async {
          application.registerForRemoteNotifications()
        }
      }
    }

    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

Asking user permission

The options you pass to requestAuthorization decide how the user is prompted for permission.

Explicit Authorization

This shows the system permission dialog and, once the user allows it, enables alert, sound and badge.

UNUserNotificationCenter.current().requestAuthorization(
  options: [.alert, .sound, .badge]
) { granted, _ in
  // ...
}

Explicit authorization is the default method, as it automatically sets alert, sound and badge as soon as the user allows the request.

Provisional Authorization

Supported on iOS 12+. Add .provisional to deliver notifications quietly (to Notification Center only, without an upfront prompt) until the user chooses to Keep or Turn off notifications.

UNUserNotificationCenter.current().requestAuthorization(
  options: [.alert, .sound, .badge, .provisional]
) { granted, _ in
  // ...
}

Step 3: Enable sending and tracking of push notifications

Add the following overrides to AppDelegate to hand the APNs token to SuprSend and forward notification lifecycle events, so delivery and clicks are tracked:

// APNs returned the device token — forward it to SuprSend.
override func application(
  _ application: UIApplication,
  didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
) {
  let token = deviceToken.map { String(format: "%02.2hhx", $0) }.joined()
  Task { _ = await SuprSendClient.shared.user.addiOSPush(token) }  // Send APNs token to SuprSend
  super.application(application, didRegisterForRemoteNotificationsWithDeviceToken: deviceToken)
}

// Background / silent notification delivery.
override func application(
  _ application: UIApplication,
  didReceiveRemoteNotification userInfo: [AnyHashable: Any],
  fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void
) {
  SuprSendClient.shared.push.application(
    application, didReceiveRemoteNotification: userInfo, fetchCompletionHandler: completionHandler)
  completionHandler(.newData)
}

// Notification shown while the app is in the foreground.
override func userNotificationCenter(
  _ center: UNUserNotificationCenter,
  willPresent notification: UNNotification,
  withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
) {
  SuprSendClient.shared.push.userNotificationCenter(
    center, willPresent: notification, withCompletionHandler: completionHandler)
  if #available(iOS 14.0, *) {
    completionHandler([.banner, .badge, .sound])
  } else {
    completionHandler([.alert, .badge, .sound])
  }
}

// User tapped or dismissed a notification.
override func userNotificationCenter(
  _ center: UNUserNotificationCenter,
  didReceive response: UNNotificationResponse,
  withCompletionHandler completionHandler: @escaping () -> Void
) {
  SuprSendClient.shared.push.userNotificationCenter(
    center, didReceive: response, withCompletionHandler: completionHandler)
  completionHandler()
}

The token is associated with the current user automatically and cleared on SuprSend.reset(), so notifications stop after logout.

Step 4: Adding support for Notification service

A Notification Service Extension lets APNs payloads be modified before display — for example to download and attach an image — and improves delivery tracking. Add it if you send rich (image/media) notifications.

In Xcode go to File > New > Target

Select Notification Service Extension from the template list.

Name your Notification Service

Give the target a name, e.g. NotificationService.

A folder will be created with your given product name

Xcode creates a folder containing NotificationService.swift and Info.plist.

Add the SuprSend pod and run pod install

In ios/Podfile, add a target block for the extension then run pod install from the ios/ directory:

# Notification Service Extension: links SuprSendSwift for rich (image/media) notifications.
target 'NotificationService' do
  use_frameworks!
  pod 'SuprSendSwift', '~> 1.2'
end

Replace values with your public key

Replace the generated NotificationService.swift code with the below one and add a valid public api key in place of YOUR_PUBLIC_KEY.

import UserNotifications
import SuprSendSwift

final class NotificationService: SuprSendNotificationService {
  // Must match the public key passed to SuprSend(...) in your Dart main().
  override func publicKey() -> String {
    "YOUR_PUBLIC_KEY"
  }
}

That’s it, you are all set to test your APNs push.

Developer Resources

Updates and Versioning

Authentication

Security

SDKs and APIs

Features

Testing

Monitoring and Logging

Prerequisites

Step 1: Add capabilities in iOS application

Step 2: Ask permission and register for push notification

Asking user permission

Step 3: Enable sending and tracking of push notifications

Step 4: Adding support for Notification service

​Prerequisites

​Step 1: Add capabilities in iOS application

​Step 2: Ask permission and register for push notification

​Asking user permission

​Step 3: Enable sending and tracking of push notifications

​Step 4: Adding support for Notification service

Prerequisites

Step 1: Add capabilities in iOS application

Step 2: Ask permission and register for push notification

Asking user permission

Step 3: Enable sending and tracking of push notifications

Step 4: Adding support for Notification service