Push-Storys

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Swift Braze SDK integrieren. Sie müssen außerdem Push-Benachrichtigungen einrichten, was die Implementierung des UNNotification-Frameworks beinhaltet.

Die folgende Mindestversion des SDK ist erforderlich, um Push-Storys zu empfangen:

Einrichten von Push-Storys

1. Schritt: Hinzufügen des Ziels für die Erweiterung für Benachrichtigungsinhalte

Wählen Sie in Ihrem App-Projekt das Menü File > New > Target und fügen Sie ein neues Notification Content Extension-Ziel hinzu und aktivieren Sie es.

Xcode sollte ein neues Ziel generieren und automatisch folgende Dateien für Sie anlegen:

• NotificationViewController.swift
• MainInterface.storyboard

2. Schritt: Funktionen aktivieren

Fügen Sie in Xcode die Funktion „Hintergrundmodi“ über den Bereich Signing & Capabilities zum Hauptziel der App hinzu. Aktivieren Sie die Kontrollkästchen Background fetch und Remote notifications.

Hinzufügen einer App-Gruppe

Fügen Sie außerdem im Bereich Signing & Capabilities in Xcode die Funktion „App-Gruppen“ zu Ihrem Haupt-App-Ziel sowie zu den Zielen der Notification Content Extension hinzu. Klicken Sie dann auf die Schaltfläche +. Verwenden Sie die Bundle-ID Ihrer App, um die App-Gruppe zu erstellen. Wenn die Bundle-ID Ihrer App beispielsweise com.company.appname lautet, können Sie die App-Gruppe group.com.company.appname.xyz nennen.

Wichtig

App-Gruppen beziehen sich in diesem Zusammenhang auf die App-Gruppen-Berechtigung von Apple und nicht auf die ID Ihres Braze Workspace (früher App-Gruppe).

Wenn Sie Ihre App nicht zu einer App-Gruppe hinzufügen, kann es sein, dass Ihre App bestimmte Felder aus der Push-Nutzlast nicht ausfüllt und nicht vollständig wie erwartet funktioniert.

3. Schritt: Hinzufügen des Push-Story-Frameworks zu Ihrer App

• swift-paketmanager
• cocoapods
• manuell

Nachdem Sie den Leitfaden für die Integration des Swift-Paketmanagers befolgt haben, fügen Sie BrazePushStory zur Notification Content Extension hinzu:

Fügen Sie die folgende Zeile in Ihr Podfile ein:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
target 'YourAppTarget' do
pod 'BrazeKit'
pod 'BrazeUI'
pod 'BrazeLocation'
end

target 'YourNotificationContentExtensionTarget' do
pod 'BrazePushStory'
end

# Only include the below if you want to also integrate Rich Push
target 'YourNotificationServiceExtensionTarget' do
pod 'BrazeNotificationService'
end

Hinweis

Eine Anleitung zur Implementierung von Rich Push finden Sie unter Rich-Benachrichtigungen.

Nachdem Sie das Podfile aktualisiert haben, wechseln Sie in Ihrem Terminal in das Verzeichnis Ihres Xcode-App-Projekts und führen Sie pod install aus.

Laden Sie die neueste Version der BrazePushStory.zip von der GitHub-Release-Seite herunter, extrahieren Sie sie und fügen Sie BrazePushStory.xcframework zur Notification Content Extension Ihres Projekts hinzu.

Wichtig

Stellen Sie sicher, dass unter der Spalte Embed die Option Do Not Embed für BrazePushStory.xcframework ausgewählt ist.

4. Schritt: View-Controller für Benachrichtigungen aktualisieren

Fügen Sie in NotificationViewController.swift die folgende Zeile hinzu, um die Header-Dateien zu importieren:

1
import BrazePushStory

Ersetzen Sie als Nächstes die Standard-Implementierung durch die Vererbung von BrazePushStory.NotificationViewController:

1
class NotificationViewController: BrazePushStory.NotificationViewController {}

Benutzerdefinierte Handhabung von Push-Story-Ereignissen

Wenn Sie Ihre eigene angepasste Logik zur Verarbeitung von Push-Story-Benachrichtigungs-Events implementieren möchten, vererben Sie BrazePushStory.NotificationViewController wie oben beschrieben und überschreiben Sie die didReceive-Methoden wie folgt:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import BrazePushStory
import UserNotifications
import UserNotificationsUI

class NotificationViewController: BrazePushStory.NotificationViewController {
  override func didReceive(_ notification: UNNotification) {
    super.didReceive(notification)

    // Custom handling logic
  }

  override func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) {
    super.didReceive(response, completionHandler: completion)

    // Custom handling logic
  }
}

5. Schritt: Plist-Datei der Erweiterung für Benachrichtigungsinhalte anpassen

Öffnen Sie die Datei Info.plist der Notification Content Extension, fügen Sie dann unter NSExtension \ NSExtensionAttributes die folgenden Schlüssel hinzu und ändern Sie sie:

Fügen Sie zusätzlich das folgende Braze-Wörterbuch der obersten Ebene in dieselbe Info.plist-Datei ein und ersetzen Sie dabei REPLACE_WITH_APPGROUP durch die in Schritt 2 erstellte App-Gruppe:

Ihre Info.plist-Datei sollte dem folgenden Bild entsprechen:

6. Schritt: Braze-Integration in der Haupt-App aktualisieren

Weisen Sie vor der Initialisierung von Braze der Eigenschaft push.appGroup der Braze-Konfiguration den Namen Ihrer App-Gruppe zu.

1
2
3
4
let configuration = Braze.Configuration(apiKey: "<YOUR-BRAZE-API-KEY>",
                                        endpoint: "<YOUR-BRAZE-ENDPOINT>")
configuration.push.appGroup = "REPLACE_WITH_APPGROUP"
let braze = Braze(configuration: configuration)