Intempt SDK for iOS

Intempt is an API-first platform for developers and marketers who are dissatisfied with high-maintenance personalizaton software. Our product is a personalization infrastructure through API and easy-to-use Console that provides a quicker way to build personalized applications. Unlike legacy personalization software we have:

An API-first SaaS platform that enables personliazation of both digital and physical human activity
A management console that helps cut down maintenance and reporting overhead
An infrastructure to scale up user activity in no time

This is a library to facilitate automatic tracking of anonymous and logged in traffic on your Objective-C or Swift app.

You can find the full API documentation on dev.intempt.com.

1 - Download SDK
2 - Check requirements
3 - Install SDK
4 - Swift guide
5 - Objective-C guide
6 - How to identify a user
7 - How to record a custom event
8 - How to track revenue
9 - Custom Events, Collections & Properties
10 - Event primer
11 - Properties primer
12 - iOS demo app

Download

Download the Intempt.framework available in this repo.

Demo

You can test the functionality of this framework with the demo app located over here.

Requirements

Minimum iOS 12.0+
Minimum Xcode 10.0+

Installation

Drag & drop the Intempt.framework into your iOS project, underneath your project's folder and NOT in the Frameworks folder (if exits).
Select Project --> General --> Frameworks, Libraries, and Embedded Content and the newly installed Intempt.framework must set to Embed & Sign. If you didn't download it, please go and download it from here.
Next go to the app's Info.plist file and add the following privacy keys.

Key	Value
Privacy - Location Always Usage Description	Location used to track where you are
Privacy - Location When In Use Usage Description	Location used to track where you are
Privacy - Location Always and When In Use Usage Description	Location used to track where you are
Privacy - Tracking Usage Description	Tracking permission is needed to for analytics

You will need to log in to Intempt App and create an iOS source.

Copy the code snippet generated and paste it just like shown in the following, whether you are using Swift or Objective-C.

If you are using iOS 14 or later then it is recommended that you should initialze root viewcontroller programtically as described below. Otherwise tracking will not work.

Swift:

If you are using Xcode 11.3 or above go to SceneDelegate.swift file and paste the copied source snippet into the scene function:

import Intempt

var window: UIWindow?

func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {  

       // Request to user for tracking permission
       requestTrackingPermission()
       guard let scene = (scene as? UIWindowScene) else { return }
       window = UIWindow(windowScene: scene)
   }
   
   func sceneWillEnterForeground(_ scene: UIScene) {
        // Called as the scene transitions from the background to the foreground.
        // Use this method to undo the changes made on entering the background.
        
        if let enabled = UserDefaults.standard.value(forKey: "TrackingEnabled") as? Bool, enabled == false {
            if #available(iOS 14, *) {
                if ATTrackingManager.trackingAuthorizationStatus == .authorized {
                    requestTrackingPermission()
                }
            }
        }
    }
   
   private func requestTrackingPermission() {
        if #available(iOS 14, *) {
            ATTrackingManager.requestTrackingAuthorization { status in
                switch status {
                    case .authorized:
                        // Tracking authorization dialog was shown
                        // and we are authorized
                        print("Tracking authorized.")
                        
                        UserDefaults.standard.set(true, forKey: "TrackingEnabled")
                        // Now that we are authorized we can get the IDFA
                        
						self.decideInitialViewController()
                        self.initializeIntemptTracking()
                    case .denied:
                        // Tracking authorization dialog was
                        // shown and permission is denied
                        print("Denied. Please turn on app tracking to enable app analytics.")
                        UserDefaults.standard.set(false, forKey: "TrackingEnabled")
                    case .notDetermined:
                        // Tracking authorization dialog has not been shown
                        print("Not determined.")
                    case .restricted:
                        print("Restricted. Please turn on app tracking to enable app analytics.")
                        UserDefaults.standard.set(false, forKey: "TrackingEnabled")
                    @unknown default:
                        print("Unknown.")
                }
            }
        }
        else {
            decideInitialViewController()
            initializeIntemptTracking()
        }
    }
   
   private func initializeIntemptTracking() {
        //Initialize Intempt SDK
        let intemptConfig = IntemptConfig(queueEnabled: true, withItemsInQueue: 0, withTimeBuffer: 7, withInitialDelay: 0.3, withInputTextCaptureDisabled: true)
        IntemptTracker.tracking(withOrgId: "Your Organization ID", withSourceId: "Your Source ID", withToken: "Your Token", withConfig: intemptConfig) { (status, result, error) in
            if(status) {
                if let dictResult = result as? [String: Any] {
                    print(dictResult)
                }
            }
            else {
                if let error = error {
                    print(error.localizedDescription)
                }
            }
        }
        IntemptClient.enableLogging()
    }
    
    func decideInitialViewController() {
        let viewController = UIStoryboard(name: "Main", bundle: nil).instantiateViewController(withIdentifier: "ViewController")
        let navigationController = UINavigationController(rootViewController: viewController)
        navigationController.isNavigationBarHidden = true
        window?.rootViewController = navigationController
        window?.makeKeyAndVisible()
    }

Else you will have the ViewController.m file and then paste the copied source snippet into the viewDidLoad function:

import Intempt
  override func viewDidLoad() {
        super.viewDidLoad()
        IntemptTracker.tracking(withOrgId: "Your Organization ID", andSourceId: "Your Source ID", andToken: "Your Token")
}

Get VisitorId From Framework

let visitorId = IntemptClient.shared()?.getVisitorId()

Identifying Visitors

Provide email or phone number.

IntemptTracker.identify("test@example.com", withProperties: nil) { (status, result, error) in 
	if(status) {
		//Do something
	}
}

