Important
Version 3.0.1 integration
The SDK now provides three simple ways to integrate push notifications:
- SwiftUI apps without AppDelegate - using
@UIApplicationDelegateAdaptor
- UIKit apps with inheritance - extend
PPGAppDelegate
- UIKit apps with existing AppDelegate - use helper methods
Key improvements:
- Simplified initialization with
PPG.initializeNotifications
- Automatic notification delegate handling
- Built-in support for all notification callbacks
SPM support
Version 2.1.0 and above support SPM. Cocoapods is no longer supported from version 2.1.0.
Requirements
- Add AppGroups capability to your project
- Create Notification Service Extension (see section below)
Tutorial: https://docs.pushpushgo.company/application/providers/mobile-push/apns
Choose one of options:
- SPM (recommended)
- Direct download
- Cocoapods (deprecated from v2.1.0)
Note
While the previous integration method (manually implementing all AppDelegate notification methods) will continue to work, we recommend switching to one of the new integration methods below. The new methods provide automatic notification handling and significantly reduce the amount of boilerplate code needed (SwiftUI).
The SDK supports three integration methods:
For SwiftUI apps that don't have a custom AppDelegate:
import SwiftUI
import PPG_framework
@main
struct YourApp: App {
@UIApplicationDelegateAdaptor(PPGAppDelegate.self) var appDelegate
init() {
// Initialize PPG
PPG.initializeNotifications(
projectId: "YOUR_PROJECT_ID",
apiToken: "YOUR_API_TOKEN",
appGroupId: "YOUR_APP_GROUP_ID"
)
}
var body: some Scene {
WindowGroup {
ContentView()
.onAppear {
// Register for notifications when the view appears
PPG.registerForNotifications(application: UIApplication.shared) { result in
switch result {
case .success:
print("Successfully registered for notifications")
case .error(let message):
print("Failed to register for notifications: \(message)")
}
}
}
}
}
}
For UIKit apps that want to inherit push notification handling:
import UIKit
import PPG_framework
@main
class AppDelegate: PPGAppDelegate {
override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
// First call super to setup PPG delegate
let result = super.application(application, didFinishLaunchingWithOptions: launchOptions)
// Initialize PPG
PPG.initializeNotifications(
projectId: "YOUR_PROJECT_ID",
apiToken: "YOUR_API_TOKEN",
appGroupId: "YOUR_APP_GROUP_ID"
)
// Register for notifications
PPG.registerForNotifications(application: application) { result in
switch result {
case .success:
print("Successfully registered for notifications")
case .error(let message):
print("Failed to register for notifications: \(message)")
}
}
// Your additional setup code
return result
}
}
For UIKit apps that already have an AppDelegate:
import UIKit
import PPG_framework
@main
class AppDelegate: NSObject, UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
// Initialize PPG
PPG.initializeNotifications(
projectId: "YOUR_PROJECT_ID",
apiToken: "YOUR_API_TOKEN",
appGroupId: "YOUR_APP_GROUP_ID"
)
// Setup PPG notification delegate
PPGUserNotificationCenterDelegateSetUp()
// Register for notifications
PPG.registerForNotifications(application: application) { result in
switch result {
case .success:
print("Successfully registered for notifications")
case .error(let message):
print("Failed to register for notifications: \(message)")
}
}
return true
}
func applicationDidBecomeActive(_ application: UIApplication) {
PPGapplicationDidBecomeActive()
}
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
PPGdidRegisterForRemoteNotificationsWithDeviceToken(deviceToken)
}
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
PPGdidReceiveRemoteNotification(userInfo, completionHandler: completionHandler)
}
}
- If PPG ios-sdk was the only library installed by Pods, run
pod deintegrate
to remove any Pods-related files. If you are using Pods for any other dependencies, then remove PPG_framework references manually. Also detach it from project and NSE targets. - Add library using SPM. Xcode -> File -> Add Package Dependency. Provide github url and choose your project target.
- Manually add library to NotificationServiceExtension target.
- Clean and rebuild the project.
- If you face any problems with derived data try running
rm -rf ~Library/Developer/Xcode/DerivedData/*
in your project directory. Then restart Xcode and clean and rebuild project.
- Click on top item in your project hierarchy.
- Select your project on target list.
- Select
Signing & Capabilities
. - You can add capability by clicking on
+ Capability
button that is placed underSigning & Capabilities
button. - Add
Background Modes
capability unless it is already on your capability list. Then selectRemote notifications
. - Add
Push notifications
capability unless it is already on your capability list. - Add
App Groups
. You can use your default app group ID or add new one. - Make sure that your
Provisioning Profile
has required capabilities. If you didn't add them while creating Provisioning Profile for your app you should go to your Apple Developer Center to add them. Then refresh your profile in Xcode project.
How to add new group to your provisioning profile?
Go to Apple developers and navigate to Certificates, Identifiers & Profiles. Then go to Identifiers and in the right corner change App IDs to AppGroups. You can add new group here.
Now you can go back to Identifiers, choose your app identifier and add AppGroup capability. Remember to check your new group.
- Open your Xcode project
- Go to
File -> New -> Target
. - Select
Notification Service Extension
. - Choose a suitable name for it (for example
PPGNotificationServiceExtension
). - Open
NotificationService.swift
file. - Change
didReceive
function to: (use dispatch_group here to make sure that extension returns only when delivery event is sent and notification content is updated) - Click on top item in your project hierarchy and select your NotificationExtension on target list
- Similarly to your project, add App Group capability to your NotificationExtension and check group you want to use.
- Also add PPG_framework to NotificationServiceExtension target (General tab) if you haven't done that yet.
- In your NotificationService extension, in didReceive function set your app group ID.
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
self.contentHandler = contentHandler
self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
guard let content = bestAttemptContent else { return }
// Wait for delivery event result & image fetch before returning from extension
let group = DispatchGroup()
group.enter()
group.enter()
// Dynamically set app group ID for your app
SharedData.shared.appGroupId = "YOUR APP GROUP ID"
PPG.notificationDelivered(notificationRequest: request) { _ in
group.leave()
}
DispatchQueue.global().async { [weak self] in
self?.bestAttemptContent = PPG.modifyNotification(content)
group.leave()
}
group.notify(queue: .main) {
contentHandler(self.bestAttemptContent ?? content)
}
}
let beacon = Beacon()
beacon.addSelector("Test_Selector", "0")
// Methods with strategy and ttl support
// For append tag in concrete category (with ttl, default = 0)
beacon.appendTag("mytag", "mycategory")
beacon.appendTag("mytag", "mycategory", 3600)
// For rewrite tag in concrete category (with ttl, default = 0)
beacon.rewriteTag("mytag", "mycategory")
beacon.rewriteTag("mytag", "mycategory", 3600)
// For delete tag in concrete category (with ttl, default = 0)
beacon.deleteTag("mytag", "mycategory");
// Legacy methods (not supports strategy append/rewrite and ttl)
beacon.addTag("new_tag", "new_tag_label")
beacon.addTagToDelete(BeaconTag(tag: "my_old_tag", label: "my_old_tag_label"))
beacon.send() { result in }
PPG.unsubscribeUser { result in ... }
The SDK supports interactive notifications with action buttons. Actions are configured through the notification payload and automatically managed by the SDK:
- Buttons are created dynamically based on the payload
- Duplicate button titles are handled automatically
- Categories expire after 7 days
- URLs can be associated with specific buttons
Button identifiers:
button_1
: First action buttonbutton_2
: Second action button
Supported button options:
foreground
: Opens the appdestructive
: Red button styleauthenticationRequired
: Requires device unlock
The SDK automatically manages:
- Category creation and registration
- Button title uniqueness
- Action handling and URL redirection
- Event tracking for button clicks