Zum Inhalt springen

iOS SDK 7.0+ Basis-Integrationsanleitung

Dieser Abschnitt enthält Informationen zur Integration des Pushwoosh SDK in Ihre iOS-Anwendung.

Voraussetzungen

Anchor link to

Um das Pushwoosh iOS SDK in Ihre App zu integrieren, benötigen Sie Folgendes:

Integrationsschritte

Anchor link to

1. Installation

Anchor link to

Sie können das Pushwoosh SDK entweder über den Swift Package Manager oder CocoaPods in Ihre Anwendung integrieren.

Swift Package Manager

Anchor link to

Fügen Sie im Abschnitt Package Dependencies das folgende Paket hinzu:

https://github.com/Pushwoosh/Pushwoosh-XCFramework

Um das Pushwoosh iOS SDK zu verwenden, stellen Sie sicher, dass Sie die folgenden vier Frameworks zu Ihrem App-Ziel hinzufügen, wenn Sie über den Swift Package Manager integrieren:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge
  • PushwooshLiveActivities

Öffnen Sie Ihr Podfile und fügen Sie die Abhängigkeit hinzu:

Terminal window
# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'
target 'MyApp' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
pod 'PushwooshXCFramework'
end

Führen Sie dann im Terminal den folgenden Befehl aus, um die Abhängigkeiten zu installieren:

Terminal window
pod install

2. Fähigkeiten (Capabilities)

Anchor link to

Um Push-Benachrichtigungen in Ihrem Projekt zu aktivieren, müssen Sie bestimmte Fähigkeiten (Capabilities) hinzufügen.

Fügen Sie im Abschnitt „Signing & Capabilities“ die folgenden Fähigkeiten hinzu:

  • Push Notifications
  • Background Modes. Nachdem Sie diese Fähigkeit hinzugefügt haben, aktivieren Sie das Kontrollkästchen für Remote notifications.

Wenn Sie zeitkritische Benachrichtigungen (Time Sensitive Notifications, iOS 15+) verwenden möchten, fügen Sie auch die Fähigkeit Time Sensitive Notifications hinzu.

3. Initialisierungscode

Anchor link to

AppDelegate

Anchor link to

Fügen Sie den folgenden Code zu Ihrer AppDelegate-Klasse hinzu:

import SwiftUI
import PushwooshFramework
@main
struct MyApp: App {
// Register AppDelegate as UIApplicationDelegate
@UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
var body: some Scene {
WindowGroup {
ContentView()
}
}
}
class AppDelegate: NSObject, UIApplicationDelegate, PWMessagingDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Initialization code
// Set custom delegate for push handling
Pushwoosh.configure.delegate = self
// Register for push notifications
Pushwoosh.configure.registerForPushNotifications()
return true
}
// Handle token received from APNS
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Pushwoosh.configure.handlePushRegistration(deviceToken)
}
// Handle token receiving error
func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
Pushwoosh.configure.handlePushRegistrationFailure(error)
}
//for silent push notifications
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
Pushwoosh.configure.handlePushReceived(userInfo)
completionHandler(.noData)
}
// Fired when a push is received
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) {
print("onMessageReceived: ", message.payload!.description)
}
// Fired when a user taps the notification
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageOpened message: PWMessage) {
print("onMessageOpened: ", message.payload!.description)
}
}
struct ContentView: View {
var body: some View {
Text("Pushwoosh with SwiftUI")
.padding()
}
}

Info.plist

Anchor link to

In Ihrer Info.plist:

  • setzen Sie den Schlüssel Pushwoosh_APPID auf den Pushwoosh Application Code.
  • setzen Sie den Schlüssel Pushwoosh_API_TOKEN auf das Pushwoosh Device API Token

4. Verfolgung der Nachrichtenzustellung

Anchor link to

Pushwoosh unterstützt die Verfolgung von Zustellungsereignissen für Push-Benachrichtigungen über die Notification Service Extension.

Notification Service Extension hinzufügen

Anchor link to
  1. Wählen Sie in Xcode File > New > Target…
  2. Wählen Sie Notification Service Extension und klicken Sie auf Next.
  3. Geben Sie den Zielnamen ein und klicken Sie auf Finish.
  4. Wenn Sie zur Aktivierung aufgefordert werden, klicken Sie auf Cancel.

Abhängigkeiten für die Notification Service Extension (nur CocoaPods)

Anchor link to

Hinweis: Wenn Sie den Swift Package Manager zur Verwaltung von Abhängigkeiten verwenden, können Sie diesen Schritt überspringen, da die Abhängigkeiten automatisch hinzugefügt werden.

