Skip to content

Latest commit

 

History

History
117 lines (94 loc) · 4.68 KB

README.md

File metadata and controls

117 lines (94 loc) · 4.68 KB
Raw

react-native-hover-react-sdk

This SDK is in alpha, and currently supports only the most basic Hover functionality: Getting the required permissions, starting a USSD session, getting the results of the session, parsing the result and passing the parsed result of any USSD or SMS response back. After initial set-up all coding can be done in javascript, however the setup does require your react project to include android native source, which means you need to use the react native cli, not expo.

Please see our docs for getting started with Hover. See our sample app for an example of how to use this SDK.

For bug reports or feature requests you can submit an issue to this repo or contact us at support@usehover.com

Installation

We will eventually add this to npm, but for now just clone this repo.

Inside this project directory run

$ npm install --save-dev

Inside your react native project directory:

  1. Run
$ npm install PATH_TO/react-native-hover-react-sdk --save-dev

  1. Append the following lines to android/settings.gradle:

    include ':react-native-hover-react-sdk'
project(':react-native-hover-react-sdk').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-hover-react-sdk/android')

  2. Insert the following lines inside the allprojects > repositories block in android/build.gradle:

maven { url 'http://maven.usehover.com/releases' }
  1. Insert the following lines inside the dependencies block in android/app/build.gradle:
implementation project(':react-native-hover-react-sdk')
  1. Add your Hover API key to the AndroidManifest (android/app/src/main/AndroidManifest.xml) inside the application tag. To generate the key, sign in to usehover.com and generate a new app with your package name.
<application>
  ...
  <meta-data
  	android:name="com.hover.ApiKey"  
  	android:value="<YOUR_API_TOKEN>"/>
</application>
  1. Open android/app/src/main/java/[...]/MainApplication.java
  • Add import com.hover.react.sdk.RNHoverReactSdkPackage; to the imports at the top of the file
  • Add new RNHoverReactSdkPackage() to the list returned by the getPackages() method
  1. Open android/app/src/main/java/[...]/MainActivity.java
  • Add import com.hover.react.sdk.RNHoverReactSdkModule; to the imports at the top of the file
  • If there is an onCreate method, append RNHoverReactSdkModule.initializeHover(this.getApplicationContext()); otherwise add it:
@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  RNHoverReactSdkModule.initializeHover(this.getApplicationContext());
}

Getting Started

In the javascript file where you want to use Hover, for example App.js:

import { NativeModules, NativeEventEmitter } from 'react-native';
const RNHoverReactSdk = NativeModules.RNHoverReactSdk;

Inside your component:

To check if the Hover required permissions have been granted (READ_PHONE_STATE, RECEIVE_SMS, SYSTEM_ALERT_WINDOW, and BIND_ACCESSIBILITY_SERVICE:

var areGranted = await RNHoverReactSdk.hasAllPermissions();
console.log("granted: " + areGranted);

To start the Hover permission request helper:

  try {
    var areGranted = await RNHoverReactSdk.getPermission();
  } catch (e) {
    areGranted = false;
  }
  console.log("granted: " + areGranted);

To start a Hover request:

  try {
    extras = {"amount": "100", "recipient": "43214324"}; // Whatever variables you specified when creating your action
    var response = await RNHoverReactSdk.makeRequest(ACTION_ID, extras);
    console.log("got response: " + response.response_message);
    console.log("transaction uuid: " + response.uuid);
  } catch (e) {
    console.log("request failed or cancelled. Reason: " + e.message);
  }

The properties present on the returned data object are those found here

If you have created a parser in your Hover dashboard then you need add your event listener BEFORE starting the Hover request. The best place for this is in your component's componentWillMount function:

async onHoverParserMatch(data) {
  console.log("received update for transaction with uuid: " + data.uuid);
}

componentWillMount() {
  const transactionEmitter = new NativeEventEmitter(RNHoverReactSdk)
  const subscription = transactionEmitter.addListener("transaction_update", (data) => this.onHoverParserMatch(data));
}

The properties present on the returned data object are those found at the bottom of parsers