No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
android
ios
.gitattributes
.gitignore
README.md
index.js
package.json

README.md

react-native-theorem-reach

Before you start

Get your API key

Sign-up for a new developer account and create a new app here and copy your API Key.

Install SDK

iOS

Install via Cocoapods
// add to your Podfile:
pod 'TheoremReach', '3.2.7'

// pod repo update
// pod install
Or manually download the SDK
  1. Download the latest version of the iOS SDK here.
  2. Copy TheoremReachSDK.framework file to the iOS project root folder.
After installing the SDK, link libraries
  • Add the TheoremReachSDK.framework file to the link binary with libraries section under the Build Phases tab (or Embedded Binaries on the General tab if you're using xcode 7):
    • TheoremReachSDK.framework
  • Add the following required frameworks:
    • AdSupport.framework
    • CoreTelephony.framework
    • Foundation.framework
    • JavaScriptCore.framework
    • Security.framework
    • SystemConfiguration.framework
    • UIKit.framework
  • And the following optional frameworks:
    • Webkit.framework
Set Required Build Settings

We utilize Apple's Advertising ID (IDFA) to identify users. When uploading your app ensure that you check the box to note that you use IDFA. On the Info tab add in a Dictionary called NSAppTransportSecurity. Make sure you add this dictionary on the Top Level Key. Inside this dictionary, add a Boolean called NSAllowsArbitraryLoads and set it to YES. An example of your info.plist can be found here.

Android

No separate SDK installation is needed for Android.

Getting started

$ npm install react-native-theorem-reach --save

Automatic installation

$ react-native link react-native-theorem-reach

Manual installation

If automatic linking does not work, follow the next steps.

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-theorem-reach and add RNTheoremReach.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNTheoremReach.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.theoremreach.RNTheoremReachPackage; to the imports at the top of the file
  • Add new RNTheoremReachPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-theorem-reach'
    project(':react-native-theorem-reach').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-theorem-reach/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-theorem-reach')
    

We are all set up! Now let's use the module.

Usage

Initialize TheoremReach

First, you need to initialize the TheoremReach instance with initWithApiKeyAndUserId call.

// Import TheoremReach native module
import TheoremReach from 'react-native-theorem-reach';

componentWillMount() {
  // In your app initialization, initialize TheoremReach
  TheoremReach.initWithApiKeyAndUserId('YOUR_API_TOKEN', 'YOUR_USER_ID');
}

Reward Center

Next, implement the logic to display the reward center. Call the showRewardCenter method when you are ready to send the user into the reward center where they can complete surveys in exchange for your virtual currency. We automatically convert the amount of currency a user gets based on the conversion rate specified in your app.

onPressShowRewardCenter = () => {
  TheoremReach.isSurveyAvailable((isAvailable) => {
    // if a survey is available, show the reward center
    if (isAvailable) {
      TheoremReach.showRewardCenter();
    }
  })
}

Reward Callback

To ensure safety and privacy, we recommend using a server side callback to notify you of all awards. In the developer dashboard for your App add the server callback that we should call to notify you when a user has completed an offer. Note the user ID pass into the initialize call will be returned to you in the server side callback. More information about setting up the callback can be found in the developer dashboard.

The quantity value will automatically be converted to your virtual currency based on the exchange rate you specified in your app. Currency is always rounded in favor of the app user to improve happiness and engagement.

Client Side Award Callback

If you do not have a server to handle server side callbacks we additionally provide you with the ability to listen to client side reward notification.

First, import Native Module Event Emitter:

import { TheoremReachEventEmitter } from 'react-native-theorem-reach';

Then, add event listener for award notification (in componentWillMount, for example):

this.onRewardListener = TheoremReachEventEmitter.addListener(
  'onReward',
  this.onReward,
);

Implement the callback:

onReward = (quantity) => {
  console.log('reward quantity: ', quantity);
}

Reward Center Events

You can optionally listen for the onRewardCenterOpened and onRewardCenterClosed events that are fired when your Reward Center modal is opened and closed.

Add event listeners for onRewardCenterOpened and onRewardCenterClosed:

this.onRewardCenterOpenedListener = TheoremReachEventEmitter.addListener(
  'onRewardCenterOpened',
  this.onRewardCenterOpened,
);
this.onRewardCenterClosedListener = TheoremReachEventEmitter.addListener(
  'onRewardCenterClosed',
  this.onRewardCenterClosed,
);

Implement event callbacks:

onRewardCenterOpened = () => {
  console.log('onRewardCenterOpened called!');
}

onRewardCenterClosed = () => {
  console.log('onRewardCenterClosed called!');
}

Survey Available Callback

If you'd like to be proactively alerted to when a survey is available for a user you can add this event listener.

First, import Native Module Event Emitter:

import { TheoremReachEventEmitter } from 'react-native-theorem-reach';

Then, add event listener for award notification (in componentWillMount, for example):

this.theoremreachSurveyAvailableListener = TheoremReachEventEmitter.addListener(
  'theoremreachSurveyAvailable',
  this.theoremreachSurveyAvailable,
);

Implement the callback:

theoremreachSurveyAvailable = (surveyAvailable) => {
  if (surveyAvailable == 1) {
    console.log('theoremreach survey is available');
  } else {
    console.log('theoremreach survey is NOT available');
  }
}

Finally, don't forget to remove your event listeners in the componentWillUnmount lifecycle method:

componentWillUnmount() {
  this.onRewardListener.remove();
  this.onRewardCenterOpenedListener.remove();
  this.onRewardCenterClosedListener.remove();
  this.theoremreachSurveyAvailableListener.remove();
}

Contact

Please send all questions, concerns, or bug reports to admin@theoremreach.com.

FAQ

What do you do to protect privacy?

We take privacy very seriously. All data is encrypted before being sent over the network. We also use HTTPS to ensure the integrity and privacy of the exchanged data.

What kind of analytics do you provide?

Our dashboard will show metrics for sessions, impressions, revenue, and much more. We are constantly enhancing our analytics so we can better serve your needs.

What is your fill rate?

We have thousands of surveys and add hundreds more every day. Most users will have the opportunity to complete at least one survey on a daily basis.

I'm ready to go live! What are the next steps?

Let us know! We'd love to help ensure everything flows smoothly and help you achieve your monetisation goals!