Rename extraInfo to customPayload

Author: tapashmajumder

Tests/swift-sdk-swift-tests/InAppHelperTests.swift

@@ -224,17 +224,17 @@ class InAppHelperTests: XCTestCase {
         wait(for: [expectation1], timeout: testExpectationTimeout)
     }
 
-    func testExtraInfoParsing() {
+    func testCustomPayloadParsing() {
         IterableAPI.initializeForTesting()
 
-        let extraInfo: [AnyHashable : Any] = ["string1" : "value1", "bool1" : true, "date1" : Date()]
+        let customPayload: [AnyHashable : Any] = ["string1" : "value1", "bool1" : true, "date1" : Date()]
 
-        let payload = createInAppPayload(withExtraInfo: extraInfo)
+        let payload = createInAppPayload(withCustomPayload: customPayload)
 
         let messages = InAppHelper.inAppMessages(fromPayload: payload, internalApi: IterableAPI.internalImplementation!)
 
         XCTAssertEqual(messages.count, 1)
-        let obtained = messages[0].extraInfo
+        let obtained = messages[0].customPayload
         XCTAssertEqual(obtained?["string1"] as? String, "value1")
         XCTAssertEqual(obtained?["bool1"] as? Bool, true)
     }
@@ -394,11 +394,11 @@ class InAppHelperTests: XCTestCase {
         let message1 = messages[0]
         XCTAssertEqual(message1.messageId, "messageId1")
         XCTAssertEqual(message1.inAppType, .default)
-        XCTAssertTrue(TestUtils.areEqual(dict1: message1.extraInfo!, dict2: customPayloadStr1.toJsonDict()))
+        XCTAssertTrue(TestUtils.areEqual(dict1: message1.customPayload!, dict2: customPayloadStr1.toJsonDict()))
 
         let message2 = messages[1]
         XCTAssertEqual(message2.inAppType, .inBox)
-        XCTAssertTrue(TestUtils.areEqual(dict1: message2.extraInfo!, dict2: customPayloadStr2.toJsonDict()))
+        XCTAssertTrue(TestUtils.areEqual(dict1: message2.customPayload!, dict2: customPayloadStr2.toJsonDict()))
 
         let message3 = messages[2]
         XCTAssertEqual(message3.inAppType, .default)
@@ -490,11 +490,11 @@ class InAppHelperTests: XCTestCase {
         XCTAssertEqual(messages.count, 4)
         let message1 = messages[0]
         XCTAssertEqual(message1.inAppType, .default)
-        XCTAssertTrue(TestUtils.areEqual(dict1: message1.extraInfo!, dict2: customPayloadStr1.toJsonDict()))
+        XCTAssertTrue(TestUtils.areEqual(dict1: message1.customPayload!, dict2: customPayloadStr1.toJsonDict()))
 
         let message2 = messages[1]
         XCTAssertEqual(message2.inAppType, .inBox)
-        XCTAssertTrue(TestUtils.areEqual(dict1: message2.extraInfo!, dict2: customPayloadStr2.toJsonDict()))
+        XCTAssertTrue(TestUtils.areEqual(dict1: message2.customPayload!, dict2: customPayloadStr2.toJsonDict()))
 
         let message3 = messages[2]
         XCTAssertEqual(message3.inAppType, .default)
@@ -503,7 +503,7 @@ class InAppHelperTests: XCTestCase {
         XCTAssertEqual(message4.inAppType, .default)
     }
 
-    private func createInAppPayload(withExtraInfo extraInfo: [AnyHashable : Any]) -> [AnyHashable : Any] {
+    private func createInAppPayload(withCustomPayload customPayload: [AnyHashable : Any]) -> [AnyHashable : Any] {
         return [
             "inAppMessages" : [[
                 "content" : [
@@ -512,7 +512,7 @@ class InAppHelperTests: XCTestCase {
                 ],
                 "messageId" : "messageIdxxx",
                 "campaignId" : "campaignIdxxx",
-                "customPayload" : extraInfo
+                "customPayload" : customPayload
             ]]
         ]
     }

swift-sdk/Internal/InAppHelper.swift

@@ -312,7 +312,7 @@ struct InAppHelper {
         let campaignId: String
         let trigger: IterableInAppTrigger
         let expiresAt: Date?
-        let extraInfo: [AnyHashable : Any]?
+        let customPayload: [AnyHashable : Any]?
     }
 
     /// Returns an array of Dictionaries holding inApp messages.
@@ -393,7 +393,7 @@ struct InAppHelper {
             campaignId = ""
         }
 
-        let extraInfo = parseCustomPayload(fromPayload: dict)
+        let customPayload = parseCustomPayload(fromPayload: dict)
 
         let trigger = parseTrigger(fromTriggerElement: dict[.ITBL_IN_APP_TRIGGER] as? [AnyHashable : Any])
         let expiresAt = parseExpiresAt(dict: dict)
@@ -405,7 +405,7 @@ struct InAppHelper {
             campaignId: campaignId,
             trigger: trigger,
             expiresAt: expiresAt,
-            extraInfo: extraInfo))
+            customPayload: customPayload))
     }
 
     private static func parseExpiresAt(dict: [AnyHashable : Any]) -> Date? {
@@ -438,7 +438,7 @@ struct InAppHelper {
                                         trigger: inAppDetails.trigger,
                                         expiresAt: inAppDetails.expiresAt,
                                         content: inAppDetails.content,
-                                        extraInfo: inAppDetails.extraInfo)
+                                        customPayload: inAppDetails.customPayload)
         case .failure(reason: let reason, messageId: let messageId):
             ITBError(reason)
             if let messageId = messageId {

swift-sdk/Internal/InAppPersistence.swift

@@ -179,7 +179,7 @@ extension IterableInAppMessage : Codable {
         case trigger
         case expiresAt
         case content
-        case extraInfo
+        case customPayload
         case processed
         case consumed
     }
@@ -200,16 +200,16 @@ extension IterableInAppMessage : Codable {
         let trigger = (try? container.decode(IterableInAppTrigger.self, forKey: .trigger)) ?? .undefinedTrigger
         let expiresAt = (try? container.decode(Date.self, forKey: .expiresAt))
         let content = IterableInAppMessage.decodeContent(from: container)
-        let extraInfoData = try? container.decode(Data.self, forKey: .extraInfo)
-        let extraInfo = IterableInAppMessage.deserializeExtraInfo(withData: extraInfoData)
+        let customPayloadData = try? container.decode(Data.self, forKey: .customPayload)
+        let customPayload = IterableInAppMessage.deserializeCustomPayload(withData: customPayloadData)
 
         self.init(messageId: messageId,
                   campaignId: campaignId,
                   inAppType: inAppType,
                   trigger: trigger,
                   expiresAt: expiresAt,
                   content: content,
-                  extraInfo: extraInfo)
+                  customPayload: customPayload)
 
         self.processed = (try? container.decode(Bool.self, forKey: .processed)) ?? false
         self.consumed = (try? container.decode(Bool.self, forKey: .consumed)) ?? false
@@ -248,7 +248,7 @@ extension IterableInAppMessage : Codable {
         try? container.encode(trigger, forKey: .trigger)
         try? container.encode(expiresAt, forKey: .expiresAt)
         IterableInAppMessage.encode(content: content, inContainer: &container)
-        try? container.encode(IterableInAppMessage.serialize(extraInfo: extraInfo), forKey: .extraInfo)
+        try? container.encode(IterableInAppMessage.serialize(customPayload: customPayload), forKey: .customPayload)
         try? container.encode(processed, forKey: .processed)
         try? container.encode(consumed, forKey: .consumed)
 
@@ -267,15 +267,15 @@ extension IterableInAppMessage : Codable {
         }
     }
 
-    private static func serialize(extraInfo: [AnyHashable : Any]?) -> Data? {
-        guard let extraInfo = extraInfo else {
+    private static func serialize(customPayload: [AnyHashable : Any]?) -> Data? {
+        guard let customPayload = customPayload else {
             return nil
         }
 
-        return try? JSONSerialization.data(withJSONObject: extraInfo, options: [])
+        return try? JSONSerialization.data(withJSONObject: customPayload, options: [])
     }
 
-    private static func deserializeExtraInfo(withData data: Data?) -> [AnyHashable : Any]? {
+    private static func deserializeCustomPayload(withData data: Data?) -> [AnyHashable : Any]? {
         guard let data = data else {
             return nil
         }

swift-sdk/IterableInApp.swift

@@ -133,8 +133,8 @@ public final class IterableInAppMessage : NSObject {
     /// The content of the inApp message
     public let content: IterableInAppContent
 
-    /// Extra Information from the 'payload' section of message.
-    public let extraInfo: [AnyHashable : Any]?
+    /// Custom Payload for this message.
+    public let customPayload: [AnyHashable : Any]?
 
     /// Whether we have processed this message.
     /// Note: This is internal and not public
@@ -152,15 +152,15 @@ public final class IterableInAppMessage : NSObject {
         trigger: IterableInAppTrigger = .defaultTrigger,
         expiresAt: Date? = nil,
         content: IterableInAppContent,
-        extraInfo: [AnyHashable : Any]? = nil
+        customPayload: [AnyHashable : Any]? = nil
         ) {
         self.messageId = messageId
         self.campaignId = campaignId
         self.inAppType = inAppType
         self.trigger = trigger
         self.expiresAt = expiresAt
         self.content = content
-        self.extraInfo = extraInfo
+        self.customPayload = customPayload
     }
 }