Sample App integrated with Narratiive SDK

This sample app shows how to integrate Narratiive App Traffic SDK into a new or existing Swift app.

Running the sample App

To run the example project, clone the repo, and run pod install first.

Add NarratiiveSDK to Your IOS App

NarratiiveSDK is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'NarratiiveSDK'

Save the Podfile and run:

pod install

This creates an .xcworkspace file for your application. Use this file for all future development on your application.

Update NarratiiveSDK

To update NarratiiveSDK to the latest version:

pod update NarratiiveSDK

If you have problem updating to the latest version. Try rm -rf Pods and then pod install.

To check the latest version:

pod search NarratiiveSDK

Initialize NarratiiveSDK for your iOS App

Now that you have the configuration file for your project, you're ready to begin implementing. First, configure the shared Analytics object inside AppDelegate. This makes it possible for your app to send data to Analytics.

To do so, import the NarratiiveSDK libruary and override the didFinishLaunchingWithOptions method to configure NarratiiveSDK:

Swift Code:

// AppDelegate.swift

import NarratiiveSDK
...

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    
    guard let sdk = NarratiiveSDK.sharedInstance() else {
      assert(false, "Narratiive SDK not configured correctly")
    }
    
    // Optional, show debug information in output
    // Remove before app release.
    sdk.debugMode = true
    // Optional, use of IDFA to identify user
    sdk.useIDFA = true
    sdk.setup(withHost: "YOUR_HOSTNAME", andHostKey: "YOUR_HOSTKEY")
    
    return true
}

Add screen tracking

Here you’ll send a named screen view to NarratiiveSDK whenever the user opens or changes screens on your app. Open a View Controller that you'd like to track, or if this is a new application, open the default view controller. Your code should do the following:

Swift Code:

// FirstViewController.swift    
import NarratiiveSDK
...

override func viewWillAppear(_ animated: Bool) {
    if let inst = NarratiiveSDK.sharedInstance() {
        inst.send(screenName: "/first-page")
    }
}

Note: The screenName is used to identify the screen view. It should follows a URL path format and be in lowercases.

About IDFA

Announced at WDDC (Worldwide Developers Conference) 2020, iOS 14 will begin requiring users to opt in for developers to access their devices’ advertising ID, or IDFA.

In versions before NarratiiveSDK v0.2.0, the SDK collects the IDFA and use it for user identification by default.

Since NarratiiveSDK v0.2.0, the SDK requires the use IDFA be explicitly enabled by setting useIDFA = true. Please refer to the above example for details.

Author

git, engineering@narratiive.com

License

This example App is available under the MIT license. See the LICENSE file for more info.