Skip to main content

iOS SDK

The Radar SDK abstracts away cross-platform differences between location services, allowing you to add geofencing, location tracking, trip tracking, geocoding, and search to your apps with just a few lines of code.

Learn how to integrate the iOS SDK below. You can also see the source and a detailed SDK reference on GitHub.

Install SDK#

The best way to install the SDK is via CocoaPods or Carthage.

The SDK is small and typically adds less than 500 KB to your compiled app.

CocoaPods#

Install CocoaPods. If you don't have an existing Podfile, run pod init in your project directory. Add the following to your Podfile:

pod 'RadarSDK', '~> 3.10.1'

Then, run pod install. You may also need to run pod repo update.

Swift Package Manager#

In Xcode, go to File > Swift Packages > Add Package Dependency. Enter https://github.com/radarlabs/radar-sdk-ios.git for the Package Repository URL.

Carthage#

Install Carthage. To include Radar as a github origin, add the following to your Cartfile:

github "radarlabs/radar-sdk-ios" ~> 3.10.1

To include Radar as a binary origin, add the following to your Cartfile:

binary "https://raw.githubusercontent.com/radarlabs/radar-sdk-ios/master/RadarSDK.json" ~> 3.10.1

Then, run carthage update and drag Build/iOS/RadarSDK.framework into the Linked Frameworks and Libraries section of your target. Do not add the framework as an input to your copy-frameworks run script.

Add manually#

You can also add the SDK to your project manually. Download the current release, unzip the package, and drag RadarSDK.xcframework into your Xcode project. It will automatically appear in the Frameworks, Libraries, and Embedded Content section of your target settings. Switch Do Not Embed to Embed & Sign.

Dependencies#

The SDK depends on Apple's CoreLocation framework. In your target settings, go to General > Frameworks, Libraries, and Embedded Content and add CoreLocation if you haven't already.

The SDK currently supports iOS 10 and higher.

Initialize SDK#

When your app starts, initialize the SDK with your publishable API key, found on the Settings page.

Use your Test Publishable key for testing and non-production environments. Use your Live Publishable key for production environments.

import UIKitimport RadarSDK
@UIApplicationMainclass AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {        Radar.initialize(publishableKey: "prj_test_pk_...")
        return true    }
}

Request permissions#

Radar respects standard iOS location permissions.

For foreground tracking or trip tracking with continuous mode, the app's location authorization status must be or. For background tracking or geofencing with responsive mode, the app's location authorization status must be .

Before requesting permissions, you must add location usage strings to your Info.plist file. For foreground permissions, you must add a value for NSLocationWhenInUseUsageDescription (Privacy - Location When In Use Usage Description). For background permissions, you must add a value for NSLocationAlwaysAndWhenInUseUsageDescription (Privacy - Location Always and When In Use Usage Description). These strings are displayed in permissions prompts.

To request foreground permissions, call on a CLLocationManager instance. To request background permissions in the app, make sure the user has granted foreground permissions first, then call on a CLLocationManager instance.

To request foreground location permissions and then immediately request background location permissions:

import UIKitimport RadarSDKimport CoreLocation
@UIApplicationMainclass AppDelegate: UIResponder, UIApplicationDelegate, CLLocationManagerDelegate {
    let locationManager = CLLocationManager()
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {        Radar.initialize(publishableKey: "prj_test_pk_...")        self.locationManager.delegate = self        self.requestLocationPermissions()
        return true    }
    func locationManager(_ manager: CLLocationManager, didChangeAuthorization status: CLAuthorizationStatus) {        self.requestLocationPermissions()    }
    func requestLocationPermissions() {        let status = self.locationManager.authorizationStatus
        if status == .notDetermined {            self.locationManager.requestWhenInUseAuthorization()        } else if status == .authorizedWhenInUse {            self.locationManager.requestAlwaysAuthorization()        }    }
}

Background modes#

If you are planning to use RadarTrackingOptions.presetContinuous or RadarTrackingOptions.presetResponsive, or if you are planning to range beacons by UUID only, you must enable the Location updates and Background fetch background modes.

In your project settings, go to Signing & Capabilities, add Background Modes, and turn on Location updates and Background fetch.

Note that this requires additional justification during App Store review. Learn more below.

Foreground tracking#

Once the user has granted foreground permissions, you can track the user's location in the foreground.

To track the user's location once in the foreground, call:

Radar.trackOnce { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in    // do something with location, events, user}

You may provide an optional completionHandler that receives the request status, the user's location, the events generated, if any, and the user. The request status can be:

  • : success
  • : SDK not initialized
  • : location permissions not granted
  • : location services error or timeout (10 seconds)
  • : network error or timeout (10 seconds)
  • : bad request (missing or invalid params)
  • : unauthorized (invalid API key)
  • : payment required (organization disabled or usage exceeded)
  • : forbidden (insufficient permissions)
  • : not found
  • : too many requests (rate limit exceeded)
  • : internal server error
  • : unknown error

Background tracking for geofencing#

Once you have initialized the SDK and the user has authorized background permissions, you can start tracking the user's location in the background.

The SDK supports custom tracking options as well as three presets.

For geofencing, we recommend using RadarTrackingOptions.presetResponsive. This preset detects whether the device is stopped or moving. When moving, it tells the SDK to send location updates to the server every 2-3 minutes. When stopped, it tells the SDK to shut down to save battery. Once stopped, the device will need to move more than 100 meters to wake up and start moving again.

Assuming the user has authorized background permissions, background tracking will work even if the app has been backgrounded or killed, as iOS location services will wake up the app to deliver events.

To start tracking for geofencing, call:

Radar.startTracking(trackingOptions: RadarTrackingOptions.presetResponsive)

To determine whether tracking has been started, call:

Radar.isTracking()

To stop tracking (e.g., when the user logs out), call:

Radar.stopTracking()

You only need to call these methods once, as these settings will be persisted across app sessions.

Background tracking for trips#

For trips, we recommend using RadarTrackingOptions.presetContinuous. This preset tells the SDK to send location updates to the server every 30 seconds, regardless of whether the device is moving.

Tracking for the duration of a trip is started or updated by including tracking options in the startTrip call:

Radar.startTrip(options: tripOptions, trackingOptions: .presetContinuous) { (status: RadarStatus, trip: RadarTrip?, events: [RadarEvent]?) in  if status == .success {    // do something  } else {    // handle error  }}

If tracking was disabled before the trip started, it will stop after the trip ends. Otherwise, it will revert to the tracking options in use before the trip started:

// complete tripRadar.completeTrip()
// cancel tripRadar.cancelTrip()

Learn more about starting, completing, and canceling trips in the trip tracking documentation.

Mock tracking for testing#

Can't go for a walk or a drive? You can simulate a sequence of location updates. For example, to simulate a sequence of 10 location updates every 3 seconds by car from an origin to a destination, call:

Radar.mockTracking(  origin: CLLocation(latitude: 40.714708, longitude: -74.035807),  destination: CLLocation(latitude: 40.717410, longitude: -74.053334),  mode: .car,  steps: 10,  interval: 3) { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in    // do something with location, events, user}

Listening for events with a delegate#

To listen for events, location updates, and errors client-side, set a RadarDelegate. Set your RadarDelegate in a codepath that will be initialized and executed in the background. For example, make your AppDelegate implement RadarDelegate, not a ViewController. AppDelegate will be initialized in the background, whereas a ViewController may not be.

import UIKitimport RadarSDK
@UIApplicationMainclass AppDelegate: UIResponder, UIApplicationDelegate, RadarDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {        Radar.initialize(publishableKey: "prj_test_pk...")        Radar.setDelegate(self)
        return true    }
    func didReceiveEvents(_ events: [RadarEvent], user: RadarUser?) {        // do something with events, user    }
    func didUpdateLocation(_ location: CLLocation, user: RadarUser) {        // do something with location, user    }
    func didUpdateClientLocation(_ location: CLLocation, stopped: Bool, source: RadarLocationSource) {        // do something with location, stopped, source    }
    func didFail(status: RadarStatus) {        // do something with status    }
    func didLog(message: String) {        // print message for debug logs    }
}

Manual tracking#

If you want to manage location services yourself, you can manually update the user's location instead by calling:

Radar.trackOnce(  location: location) { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in    // do something with location, events, user}

where location is a CLLocation instance with a valid latitude, longitude, and horizontal accuracy.

Identify user#

The SDK automatically collects installId (a GUID generated on fresh install) and deviceId (IDFV).

You can also assign a custom userId, also called External ID in the dashboard. To set a custom userId, call:

Radar.setUserId(userId)

where userId is a stable unique ID for the user.

To set a dictionary of custom metadata for the user, call:

Radar.setMetadata(metadata)

where metadata is a dictionary with up to 16 keys and values of type string, boolean, or number.

Finally, to set an optional description for the user, displayed in the dashboard, call:

Radar.setDescription(description)

You only need to call these methods once, as these settings will be persisted across app sessions.

Learn more about when Radar creates new user records here.

Debug logging#

By default, only critical errors are logged to the console. To enable debug logging, call:

Radar.setLogLevel(RadarLogLevel.debug)

To log app lifecycle events, call the respective Radar methods in the AppDelegate lifecycle methods:

import UIKitimport RadarSDK
@UIApplicationMainclass AppDelegate: UIResponder, UIApplicationDelegate, RadarDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {        Radar.initialize(publishableKey: "prj_test_pk...")        Radar.setDelegate(self)
        return true    }
  func applicationWillResignActive(_ application: UIApplication) {    // existing code    Radar.logResigningActive()  }
  func applicationDidEnterBackground(_ application: UIApplication) {    // existing code    Radar.logBackgrounding()  }
  func applicationWillTerminate(_ application: UIApplication) {    // existing code    Radar.logTermination()  }}

Submit to App Store#

Apple requires that you justify your use of background location. Add something materially similar to the following to the bottom of your App Store description: This app uses background location to (insert use case here). Continued use of background location may decrease battery life.

If you turned on the Location updates background mode, Apple requires additional justification in your App Store review notes. If using RadarTrackingOptions.presetResponsive, add something like: This app uses the Radar SDK (https://radar.com) to (insert use case here). The Radar SDK requires the background location mode to support polygon geofences and nearby place detection, which cannot be accomplished with region monitoring or visit monitoring. Or, if using RadarTrackingOptions.presetContinuous, add something like This app uses the Radar SDK (https://radar.com) to (insert use case here). The Radar SDK requires the location background mode for live trip tracking and live ETAs.

Learn more about this requirement in section 2.5.4 of the App Store Review Guidelines here.

Other APIs#

The iOS SDK also exposes APIs for beacons, anonymous context, geocoding, search, and distance.

Beacons#

If the user has granted location permissions, you can range and monitor beacons.

To range beacons in the foreground, call:

Radar.trackOnce(desiredAccuracy: .high, beacons: true) { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in    // do something with user.beacons}

To monitor beacons in the background, update your tracking options:

let trackingOptions = RadarTrackingOptions.presetResponsivetrackingOptions.beacons = trueRadar.startTracking(trackingOptions: trackingOptions)

Get location#

Get a single location update without sending it to the server:

Radar.getLocation { (status: RadarStatus, location: CLLocation?, stopped: Bool) in    // do something with location}

Context#

With the context API, get context for a location without sending device or user identifiers to the server:

Radar.getContext { (status: RadarStatus, location: CLLocation?, context: RadarContext?) in    // do something with context}

Geocoding#

With the forward geocoding API, geocode an address, converting address to coordinates:

Radar.geocode(    address: "20 jay st brooklyn ny") { (status: RadarStatus, addresses: [RadarAddress]?) in    // do something with addresses}

With the reverse geocoding API, reverse geocode a location, converting coordinates to address:

Radar.reverseGeocode(    location: location) { (status: RadarStatus, addresses: [RadarAddress]?) in    // do something with addresses}

With the IP geocoding API, geocode the device's current IP address, converting IP address to city, state, and country:

Radar.ipGeocode { (status: RadarStatus, address: RadarAddress, proxy: Bool) in    // do something with address, proxy}

Search#

With the autocomplete API, autocomplete partial addresses and place names, sorted by relevance:

Radar.autocomplete(    query: "brooklyn roasting",    near: location,    limit: 10) { (status: RadarStatus, addresses: [RadarAddress]?) in  // do something with addresses}

With the geofence search API, search for geofences near a location, sorted by distance:

Radar.searchGeofences(    near: location,    radius: 1000, // meters    tags: ["store"],    metadata: nil,    limit: 10) { (status: RadarStatus, location: CLLocation?, geofences: [RadarGeofence]?) in  // do something with geofences}

With the places search API, search for places near a location, sorted by distance:

Radar.searchPlaces(    near: location,    radius: 1000, // meters    chains: ["starbucks"],    categories: nil,    groups: nil,    limit: 10) { (status: RadarStatus, location: CLLocation?, places: [RadarPlace]?) in  // do something with places}

With the address validation API (currently in beta), validate a structured address in the US or Canada:

Radar.validateAddress(    address: address) { (status: RadarStatus, address: RadarAddress?, result: ValidationResult) in    // do something with validation result and address}

Distance#

With the distance API, calculate the travel distance and duration between an origin and a destination:

Radar.getDistance(    origin: origin,    destination: destination,    modes: [.foot, .car],    units: .imperial) { (status: RadarStatus, routes: RadarRoutes?) in  // do something with routes}

Matrix#

With the matrix API, calculate the travel distance and duration between multiple origins and destinations for up to 25 routes:

Radar.getMatrix(    origins: origins,    destinations: destinations,    mode: .car,    units: .imperial) { (status: RadarStatus, matrix: RadarRouteMatrix?) in  // do something with matrix.routeBetween(originIndex:destinationIndex:)}

Conversions#

With the conversions API, log a conversion, such as a purchase or signup, to analyze alongside your app's location activity:

Radar.logConversion(  name: name,  metadata: metadata,) { (status: RadarStatus, event: RadarEvent?) in  // do something with the conversion event}
// conversion with revenueRadar.logConversion(  name: name,  revenue: revenue,  metadata: metadata,) { (status: RadarStatus, event: RadarEvent?) in  // do something with the conversion event}