Custom Event

When using this you can create a custom event based on the needs of the project and that will help you keep track of event details with that custom method.

let arrayData = [{       
                "flightId" : "1",
                "bookingDate" : "2020-05-26",
                "bookingId": "2",
                "bookingStatus" : "booked"
              }]
             
IntemptTracker.track("Online Hotel Booking", withProperties: arrHotelBooking as? [Any]) { (status, result, error) in
	if(status) {
		//Do something
	}
}

Tracking Revenue with `trackcharge`

Notice the key intempt.visit.trackcharge in the sample code above. If you use this key in the event details, the value will be recorded as revenue in the Intempt app. This allows you to assess the revenue impact of campaigns.

Collections do not need to be predefined in the Intempt app. As soon as the tracker logs an event with a new collection name, that collection of events will be available in the app.

Events, Collections, and Properties

An event is a discrete interaction that occurs on your site. Events are organized by type into collections. Events have properties, key-value pairs that record relevant information about the event.

For example, a user clicks on UIButton

It belongs to the interactions collection. (The interaction type is "Action".)
The properties including in this event like time of click, other attributes of related elements during the event action and the action event belongs to which View Controller etc all will be automatically tracked once this tracker code SDK is added in the existing application.

iOS Events

Events as recorded by the tracker code are conceptually somewhat different than events as defined in the Intempt app. On the iOS side, events will soon be renamed to actions.

Event collections are organized in a tree structure.

Profile Launch Scene Identify Interaction Custom

Because of this hierarchy, any event can be filtered or accessed based on the properties associated with something further up the tree.

For example, if you wanted to find all button clicks associated with a particular visit, you can do that.

Custom events logged manually using the Rest API appear with whatever collection name was assigned, under the custom collection.

Event Properties

Events have properties, key-value pairs the record information about the event.

Properties are grouped into two collections:

fixed — Properties that are (relatively) stable, related to the profile,launch or the scene. This includes things like device name,osVersion,app name and geolocaiton etc.

timeseries — Properties that are specific to a particular interaction. This includes element-specific details, time stamps, and anything recorded as part of custom events.

When logging a custom event, you can pass in any existing property key names, as well as define your own.

Demo iOS App

Add the framework to the application and once it launches, it will show the a permission pop-up to allow sharing your location. You will have to click on "Allow While Using App".
This enables the keys to track your location details.
In the following demo application, after running it will display a Login Screen. After clicking the login button it loads up Intempt's IdentifyVisitor function.
On every touch event the tracker will fetch event details.
After clicking on the payment button, and successfully going on with a purchase, the purchase custom event will be triggered in the application.

Intempt Proximity

Install an Intempt beacon At your preferable place.Add this SDK in your existing application. Thus it will help you to know about your entry and exit range. This sdk supports any kind of beacon that allows you to change the UUID in the vendors Beacon Manager. The UUID is a unique broadcasting number which allows Intempt to know which types of beacons to look for. You can think of it like tuning to a radio station.

Today, Intempt’s mobile SDK looks for ONE UUID by default. Use any of them with your existing beacons to enable them with Intempt.

Key Components

Intempt Proximity SDK is built on top of two key components:

Entry - when you are enter a region.
Exit - when you are exit a region.

Go to app's Info.plist file and add the privacy keys.

Key	Value
Privacy - Location Always Usage Description	Location used to track where you are
Privacy - Location When In Use Usage Description	Location used to track where you are
Privacy - Location Always and When In Use Usage Description	Location used to track where you are
Privacy - Bluetooth Always Usage Description	This app uses Bluetooth communication to detect nearby beacons
Privacy - Bluetooth Peripheral Usage Description	This app uses Bluetooth communication to detect nearby beacons

Swift:

import Intempt
  override func viewDidLoad() {
  	super.viewDidLoad()
  	IntemptTracker.beacon(withOrgId: "Your Organization ID", andSourceId: "Your Source ID", andToken: "Your Token", andDeviceUUID: "Beacon device UUID") { (success, result, error) in
  		if(success) {
		  //Do something
	    } 
    }
    IntemptClient.shared()?.delegate = self
 }

Next implement this methods:

/*Helps to detect the entry time , when application entered the monitoring region*/
func  didEnterRegion(_ beaconData: CLBeacon!) {
}

/*Helps to detect the exit time , when application exits the monitoring region*/
func  didExitRegion(_ beaconData: CLBeacon!) {
}

Identifying Visitors (Optional)

Provide email or phone number.

IntemptTracker.identifyUsingBeacon("test@example.com", withProperties: nil) { (status, result, error) in 
	if(status) {
		//Do something
	}
}

Use this method when you want to identify using beacon API separately.

das-palash-appsbee/intempt-intemptios

Intempt SDK for iOS

Contents

Download

Demo

Requirements

Installation

Swift:

Get VisitorId From Framework

Identifying Visitors

Custom Event

Tracking Revenue with `trackcharge`

Events, Collections, and Properties

iOS Events

Event Properties

Demo iOS App

Intempt Proximity

Key Components

Swift:

Identifying Visitors (Optional)

das-palash-appsbee/intempt-intemptios

Intempt SDK for iOS

Contents

Download

Demo

Requirements

Installation

Swift:

Get VisitorId From Framework

Identifying Visitors

Custom Event

Tracking Revenue with trackcharge

Events, Collections, and Properties

iOS Events

Event Properties

Demo iOS App

Intempt Proximity

Key Components

Swift:

Identifying Visitors (Optional)

Tracking Revenue with `trackcharge`