Öffnen Sie Ihr Podfile und fügen Sie die Abhängigkeit für das Ziel hinzu:

Podfile
# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'
target 'MyApp' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
pod 'PushwooshXCFramework'
end
target 'MyAppNotificationExtension' do
use_frameworks!
pod 'PushwooshXCFramework'
end

Führen Sie den folgenden Befehl im Terminal aus, um die Abhängigkeiten zu aktualisieren:

Terminal window
pod update

Pushwoosh SDK zur Notification Service Extension hinzufügen

Anchor link to

Dieser Code ermöglicht es Ihnen, Benachrichtigungen innerhalb Ihrer Notification Extension abzufangen und zu verarbeiten.

import UserNotifications
import PushwooshFramework
class NotificationService: UNNotificationServiceExtension {
var contentHandler: ((UNNotificationContent) -> Void)?
var bestAttemptContent: UNMutableNotificationContent?
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
// Pushwoosh **********
PWNotificationExtensionManager.shared().handle(request, contentHandler: contentHandler)
// ********************
self.contentHandler = contentHandler
bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
if let bestAttemptContent = bestAttemptContent {
// Modify the notification content here...
contentHandler(bestAttemptContent)
}
}
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 = bestAttemptContent {
contentHandler(bestAttemptContent)
}
}
}

Info.plist

Anchor link to

Fügen Sie in der Info.plist Ihrer Notification Service Extension Folgendes hinzu:

  • Pushwoosh_APPID - Ihr Application Code.

5. Projekt ausführen

Anchor link to
  1. Erstellen und führen Sie das Projekt aus.
  2. Gehen Sie zum Pushwoosh Control Panel und senden Sie eine Push-Benachrichtigung.
  3. Sie sollten die Benachrichtigung in der App sehen.

Erweiterte Pushwoosh iOS-Integration

Anchor link to

In diesem Stadium haben Sie das SDK bereits integriert und können Push-Benachrichtigungen senden und empfangen. Lassen Sie uns nun die Kernfunktionalität erkunden.

Push-Benachrichtigungen

Anchor link to

Im Pushwoosh SDK gibt es zwei Callbacks, die für die Handhabung von Push-Benachrichtigungen konzipiert sind:

  • onMessageReceived: Diese Methode wird aufgerufen, wenn eine Push-Benachrichtigung empfangen wird.
  • onMessageOpened: Diese Methode wird aufgerufen, wenn der Benutzer mit der Benachrichtigung interagiert (sie öffnet).

Diese Callbacks ermöglichen es Entwicklern, den Empfang und die Benutzerinteraktion mit Push-Benachrichtigungen innerhalb ihrer Anwendungen zu verwalten.

import PushwooshFramework
class AppDelegate: NSObject, UIApplicationDelegate, PWMessagingDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
Pushwoosh.configure.delegate = self;
}
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageOpened message: PWMessage) {
if let payload = message.payload {
print("onMessageOpened: \(payload)")
}
}
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) {
if let payload = message.payload {
print("onMessageReceived: \(payload)")
}
}
}

Benutzerkonfiguration

Anchor link to

Indem Sie sich auf das individuelle Benutzerverhalten und die Vorlieben konzentrieren, können Sie personalisierte Inhalte bereitstellen, was zu einer erhöhten Benutzerzufriedenheit und -loyalität führt.

import PushwooshFramework
class Registration {
func afterUserLogin(user: User) {
let pushwoosh = Pushwoosh.configure
// set user ID
if let userId = user.userId {
pushwoosh.setUserId(userId)
}
// set user email
if let userEmail = user.email {
pushwoosh.setEmail(userEmail)
}
// set user SMS number
if let userSmsNumber = user.SmsNumber {
pushwoosh.registerSmsNumber(userSmsNumber)
}
// set user WhatsApp number
if let userWhatsAppNumber = user.WhatsAppNumber {
pushwoosh.registerSmsNumber(userWhatsAppNumber)
}
// setting additional user information as tags for Pushwoosh
if let age = user.userDetails.age,
let name = user.userDetails.userName,
let lastLogin = user.userDetails.lastLoginDate {
pushwoosh.setTags([
"age": age,
"name": name,
"last_login": lastLogin
])
}
}
}

Tags sind Schlüssel-Wert-Paare, die Benutzern oder Geräten zugewiesen werden. Sie ermöglichen eine Segmentierung basierend auf Attributen wie Vorlieben oder Verhalten und ermöglichen so gezielte Nachrichten.

