CleverTap-Geofence-SDK on CocoaPods.org

👋 Introduction

CleverTap Geofence SDK provides Geofencing capabilities to CleverTap iOS SDK by using the Core Location framework. This document lists down steps to utilize CleverTap Geofence in your apps. You can further customize your integration of CleverTap Geofence by using the Geofence Customization document.

⍗ Contents

Requirements
Installation
- Via CocoaPods
- [Via Swift Package Manager](#via-Swift Package Manager)
Integration
Customization
Example Usage
Change Log
Help and Questions
License

📋 Requirements

Following are required for using CleverTap Geofence SDK -

CleverTap iOS SDK version 3.9.0 or above
Swift version 5.1 or above
iOS version 10.0 or above
Xcode 12 for targeting iOS 14.x.x
CoreLocation iOS Framework

🎉 Installation

Via CocoaPods

CocoaPods is a dependency manager for iOS projects. To integrate CleverTap Geofence SDK into your Xcode project using CocoaPods, specify the following in your Podfile:

pod 'CleverTap-Geofence-SDK'
pod 'CleverTap-iOS-SDK', :git => 'https://github.com/CleverTap/clevertap-ios-sdk.git'

You can refer to Demo Applications showcasing CocoaPods Installation.

Via Swift Package Manager

Swift Package Manager is an Xcode tool that installs project dependencies. To use it to install CleverTap Geofence SDK, follow these steps:

In Xcode, navigate to File -> Swift Package Manager -> Add Package Dependency.
Enter https://github.com/CleverTap/clevertap-geofence-ios.git when choosing package repo and Click Next.
On the next screen, Select an SDK version (by default, Xcode selects the latest stable version). Click Next.
Click Finish and ensure that the CleverTap-Geofence-SDK has been added to the appropriate target.

You can refer to Demo Applications showcasing SPM Installation.

For installing CleverTap Geofence via Carthage or Manually, check out the steps in Geofence Customization document.

🚀 Integration

CleverTap Geofence utilizes Core Location APIs to setup up Geofences Region monitoring. The CleverTap Geofence will NOT request Location permissions from the user. Location Permission has to requested by the app as deemed fit while onboarding the user to the app.

1. In Xcode, enable Location Updates in Background Modes for your App Target. You can enable this in Xcode by -

Click on your AppTarget in Xcode Project Navigator
Click on Signing & Capabilities tab
Click on + Capability button
Select the Background Modes option
Enable Location Updates by selecting the checkbox

2. In your Info.plist file, add the following keys -

NSLocationAlwaysAndWhenInUseUsageDescription also known as Privacy - Location Always and When In Use Usage Description This is a key that accepts a String description to be used by iOS while requesting Location permission from the user.
NSLocationWhenInUseUsageDescription also known as Privacy - Location When In Use Usage Description This is a key that accepts a String description to be used by iOS while requesting Location permission from the user.
UIBackgroundModes also known as Required background modes This is a key that accepts an Array of items. This should include the location also known as App registers for location updates item to enable Background Location monitoring.

For iOS 11 only: If your app targets iOS 11 then along with the above mentioned 3 Info.plist keys, the following key is also required. If your app target is iOS 12 or above, the following is not required -

NSLocationAlwaysUsageDescription also know as Privacy - Location Always Usage Description This is a key that accepts a String description to be used by iOS while requesting Location permission from the user. Only required for iOS 11.

Following is an example of all the Info.plist keys in Source Code format -

<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>App needs your location to provide enhanced features.</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>App needs your location to provide enhanced features.</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>App needs your location to provide enhanced features.</string>
<key>UIBackgroundModes</key>
<array>
  <string>location</string>
  <string>remote-notification</string>
  <string>fetch</string>
  <string>processing</string>
</array>

3. In your AppDelegate file, import the CleverTapGeofence module:

// Swift
import CleverTapGeofence

// Objective-C
@import CleverTapGeofence;

4. In your AppDelegate's application:didFinishLaunchingWithOptions: function, add the following the code snippet. Ensure that Geofence SDK initialization is done after CleverTap Main SDK initialization.

// Swift
CleverTapGeofence.monitor.start(didFinishLaunchingWithOptions: launchOptions)

// Objective-C
[[CleverTapGeofence monitor] startWithDidFinishLaunchingWithOptions:launchOptions];

5. CleverTap Geofence SDK requires location permission from users to provide the Geofencing capabilities. The App is expected to request Location permission from the user at an appropriate time. Once CleverTap Geofence SDK detects that Location permission has been given by the user, only then the module will start to perform its functions.

iOS 14 Update: If user has opted for reducedAccuracy option of the accuracyAuthorization settings then CleverTap Geofence will not work as expected since the app cannot reliably utilize Core Location's Region Monitoring APIs.

An example of how an app can request location permission is below:

// Swift
let locationManager = CLLocationManager()
locationManager.requestAlwaysAuthorization()

// Objective-C 
CLLocationManager *locationManager = [[CLLocationManager alloc] init];
[locationManager requestAlwaysAuthorization];