Skip to main content

Flutter Package

This is the documentation for the Flutter package. Before integrating, read the native SDK documentation to familiarize yourself with the platform.

See the source on GitHub here. Or, see the flutter_radar package on pub.dev here.

Install#

Add the package to your pubspec.yaml file:

dependencies:  flutter_radar: ^3.8.0

Then, update dependencies:

flutter pub get

iOS#

Change to the ios/ directory. In the Podfile, add platform :ios, '10.0' or higher to your target.

On iOS, you must add location usage descriptions and background modes to your Info.plist. Initialize the SDK in application:didFinishLaunchingWithOptions: in AppDelegate.m or AppDelegate.swift, passing in your Radar publishable API key.

import UIKitimport Flutter
import RadarSDK
@UIApplicationMain@objc class AppDelegate: FlutterAppDelegate {  override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {    Radar.initialize(publishableKey: "prj_test_pk_...")    GeneratedPluginRegistrant.register(with: self)    return super.application(application, didFinishLaunchingWithOptions: launchOptions)  }}

Android#

On Android, add the Radar Android SDK to the dependencies section of your Android app's build.gradle file. Ensure the Android SDK version matches the version of your Radar Flutter package.

dependencies {    implementation 'io.radar:sdk:3.8.12'}

Initialize the SDK in onCreate() in MainApplication.java, passing in your Radar publishable API key. If your Flutter Android app is in Kotlin, add a Application.kt file and reference this as the application name in your Android manifest.

import io.flutter.app.FlutterApplicationimport io.flutter.embedding.engine.FlutterEngineimport io.flutter.plugin.common.PluginRegistryimport io.flutter.plugins.GeneratedPluginRegistrant
import io.radar.sdk.Radar
class Application : FlutterApplication(), PluginRegistry.PluginRegistrantCallback {
  override fun onCreate() {      super.onCreate()      Radar.initialize(this, "prj_test_pk_...")  }
  override fun registerWith(registry: PluginRegistry) {      GeneratedPluginRegistrant.registerWith(FlutterEngine(this))  }}

For background tracking without a foreground service, and if targeting API level 29 or higher, Radar also requires the ACCESS_BACKGROUND_LOCATION permission. You must add the ACCESS_BACKGROUND_LOCATION permission to your manifest manually:

<manifest xmlns:android="http://schemas.android.com/apk/res/android">    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" /></manifest>

Integrate#

Import module#

First, import the package:

import 'package:flutter_radar/flutter_radar.dart';

Initialize#

When your app starts, initialize the SDK with your publishable key.

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

Radar.initialize(publishableKey);

Identify user#

To identify the user when logged in, call:

Radar.setUserId(userId);

where userId is a stable unique ID for the user.

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

Radar.setMetadata(metadata);

where metadata is a map 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);

where description is a string.

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

Learn about platform-specific implementations of these functions in the iOS SDK documentation and Android SDK documentation.

Request permissions#

Before tracking the user's location, the user must have granted location permissions for the app.

To determine the whether user has granted location permissions for the app, call:

String status = await Radar.getPermissionsStatus();

status will be a string, one of:

  • GRANTED_FOREGROUND
  • GRANTED_BACKGROUND
  • DENIED
  • NOT_DETERMINED

To request location permissions for the app, call:

String status = await Radar.requestPermissions(background);

where background is a boolean indicating whether to request background location permissions or foreground location permissions.

Learn about platform-specific permissions in the iOS SDK documentation and Android SDK documentation.

Foreground tracking#

Once you have initialized the SDK and the user has granted permissions, you can track the user's location.

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

var res = await Radar.trackOnce();// do something with res['status'], res['location'], res['events'], res['user']

Learn about platform-specific implementations of this function in the iOS SDK documentation and Android SDK documentation.

Background tracking#

On iOS and Android, once you have initialized the SDK and the user has granted permissions, you can start tracking the user's location in the background.

For background tracking, the SDK supports custom tracking options as well as three presets:

  • EFFICIENT: A low frequency of location updates and lowest battery usage. On Android, avoids Android vitals bad behavior thresholds.
  • RESPONSIVE: A medium frequency of location updates and low battery usage. Suitable for most consumer use cases.
  • CONTINUOUS: A high frequency of location updates and higher battery usage. Suitable for on-demand use cases (e.g., delivery tracking) and some consumer use cases (e.g., order ahead, "mall mode").

Learn about platform-specific implementations of these presets in the iOS SDK documentation and Android SDK documentation.

To start tracking the user's location in the background, call one of:

Radar.startTracking('efficient');
Radar.startTracking('responsive');
Radar.startTracking('continuous');

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

