https://github.com/simranjitk/radar-ionic
Ionic Radar Plugin - Location Platform for Mobile Apps
https://github.com/simranjitk/radar-ionic
android cordova-plugin ionic ios
Last synced: 2 months ago
JSON representation
Ionic Radar Plugin - Location Platform for Mobile Apps
- Host: GitHub
- URL: https://github.com/simranjitk/radar-ionic
- Owner: Simranjitk
- License: mit
- Created: 2018-07-06T00:59:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-10T22:07:30.000Z (almost 8 years ago)
- Last Synced: 2025-01-08T13:51:21.848Z (over 1 year ago)
- Topics: android, cordova-plugin, ionic, ios
- Language: Swift
- Size: 216 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Radar Ionic Plugin
[Radar](https://radar.io/) is a location platform for mobile apps. This Ionic plugin let's you use Radar features in your Ionic application.
[](https://badge.fury.io/js/ionic-radar)
## Available Radar Functions
- [Tracking](https://github.com/Simranjitk/radar-ionic#start-tracking)
- [Stop Tracking](https://github.com/Simranjitk/radar-ionic#stop-tracking)
- [Set UserID](https://github.com/Simranjitk/radar-ionic#set-user-id)
- [Get Permission](https://github.com/Simranjitk/radar-ionic#get-permission)
- [Check Permissions](https://github.com/Simranjitk/radar-ionic#check-permission)
## Installation
------
```typescript
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
```java
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
```swift
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:
```typescript
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:
```typescript
cordova.plugins.RadarPlugin.startTracking(value => {
});
```
------
#### Stop Tracking
To stop background location tracking, run:
```typescript
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:
```typescript
cordova.plugins.RadarPlugin.stopTracking(userID, value => {
});
```
------
#### Check Permission
Check if the app has location permission:
```typescript
cordova.plugins.RadarPlugin.checkPermissions();
```
------
#### Get Permission
Ask the user for location permission:
```typescript
cordova.plugins.RadarPlugin.checkPermissions();
```