|
| 1 | +/* |
| 2 | + Modified MIT License |
| 3 | + |
| 4 | + Copyright 2025 OneSignal |
| 5 | + |
| 6 | + Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | + of this software and associated documentation files (the "Software"), to deal |
| 8 | + in the Software without restriction, including without limitation the rights |
| 9 | + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + copies of the Software, and to permit persons to whom the Software is |
| 11 | + furnished to do so, subject to the following conditions: |
| 12 | + |
| 13 | + 1. The above copyright notice and this permission notice shall be included in |
| 14 | + all copies or substantial portions of the Software. |
| 15 | + |
| 16 | + 2. All copies of substantial portions of the Software may only be used in connection |
| 17 | + with services provided by OneSignal. |
| 18 | + |
| 19 | + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 22 | + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 25 | + THE SOFTWARE. |
| 26 | + */ |
| 27 | + |
| 28 | +import OneSignalCore |
| 29 | +import OneSignalUser |
| 30 | + |
| 31 | +class OSRequestLiveActivityClicked: OneSignalRequest, OSLiveActivityRequest { |
| 32 | + override var description: String { return "(OSRequestLiveActivityClicked) key:\(key) requestSuccessful:\(requestSuccessful) activityType:\(activityType) activityId:\(activityId)" } |
| 33 | + |
| 34 | + var key: String // UUID representing this unique click |
| 35 | + var activityType: String |
| 36 | + var activityId: String |
| 37 | + var requestSuccessful: Bool |
| 38 | + var shouldForgetWhenSuccessful: Bool = true |
| 39 | + |
| 40 | + func prepareForExecution() -> Bool { |
| 41 | + guard let appId = OneSignalConfigManager.getAppId() else { |
| 42 | + OneSignalLog.onesignalLog(.LL_DEBUG, message: "Cannot generate the OSRequestLiveActivityClicked due to null app ID.") |
| 43 | + return false |
| 44 | + } |
| 45 | + |
| 46 | + guard let subscriptionId = OneSignalUserManagerImpl.sharedInstance.pushSubscriptionId else { |
| 47 | + OneSignalLog.onesignalLog(.LL_DEBUG, message: "Cannot generate the OSRequestLiveActivityClicked due to null subscription ID.") |
| 48 | + return false |
| 49 | + } |
| 50 | + |
| 51 | + // TODO: ⚠️ What is the path, method, and parameters |
| 52 | + // TODO: ⚠️ Need to guard for encoding activity strings if in path |
| 53 | + // TODO: ⚠️ Timestamp since we are caching? Same for received event. |
| 54 | + self.path = "foo/bar/\(activityId)/click" |
| 55 | + self.parameters = [ |
| 56 | + "app_id": appId, |
| 57 | + "player_id": subscriptionId, |
| 58 | + "device_type": 0, |
| 59 | + "live_activity_id": activityId, |
| 60 | + "live_activity_type": activityType, |
| 61 | + "click_id": key |
| 62 | + ] |
| 63 | + self.method = POST |
| 64 | + |
| 65 | + return true |
| 66 | + } |
| 67 | + |
| 68 | + func supersedes(_ existing: any OSLiveActivityRequest) -> Bool { |
| 69 | + return false |
| 70 | + } |
| 71 | + |
| 72 | + init(key: String, activityType: String, activityId: String) { |
| 73 | + self.key = key |
| 74 | + self.activityType = activityType |
| 75 | + self.activityId = activityId |
| 76 | + self.requestSuccessful = false |
| 77 | + super.init() |
| 78 | + } |
| 79 | + |
| 80 | + func encode(with coder: NSCoder) { |
| 81 | + coder.encode(key, forKey: "key") |
| 82 | + coder.encode(activityType, forKey: "activityType") |
| 83 | + coder.encode(activityId, forKey: "activityId") |
| 84 | + coder.encode(requestSuccessful, forKey: "requestSuccessful") |
| 85 | + coder.encode(timestamp, forKey: "timestamp") |
| 86 | + } |
| 87 | + |
| 88 | + required init?(coder: NSCoder) { |
| 89 | + guard |
| 90 | + let key = coder.decodeObject(forKey: "key") as? String, |
| 91 | + let activityType = coder.decodeObject(forKey: "activityType") as? String, |
| 92 | + let activityId = coder.decodeObject(forKey: "activityId") as? String, |
| 93 | + let timestamp = coder.decodeObject(forKey: "timestamp") as? Date |
| 94 | + else { |
| 95 | + return nil |
| 96 | + } |
| 97 | + self.key = key |
| 98 | + self.activityType = activityType |
| 99 | + self.activityId = activityId |
| 100 | + self.requestSuccessful = coder.decodeBool(forKey: "requestSuccessful") |
| 101 | + super.init() |
| 102 | + self.timestamp = timestamp |
| 103 | + } |
| 104 | +} |
0 commit comments