live activity: add notification ID to click event

notification ID may be nullable if the live activity is started in-app

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/LiveActivityConstants.swift

@@ -35,6 +35,7 @@ enum LiveActivityConstants {
         static let clickId = "clickId"
         static let activityId = "activityId"
         static let activityType = "activityType"
+        static let notificationId = "notificationId"
         static let redirect = "redirect"
     }
 }

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/OSLiveActivityViewExtensions.swift

@@ -89,6 +89,7 @@ private func generateTrackingDeepLink<T: OneSignalLiveActivityAttributes>(origin
     // Get activity metadata
     let activityId = context.attributes.onesignal.activityId
     let activityType = String(describing: T.self)
+    let notificationId = context.state.onesignal?.notificationId
 
     // Build OneSignal tracking URL
     var components = URLComponents()
@@ -99,7 +100,8 @@ private func generateTrackingDeepLink<T: OneSignalLiveActivityAttributes>(origin
     var queryItems = [
         URLQueryItem(name: LiveActivityConstants.Tracking.clickId, value: clickId),
         URLQueryItem(name: LiveActivityConstants.Tracking.activityId, value: activityId),
-        URLQueryItem(name: LiveActivityConstants.Tracking.activityType, value: activityType)
+        URLQueryItem(name: LiveActivityConstants.Tracking.activityType, value: activityType),
+        URLQueryItem(name: LiveActivityConstants.Tracking.notificationId, value: notificationId)
     ]
 
     if let originalURL = originalURL {

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/OneSignalLiveActivitiesManagerImpl.swift

@@ -207,7 +207,9 @@ public class OneSignalLiveActivitiesManagerImpl: NSObject, OSLiveActivities {
             return getRedirectURL()
         }
 
-        trackClick(clickId: clickId, activityType: activityType, activityId: activityId)
+        let notificationId = queryItems.first(where: { $0.name == LiveActivityConstants.Tracking.notificationId })?.value
+
+        trackClick(clickId: clickId, activityType: activityType, activityId: activityId, notificationId: notificationId)
 
         return getRedirectURL()
     }
@@ -217,9 +219,9 @@ public class OneSignalLiveActivitiesManagerImpl: NSObject, OSLiveActivities {
      - Parameters:
         - clickId: UUID representing the unique click event, as it is possible for this click to be tracked multiple times.
      */
-    private static func trackClick(clickId: String, activityType: String, activityId: String) {
+    private static func trackClick(clickId: String, activityType: String, activityId: String, notificationId: String?) {
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.LiveActivities trackClick called with clickId: \(clickId), activityType: \(activityType), activityId: \(activityId)")
-        let req = OSRequestLiveActivityClicked(key: clickId, activityType: activityType, activityId: activityId)
+        let req = OSRequestLiveActivityClicked(key: clickId, activityType: activityType, activityId: activityId, notificationId: notificationId)
         _executor.append(req)
     }
 

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/Requests/OSRequestLiveActivityClicked.swift

@@ -34,6 +34,7 @@ class OSRequestLiveActivityClicked: OneSignalRequest, OSLiveActivityRequest {
     var key: String // UUID representing this unique click
     var activityType: String
     var activityId: String
+    var notificationId: String?
     var requestSuccessful: Bool
     var shouldForgetWhenSuccessful: Bool = true
 
@@ -69,10 +70,11 @@ class OSRequestLiveActivityClicked: OneSignalRequest, OSLiveActivityRequest {
         return false
     }
 
-    init(key: String, activityType: String, activityId: String) {
+    init(key: String, activityType: String, activityId: String, notificationId: String?) {
         self.key = key
         self.activityType = activityType
         self.activityId = activityId
+        self.notificationId = notificationId
         self.requestSuccessful = false
         super.init()
     }
@@ -81,6 +83,7 @@ class OSRequestLiveActivityClicked: OneSignalRequest, OSLiveActivityRequest {
         coder.encode(key, forKey: "key")
         coder.encode(activityType, forKey: "activityType")
         coder.encode(activityId, forKey: "activityId")
+        coder.encode(notificationId, forKey: "notificationId")
         coder.encode(requestSuccessful, forKey: "requestSuccessful")
         coder.encode(timestamp, forKey: "timestamp")
     }
@@ -97,6 +100,7 @@ class OSRequestLiveActivityClicked: OneSignalRequest, OSLiveActivityRequest {
         self.key = key
         self.activityType = activityType
         self.activityId = activityId
+        self.notificationId = coder.decodeObject(forKey: "notificationId") as? String
         self.requestSuccessful = coder.decodeBool(forKey: "requestSuccessful")
         super.init()
         self.timestamp = timestamp