import PushwooshFramework
class UpdateUser {
func afterUserUpdateProfile(user: User) {
let pushwoosh = Pushwoosh.configure
// set list of favorite categories
pushwoosh.setTags(["favorite_categories" : user.getFavoriteCategories()])
// set payment information
pushwoosh.setTags([
"is_subscribed": user.isSubscribed(),
"payment_status": user.getPaymentStatus(),
"billing_address": user.getBillingAddress()
])
}
}

Events sind spezifische Benutzeraktionen oder Vorkommnisse innerhalb der App, die verfolgt werden können, um das Verhalten zu analysieren und entsprechende Nachrichten oder Aktionen auszulösen.

import PushwooshFramework
class Registration {
func afterUserLogin(user: User) {
if let userName = user.getUserName(), let lastLogin = user.getLastLoginDate() {
PWInAppManager.shared().postEvent("login", withAttributes: [
"name": userName,
"last_login": lastLogin
])
}
}
func afterUserPurchase(user: User, product: Product) {
let pushwoosh = Pushwoosh.configure
// Track purchase event
PWInAppManager.shared().postEvent("purchase", withAttributes: [
"product_id": product.getId(),
"product_name": product.getName(),
"price": product.getPrice(),
"quantity": product.getQuantity()
])
// Set user tags
let lastPurchaseDate = Date().timeIntervalSince1970
let lifetimeSpend = getCurrentLifetimeSpend() + product.getPrice()
pushwoosh.setTags([
"last_purchase_date": lastPurchaseDate,
"lifetime_spend": lifetimeSpend
])
}
}

Rich Media

Anchor link to

Rich Media bezieht sich auf interaktive und multimediale Inhalte wie Bilder, Videos oder HTML, die in Benachrichtigungen und In-App-Nachrichten verwendet werden, um das Engagement der Benutzer zu erhöhen.

import PushwooshFramework
class ViewController: UIViewController, PWRichMediaPresentingDelegate {
override func viewDidLoad() {
super.viewDidLoad()
let richMediaConfiguration = PWModalWindowConfiguration.shared()
PWRichMediaManager.shared().delegate = self
richMediaConfiguration.configureModalWindow(with: .PWModalWindowPositionBottom,
present: .PWAnimationPresentFromBottom,
dismiss: .PWAnimationDismissDown)
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, shouldPresent richMedia: PWRichMedia!) -> Bool {
print("Rich media will be presented with: \(richMedia.pushPayload!)")
return true
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, didPresent richMedia: PWRichMedia!) {
print("Rich media has been presented with: \(richMedia.pushPayload!)")
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, didClose richMedia: PWRichMedia!) {
print("Rich media has been closed with: \(richMedia.pushPayload!)")
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, presentingDidFailFor richMedia: PWRichMedia!, withError error: (any Error)!) {
print("Failed to present rich media with: \(richMedia.pushPayload!). Error: \(error.localizedDescription)")
}
}

Fehlerbehebung

Anchor link to

Fehler beim Erstellen des Moduls ‘PushwooshFramework’

Anchor link to

Beim Erstellen Ihres Projekts kann ein Fehler auftreten, der dem folgenden ähnelt:

Failed to build module 'PushwooshFramework'; this SDK is not supported by the compiler
(the SDK is built with 'Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)',
while this compiler is 'Apple Swift version 6.1.2 effective-5.10 (swiftlang-6.1.2.1.2 clang-1700.0.13.5)')

Ursache: Dieser Fehler hängt nicht mit einer Inkompatibilität der Swift-Compiler-Version zusammen. Ab der Pushwoosh iOS SDK-Version 6.8.0 ist das SDK in mehrere Komponenten modularisiert, die miteinander interagieren. Der Fehler tritt auf, wenn nicht alle erforderlichen Frameworks zu Ihrem Projekt hinzugefügt wurden.

Lösung: Stellen Sie sicher, dass alle vier erforderlichen Frameworks zu Ihrem App-Ziel hinzugefügt werden, wenn Sie über den Swift Package Manager integrieren:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge
  • PushwooshLiveActivities

Um dies in Xcode zu überprüfen:

  1. Wählen Sie Ihr Projekt im Project Navigator aus
  2. Wählen Sie Ihr App-Ziel aus
  3. Gehen Sie zu General > Frameworks, Libraries, and Embedded Content
  4. Bestätigen Sie, dass alle vier Frameworks aufgelistet sind

Wenn Sie während des Integrationsprozesses auf Probleme stoßen, lesen Sie bitte den Abschnitt Support und Community.