Skip to content

Latest commit

 

History

History
114 lines (72 loc) · 2.54 KB

README.md

File metadata and controls

114 lines (72 loc) · 2.54 KB

Radar Ionic Plugin

Radar is a location platform for mobile apps. This Ionic plugin let's you use Radar features in your Ionic application.

npm version

Available Radar Functions

Installation

ionic cordova plugin add ionic-radar

Usage

Setting up Radar Keys

For Android, under src -> android -> com -> Radar in Radar.java, add your Radar Key in the initialize method

public void initialize(CordovaInterface cordova, CordovaWebView webView) {
    super.initialize(cordova, webView);
    Context context = this.cordova.getActivity().getApplicationContext();
    Radar.initialize(context, "your_radar_key");
    Log.d(TAG, "Initializing Radar Plugin");
  }

For iOS, under ios in RadarWrapper.swift, add your Radar Key in the pluginInitialize function

override func pluginInitialize() {
      Radar.initialize(publishableKey: "your_radar_key");
}

Declaring Cordova

On whichever page you want to use the Radar plugin, you can declare cordova just below your exports, as follows:

declare var cordova: any;

Start Tracking

When you want to begin tracking the user's location in the background, simply call the start tracking method:

cordova.plugins.RadarPlugin.startTracking(value => {
});

Stop Tracking

To stop background location tracking, run:

cordova.plugins.RadarPlugin.stopTracking(value => {
});

Set User ID

If you want to give users a customized user ID rather than the one generated by Radar, you can do it by running the following:

cordova.plugins.RadarPlugin.stopTracking(userID, value => {
});

Check Permission

Check if the app has location permission:

cordova.plugins.RadarPlugin.checkPermissions();

Get Permission

Ask the user for location permission:

cordova.plugins.RadarPlugin.checkPermissions();