Though we recommend using presets for most use cases, you can customize the tracking options. See the tracking options reference.

// optionally adjust foreground service options for AndroidRadar.setForegroundServiceOptions({  'text': "Location tracking started",  'title': "Location updates",  'importance': 2,  'updatesOnly': false,  'activity': 'com.yourapp.MainActivity'});
Radar.startTrackingCustom({  desiredStoppedUpdateInterval: 180,  desiredMovingUpdateInterval: 60,  desiredSyncInterval: 50,  desiredAccuracy: 'high',  stopDuration: 140,  stopDistance: 70,  sync: 'all',  replay: 'none',  showBlueBar: true,  foregroundServiceEnabled: true});

To stop tracking the user's location in the background (e.g., when the user logs out), call:

Radar.stopTracking();

Learn about platform-specific implementations of these functions in the iOS SDK documentation and Android SDK documentation.

To listen for events, location updates, and errors, you can add event listeners:

static void onClientLocation(Map result) {  // do something with result.location}
static void onLocation(Map result) {  // do something with result.location, result.user}
static void onEvents(Map result) {  // do something with result.events, result.user}
static void onError(Map err) {  // do something with err}
Radar.onClientLocation(onClientLocation);Radar.onLocation(onLocation);Radar.onEvents(onEvents);Radar.onError(onError);

Add event listeners outside of your view lifecycle if you want them to work when the app is in the background.

Mock tracking#

On iOS and Android, you can simulate a sequence of location updates for testing. For example, to simulate a sequence of 10 location updates every 3 seconds by car from an origin to a destination, we can call:

Radar.mockTracking(  origin: {'latitude': 40.714708, 'longitude': -74.035807},  destination: {'latitude': 40.717410, 'longitude': -74.053334},  mode: 'car',  steps: 10,  interval: 3);

Trip tracking#

On iOS and Android, to start a trip to a destination, call:

Radar.startTrip(  tripOptions: {  "externalId": '299',  "destinationGeofenceTag": 'store',  "destinationGeofenceExternalId": '123',  "mode": 'car'  },  trackingOptions: {    "desiredStoppedUpdateInterval": 30,    "fastestStoppedUpdateInterval": 30,    "desiredMovingUpdateInterval": 30,    "fastestMovingUpdateInterval": 30,    "desiredSyncInterval": 20,    "desiredAccuracy": "high",    "sync": "all",    "showBlueBar": true,    "foregroundServiceEnabled": true  });

Later, to complete the trip, call:

Radar.completeTrip();

Or, to cancel the trip, call:

Radar.cancelTrip();

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.

Learn more about trip tracking.

Manual tracking#

You can manually update the user's location by calling:

var res = await Radar.trackOnce({  'latitude': 39.2904,  'longitude': -76.6122,  'accuracy': 65});// do something with res['status'], res['location'], res['events'], res['user']

Learn about platform-specific implementation of this function in the iOS SDK documentation and Android SDK documentation.

Other APIs#

The Flutter package also exposes APIs for anonymous context, geocoding, search, and distance.

Get location#

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

var coordinates = await Radar.getLocation();

Context#

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

var res = await Radar.getContext({  'latitude': 40.783826,  'longitude': -73.975363,  'accuracy': 65});// do something with res['status'], res['context']

Geocoding#

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

var res = await Radar.geocode('20 jay st brooklyn ny')// do something with res['status'], res['addresses']

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

var res = await Radar.reverseGeocode({  'latitude': 40.783826,  'longitude': -73.975363,  'accuracy': 65});// do something with res['status'], res['addresses']

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

var res = await Radar.ipGeocode((result) => {// do something with res['status'], res['address']

Search#

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

var res = await Radar.autocomplete(  query: 'brooklyn roasting',  near: {'latitude': 40.783826, 'longitude': -73.975363},  limit: 10);// do something with res['status'], res['addresses']

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

var res = await Radar.searchGeofences(  near: {'latitude': 40.783826, 'longitude': -73.975363},  radius: 1000,  tags: ['venue'],  limit: 10);// do something with res['status'], res['geofences']

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

var res = await Radar.searchPlaces(  near: {'latitude': 40.783826, 'longitude': -73.975363},  radius: 1000,  chains: ['starbucks'],  limit: 10);// do something with res['status'], res['places']

Distance#

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

var res = await Radar.getDistance(  origin: {'latitude': 40.78382, 'longitude': -73.97536},  destination: {'latitude': 40.70390, 'longitude': -73.98670},  modes: ['foot', 'car'],  units: 'imperial');// do something with res['status'], res['routes']

Support#

Have questions? We're here to help! Email us at support@radar.com.