kiroskirin / react-native-radar

React Native module for Radar, the location platform for mobile apps

Radar is the location platform for mobile apps.

Installation

Install the package from npm:

npm install --save react-native-radar

Then, install the native dependencies:

react-native link

Before writing any JavaScript, you must integrate the Radar SDK with your iOS and Android apps by following the Configure project and Add SDK to project steps in the SDK documentation.

On iOS, you must add location usage descriptions and background modes to your Info.plist, then add the SDK to your project, preferably using CocoaPods. Finally, initialize the SDK in application:didFinishLaunchingWithOptions: in AppDelegate.m, passing in your publishable API key.

#import <RadarSDK/RadarSDK.h>

// ...

[Radar initializeWithPublishableKey:publishableKey];

On Android, you must add the Google Play Services library to your project, then add the SDK to your project, preferably using Gradle. Finally, initialize the SDK in onCreate() in MainApplication.java, passing in your publishable API key:

import com.onradar.sdk.Radar;

// ...

Radar.initialize(getApplicationContext(), publishableKey);

Usage

Import module

First, import the module:

import Radar from 'react-native-radar';

Identify user

Before tracking the user's location, you must identify the user to Radar. To identify the user, call:

Radar.setUserId(userId);

where userId is a stable unique ID string for the user.

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 methods once, as these settings will be persisted across app sessions.

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:

Radar.getPermissionsStatus().then((status) => {
  // do something with status
});

status will be a string, one of:

• GRANTED
• DENIED
• UNKNOWN

To request location permissions for the app, call:

Radar.requestPermissions(background);

where background is a boolean indicating whether to request background location permissions or foreground location permissions. On Android, background will be ignored.

Foreground tracking

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

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

Radar.trackOnce().then((result) => {
  // do something with result.location, result.events, result.user.geofences
}).catch((err) => {
  // optionally, do something with err
});

err will be a string, one of:

• ERROR_PUBLISHABLE_KEY: the SDK was not initialized
• ERROR_USER_ID: the user was not identified
• ERROR_PERMISSIONS: the user has not granted location permissions for the app
• ERROR_LOCATION: location services were unavailable, or the location request timed out
• ERROR_NETWORK: the network was unavailable, or the network connection timed out
• ERROR_UNAUTHORIZED: the publishable API key is invalid
• ERROR_SERVER: an internal server error occurred
• ERROR_UNKNOWN: an unknown error occurred

Background tracking

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

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

Radar.startTracking();

To stop tracking the user's location in the background (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.

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

Radar.on('events', (result) => {
  // do something with result.events, result.user
});

Radar.on('error', (err) => {
  // do something with err
});

Add event listeners outside of your component lifecycle (e.g., outside of componentDidMount) if you want them to work when the app is in the background.

You can also remove event listeners:

Radar.off('events');

Radar.off('error');

Manual tracking

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

const location = {
  latitude: 39.2904,
  longitude: -76.6122,
  accuracy: 65
};

Radar.updateLocation(location).then((result) => {
  // do something with result.events, result.user.geofences
}).catch((err) => {
  // optionally, do something with err
});

Support

Have questions? We're here to help! Email us at [email protected].