Fancify comments and signatures

Author: roninopf

swift-sdk/Internal/InAppDisplayer.swift

@@ -30,10 +30,10 @@ class InAppDisplayer: InAppDisplayerProtocol {
     }
 
     /**
-     Creates and shows a HTML InApp Notification with trackParameters, backgroundColor with callback handler
+     Creates and shows a HTML In-app Notification with trackParameters, backgroundColor with callback handler
 
      - parameters:
-     - htmlString:      The NSString containing the dialog HTML
+     - htmlString:      The string containing the dialog HTML
      - messageMetadata: Message metadata object.
      - backgroundAlpha: The background alpha behind the notification
      - padding:         The padding around the notification

swift-sdk/Internal/InAppHelper.swift

@@ -3,7 +3,7 @@
 //  Ported to Swift by Tapash Majumder on 6/7/18.
 //  Copyright © 2018 Iterable. All rights reserved.
 //
-// Utility Methods for inApp
+// Utility Methods for in-app
 // All classes/structs are internal.
 
 import UIKit

swift-sdk/Internal/InAppManager.swift

@@ -277,7 +277,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
         showMessage(fromMessagesProcessorResult: messagesProcessorResult)
     }
 
-    // This must be called from MainThread
+    // This must be called from Main Thread
     private func showInternal(message: IterableInAppMessage,
                               consume: Bool,
                               callback: ITBURLCallback? = nil) {
@@ -307,7 +307,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
                 // set the dismiss time
                 self.lastDismissedTime = self.dateProvider.currentDate
 
-                // check if we need to process more inApps
+                // check if we need to process more in-apps
                 self.scheduleNextInAppMessage()
 
                 if consume {

swift-sdk/Internal/InAppMessageParser.swift

@@ -20,7 +20,7 @@ struct InAppMessageParser {
         }
     }
 
-    /// Returns an array of Dictionaries holding inApp messages.
+    /// Returns an array of Dictionaries holding in-app messages.
     private static func getInAppDicts(fromPayload payload: [AnyHashable: Any]) -> [[AnyHashable: Any]] {
         return payload[JsonKey.InApp.inAppMessages] as? [[AnyHashable: Any]] ?? []
     }
@@ -100,7 +100,7 @@ struct InAppMessageParser {
         if let theCampaignId = json[JsonKey.campaignId.jsonKey] as? String {
             campaignId = theCampaignId
         } else {
-            ITBDebug("Could not find campaignId") // This is debug level because this happens a lot with proof inApps
+            ITBDebug("Could not find campaignId") // This is debug level because this happens a lot with proof in-apps
             campaignId = ""
         }
 

swift-sdk/Internal/IterableAppIntegrationInternal.swift

@@ -10,6 +10,7 @@ import UserNotifications
 // Returns whether notifications are enabled
 protocol NotificationStateProviderProtocol {
     var notificationsEnabled: Promise<Bool, Error> { get }
+    
     func registerForRemoteNotifications()
 }
 
@@ -47,7 +48,9 @@ struct SystemNotificationStateProvider: NotificationStateProviderProtocol {
 @available(iOS 10.0, *)
 public protocol NotificationResponseProtocol {
     var userInfo: [AnyHashable: Any] { get }
+    
     var actionIdentifier: String { get }
+    
     var textInputResponse: UNTextInputNotificationResponse? { get }
 }
 
@@ -72,11 +75,22 @@ struct UserNotificationResponse: NotificationResponseProtocol {
     }
 }
 
-/// Abstraction of PushTacking
+/// Abstraction of push tracking
 public protocol PushTrackerProtocol: AnyObject {
     var lastPushPayload: [AnyHashable: Any]? { get }
-    func trackPushOpen(_ userInfo: [AnyHashable: Any], dataFields: [AnyHashable: Any]?, onSuccess: OnSuccessHandler?, onFailure: OnFailureHandler?)
-    func trackPushOpen(_ campaignId: NSNumber, templateId: NSNumber?, messageId: String?, appAlreadyRunning: Bool, dataFields: [AnyHashable: Any]?, onSuccess: OnSuccessHandler?, onFailure: OnFailureHandler?)
+    
+    func trackPushOpen(_ userInfo: [AnyHashable: Any],
+                       dataFields: [AnyHashable: Any]?,
+                       onSuccess: OnSuccessHandler?,
+                       onFailure: OnFailureHandler?)
+    
+    func trackPushOpen(_ campaignId: NSNumber,
+                       templateId: NSNumber?,
+                       messageId: String?,
+                       appAlreadyRunning: Bool,
+                       dataFields: [AnyHashable: Any]?,
+                       onSuccess: OnSuccessHandler?,
+                       onFailure: OnFailureHandler?)
 }
 
 extension PushTrackerProtocol {
@@ -140,6 +154,7 @@ struct IterableAppIntegrationInternal {
      */
     func application(_ application: ApplicationStateProviderProtocol, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: ((UIBackgroundFetchResult) -> Void)?) {
         ITBInfo()
+        
         if case let NotificationInfo.silentPush(silentPush) = NotificationHelper.inspect(notification: userInfo) {
             switch silentPush.notificationType {
             case .update:
@@ -184,12 +199,15 @@ struct IterableAppIntegrationInternal {
     @available(iOS 10.0, *)
     func userNotificationCenter(_: UNUserNotificationCenter?, didReceive response: NotificationResponseProtocol, withCompletionHandler completionHandler: (() -> Void)?) {
         ITBInfo()
+        
         let userInfo = response.userInfo
+        
         // Ignore the notification if we've already processed it from launchOptions while initializing SDK
         guard !alreadyTracked(userInfo: userInfo) else {
             completionHandler?()
             return
         }
+        
         guard let itbl = IterableAppIntegrationInternal.itblValue(fromUserInfo: userInfo) else {
             completionHandler?()
             return
@@ -217,7 +235,10 @@ struct IterableAppIntegrationInternal {
     }
 
     @available(iOS 10.0, *)
-    private static func createIterableAction(actionIdentifier: String, userText: String?, userInfo: [AnyHashable: Any], iterableElement itbl: [AnyHashable: Any]) -> IterableAction? {
+    private static func createIterableAction(actionIdentifier: String,
+                                             userText: String?,
+                                             userInfo: [AnyHashable: Any],
+                                             iterableElement itbl: [AnyHashable: Any]) -> IterableAction? {
         var action: IterableAction?
 
         if actionIdentifier == UNNotificationDefaultActionIdentifier {

swift-sdk/IterableAPI.swift

@@ -360,7 +360,7 @@ import UIKit
     /**
      Tracks a custom event.
 
-     - remark: Pass in the the custom event data.
+     - remark: Pass in the custom event data.
 
      - parameter eventName:   Name of the event
      */
@@ -372,7 +372,7 @@ import UIKit
     /**
      Tracks a custom event.
 
-     - remark: Pass in the the custom event data.
+     - remark: Pass in the custom event data.
 
      - parameter eventName:   Name of the event
      - parameter dataFields:  A `Dictionary` containing any additional information to save along with the event
@@ -385,7 +385,7 @@ import UIKit
     /**
      Tracks a custom event.
 
-     - remark: Pass in the the custom event data.
+     - remark: Pass in the custom event data.
      - parameters:
      - eventName:   Name of the event
      - dataFields:  A `Dictionary` containing any additional information to save along with the event
@@ -431,7 +431,7 @@ import UIKit
     // MARK: In-App Notifications
 
     /**
-     Tracks an InAppOpen event.
+     Tracks an `InAppOpen` event.
      - parameter messageId:       The messageId of the notification
      */
 
@@ -443,7 +443,7 @@ import UIKit
     }
 
     /**
-     Tracks an InAppOpen event.
+     Tracks an `InAppOpen` event.
      Usually you don't need to call this method explicitly. IterableSDK will call this automatically.
      Call this method only if you are using a custom view controller to render IterableInAppMessages.
 
@@ -456,7 +456,7 @@ import UIKit
     }
 
     /**
-     Tracks an InAppClick event
+     Tracks an `InAppClick` event
 
      - parameter messageId:       The messageId of the notification
      - parameter buttonURL:     The url of the button that was clicked
@@ -470,7 +470,7 @@ import UIKit
     }
 
     /**
-     Tracks an InAppClick event.
+     Tracks an `InAppClick` event.
      Usually you don't need to call this method explicitly. IterableSDK will call this automatically.
      Call this method only if you are using a custom view controller to render IterableInAppMessages.
 
@@ -484,7 +484,7 @@ import UIKit
     }
 
     /**
-     Tracks an InAppClose event
+     Tracks an `InAppClose` event
      - parameter message:       The in-app message
      - parameter clickedUrl:    The url that was clicked to close the in-app. It will be `nil` when message is closed on clicking `back`.
      */
@@ -494,7 +494,7 @@ import UIKit
     }
 
     /**
-     Tracks an InAppClose event
+     Tracks an `InAppClose` event
      - parameter message:       The in-app message
      - parameter location:      The location from where this message was shown. `inbox` or `inApp`.
      - parameter clickedUrl:    The url that was clicked to close the in-app. It will be `nil` when message is closed on clicking `back`.
@@ -505,7 +505,7 @@ import UIKit
     }
 
     /**
-     Tracks an InAppClose event
+     Tracks an `InAppClose` event
      - parameter message:       The in-app message
      - parameter location:      The location from where this message was shown. `inbox` or `inApp`.
      - parameter source:        Source is `back` if back button was clicked to dismiss in-app message. Otherwise source is `link`.
@@ -517,7 +517,7 @@ import UIKit
     }
 
     /**
-     Consumes the notification and removes it from the list of inAppMessages
+     Consumes the notification and removes it from the list of in-app messages
 
      - parameter messageId:       The messageId of the notification
      */
@@ -530,7 +530,7 @@ import UIKit
     }
 
     /**
-     Consumes the notification and removes it from the list of inAppMessages
+     Consumes the notification and removes it from the list of in-app messages
 
      - parameter message:       The Iterable message that is being consumed
      - parameter location:      The location from where this message was shown. `inbox` or `inApp`.
@@ -541,7 +541,7 @@ import UIKit
     }
 
     /**
-     Consumes the notification and removes it from the list of inAppMessages
+     Consumes the notification and removes it from the list of in-app messages
 
      - parameter message:       The Iterable message that is being consumed
      - parameter location:      The location from where this message was shown. `inbox` or `inApp`.
@@ -618,17 +618,17 @@ import UIKit
         return internalImplementation?.handleUniversalLink(url) ?? false
     }
 
-    /// Use this property for getting and showing inApp Messages.
+    /// Use this property for getting and showing in-app messages.
     /// This property has no meaning if IterableAPI has not been initialized using
     /// IterableAPI.initialize
     /// ```
     /// - IterableAPI.inAppManager.getMessages()
-    /// - IterableAPI.inappManager.show(message: message, consume: true)
+    /// - IterableAPI.inAppManager.show(message: message, consume: true)
     /// ```
     public static var inAppManager: IterableInAppManagerProtocol {
         guard let internalImplementation = internalImplementation else {
-            ITBError("IterableAPI is not initialized yet. InApp will not work now.")
-            assertionFailure("IterableAPI is not initialized yet. In-app will not work now.")
+            ITBError("IterableAPI is not initialized yet. In-apps will not work now.")
+            assertionFailure("IterableAPI is not initialized yet. In-apps will not work now.")
             return EmptyInAppManager()
         }
 

swift-sdk/IterableAppIntegration.swift

@@ -18,11 +18,15 @@ import UserNotifications
      * - parameter completionHandler: Completion handler passed from the original call. Iterable will call the completion handler
      * automatically if you pass one. If you handle completionHandler in the app code, pass a nil value to this argument.
      */
-    @objc public static func application(_ application: UIApplication,
-                                         didReceiveRemoteNotification userInfo: [AnyHashable: Any],
-                                         fetchCompletionHandler completionHandler: ((UIBackgroundFetchResult) -> Void)?) {
+    @objc
+    public static func application(_ application: UIApplication,
+                                   didReceiveRemoteNotification userInfo: [AnyHashable: Any],
+                                   fetchCompletionHandler completionHandler: ((UIBackgroundFetchResult) -> Void)?) {
         ITBInfo()
-        implementation?.application(application, didReceiveRemoteNotification: userInfo, fetchCompletionHandler: completionHandler)
+        
+        implementation?.application(application,
+                                    didReceiveRemoteNotification: userInfo,
+                                    fetchCompletionHandler: completionHandler)
     }
 
     /**
@@ -35,9 +39,15 @@ import UserNotifications
      * automatically if you pass one. If you handle completionHandler in the app code, pass a nil value to this argument.
      */
     @available(iOS 10.0, *)
-    @objc(userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:) public static func userNotificationCenter(_ center: UNUserNotificationCenter?, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: (() -> Void)?) {
+    @objc(userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:)
+    public static func userNotificationCenter(_ center: UNUserNotificationCenter?,
+                                              didReceive response: UNNotificationResponse,
+                                              withCompletionHandler completionHandler: (() -> Void)?) {
         ITBInfo()
-        implementation?.userNotificationCenter(center, didReceive: UserNotificationResponse(response: response), withCompletionHandler: completionHandler)
+        
+        implementation?.userNotificationCenter(center,
+                                               didReceive: UserNotificationResponse(response: response),
+                                               withCompletionHandler: completionHandler)
     }
 
     // MARK: Private

swift-sdk/IterableConfig.swift

@@ -38,8 +38,8 @@ import Foundation
     /**
      * This method is called when new in-app message is available.
      * The default behavior is to `show` if you don't override this method.
-     * - parameter message: `IterableInAppMessage` object containing information regarding inApp to display
-     * - returns: Return `show` to show the inApp or `skip` to skip this.
+     * - parameter message: `IterableInAppMessage` object containing information regarding in-app to display
+     * - returns: Return `show` to show the in-app or `skip` to skip this.
      */
     @objc(onNewMessage:) func onNew(message: IterableInAppMessage) -> InAppShowResponse
 }
@@ -125,12 +125,12 @@ import Foundation
     /// It will log everything >= minLogLevel
     public var logDelegate: IterableLogDelegate = DefaultLogDelegate()
 
-    /// Implement this protocol to override default inApp behavior.
-    /// By default, every single inApp will be shown as soon as it is available.
-    /// If more than 1 inApp is available, we show the first.
+    /// Implement this protocol to override default in-app behavior.
+    /// By default, every single in-app will be shown as soon as it is available.
+    /// If more than 1 in-app is available, we show the first.
     public var inAppDelegate: IterableInAppDelegate = DefaultInAppDelegate()
 
-    /// How many seconds to wait before showing the next inApp, if there are more than one present
+    /// How many seconds to wait before showing the next in-app, if there are more than one present
     public var inAppDisplayInterval: Double = 30.0
 
     /// These are internal. Do not change

swift-sdk/IterableMessaging.swift

@@ -2,12 +2,13 @@
 //  Created by Tapash Majumder on 11/5/18.
 //  Copyright © 2018 Iterable. All rights reserved.
 //
-// This file contains InApp and Inbox messaging classes.
+
+// This file contains In-app and Inbox messaging classes.
 
 import Foundation
 import UIKit
 
-/// `show` to show the inApp otherwise `skip` to skip.
+/// `show` to show the in-app otherwise `skip` to skip.
 @objc public enum InAppShowResponse: Int {
     case show
     case skip
@@ -58,8 +59,8 @@ public extension Notification.Name {
 @objcMembers open class DefaultInAppDelegate: IterableInAppDelegate {
     public init() {}
 
-    /// By default, every single inApp will be shown as soon as it is available.
-    /// If more than 1 inApp is available, we show the first showable one.
+    /// By default, every single in-app will be shown as soon as it is available.
+    /// If more than 1 in-app is available, we show the first showable one.
     open func onNew(message _: IterableInAppMessage) -> InAppShowResponse {
         ITBInfo()
         return .show
@@ -83,7 +84,7 @@ public extension Notification.Name {
     public let edgeInsets: UIEdgeInsets
     /// Background alpha setting
     public let backgroundAlpha: Double
-    /// The html to display
+    /// The HTML to display
     public let html: String
 
     // Internal
@@ -111,9 +112,9 @@ public extension Notification.Name {
     }
 }
 
-/// `immediate` will try to display the inApp automatically immediately
-/// `event` is used for Push to InApp
-/// `never` will not display the inApp automatically via the SDK
+/// `immediate` will try to display the in-app automatically immediately
+/// `event` is used for Push to in-app
+/// `never` will not display the in-app automatically via the SDK
 @objc public enum IterableInAppTriggerType: Int, Codable {
     case immediate
     case event