React native bridge module for the hypertrack-ios and hypertrack-android SDKs
Java Objective-C JavaScript
Aman
Aman 3.1.11
Latest commit d83ac5c May 31, 2018

README.md

react-native-hypertrack

React native module for hypertrack-android and hypertrack-ios SDKs. Methods in the Driver SDK are covered in the current release. Our Example React Native app app is built on top of this module.

Slack Status npm version

To build live location features within your own React Native app

Follow this step-by-step onboarding guide that will walk you through the sdk integration within your own app in a matter of few minutes.

In your project directory, install and link the module package from npm.

$ npm install react-native-hypertrack --save
$ react-native link react-native-hypertrack

Getting Started Android

  1. Update compileSdkVersion, buildToolsVersion, support library version For the Android SDK, edit the build.gradle file in your android/app directory
  1. Adds maven dependency for Google Libraries For the Android SDK, edit the build.gradle file in your android directory

    // Top-level build file where you can add configuration options common to all sub-projects/modules.
    buildscript {
        repositories {
            jcenter()
            maven {
                url 'https://maven.google.com/'
                name 'Google'
            }
        }
        dependencies {
            classpath 'com.android.tools.build:gradle:3.0.1'
            classpath 'com.google.gms:google-services:3.1.0'
    
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }
    
    allprojects {
        repositories {
            mavenLocal()
            jcenter()
            maven {
                // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
                url "$rootDir/../node_modules/react-native/android"
            }
            maven {
                url 'https://maven.google.com/'
                name 'Google'
            }
        }
    }

Getting started - iOS

  1. The native iOS SDKs need to be setup using Cocoapods. In your project's ios directory, create a Podfile.

    $ cd ios
    $ pod init
  2. Edit the Podfile to include HyperTrack as a dependency for your project, and then install the pod with pod install.

    use_frameworks!
    platform :ios, '9.0'
    
    target 'AwesomeProject' do
    
      # Pods for AwesomeProject
      pod 'HyperTrack'
    
      post_install do |installer|
            installer.pods_project.targets.each do |target|
                target.build_configurations.each do |config|
                    config.build_settings['SWIFT_VERSION'] = '3.0'
                end
            end
      end
    end
  3. Open the iOS project with .xcworkspace file in Xcode and also, open the node_modules/react-native-hypertrack/ directory. Move the _ios/RNHyperTrack.h and _ios/RNHyperTrack.m files to your project as shown below.

iOS link

  1. Import inside Javascript.
    import { NativeModules } from 'react-native';
    var RNHyperTrack = NativeModules.RNHyperTrack;

API usage

1. Initialize the SDK

import RNHyperTrack from 'react-native-hypertrack';
...

export default class MyApp extends Component {
  constructor() {
   super();

   // Initialize HyperTrack wrapper
   RNHyperTrack.initialize("YOUR_PUBLISHABLE_KEY");
  }
}
...

2. Requesting Location & Motion (iOS) Authorizations

// Call this method to check location authorization status.
RNHyperTrack.locationAuthorizationStatus().then((result) => {
  // Handle locationAuthorizationStatus API result here
  console.log('locationAuthorizationStatus: ', result);
});

// Call this method to request Location Authorization for Android & iOS (Always Authorization).
// NOTE: In Android, the Permission dialog box's title and message can be customized by passing them as parameters.
RNHyperTrack.requestAlwaysLocationAuthorization(title, message);

// Call this method to check location services are enabled or not.
RNHyperTrack.locationServicesEnabled().then((result) => {
  // Handle locationServicesEnabled API result here
  console.log('locationServicesEnabled: ', result);
});

// Call this method to check if Motion Activity API is available on the device
// NOTE: Motion Authorization is required only for iOS. This API will return an error in Android.
RNHyperTrack.isActivityAvailable();

// Call this method to request Motion Authorization for iOS.
// NOTE: Motion Authorization is required only for iOS. This API will return an error in Android.
RNHyperTrack.requestMotionAuthorization();

3. Get or create user

Calling this API configures the sdk by creating a new user if not already present or fetching the existing one, if one exists with the given uniqueId.

RNHyperTrack.getOrCreateUser(name, phoneNumber, uniqueId).then((success) => {
      // Handle getOrCreateUser API success here
      console.log("getOrCreateUser success: ", success);
    }, (error) => {
      // Handle getOrCreateUser API error here
      console.log("getOrCreateUser error: ", error);
    });

4. Resume tracking

Tracking is automatically started if there is atleast one action assigned to the user. You can force pause tracking by calling pauseTracking method in which case tracking won't be resumed even after assigning an action to the user. To resume the force paused tracking use resumeTracking method. Tracking will be started as soon as an action is assigned to the user.

RNHyperTrack.resumeTracking();

5. Create an Action

Create and assign an Action object to the user. The createAction method accepts a js dictionary object with expected_place_id, type, unique_id and expected_at keys.

var params = {
  'expected_place_id': '8166a3c6-5a55-42be-8c04-d73367b0ad9c',
  'expected_at': '2017-07-06T01:00:00.000Z',
  'unique_id': 'order-id-1435223'
}

RNHyperTrack.createAction(params).then(
    (success) => {
        // success callback
        console.log(success);
    }, (error) => {
        // error callback
        console.log(error);
    }
);

6. Completing an action

If you are using actions for your use-case, you can complete actions through the SDK.

RNHyperTrack.completeActionInSync("YOUR_ACTION_ID").then(
    (success) => {
        // success callback
        console.log(success);
    }, (error) => {
        // error callback
        console.log(error);
    }
);

7. Pause tracking

Tracking is automatically started if there is atleast one action assigned to the user. You can force pause tracking by calling pauseTracking method in which case tracking won't be resumed even after assigning an action to the user.

RNHyperTrack.pauseTracking();

Documentation

The HyperTrack documentation is at docs.hypertrack.com.

Support

For any questions, please reach out to us on Slack or on help@hypertrack.io. Please create an issue for bugs or feature requests.

Acknowledgements

Thanks to react-native-create-library which saved a few hours.