react-native-enjoy-sdk

Table of contents

• Install Instruction
  • Mostly automatic installation
  • Manual installation
• After installation instruction
• Usage
  • Available Methods
  • Data Types

Install Instruction

Mostly automatic installation

$ npm install react-native-enjoy-sdk --save

$ react-native link react-native-enjoy-sdk

Android - After installation instruction

Manual installation

Android

$ npm install react-native-enjoy-sdk --save

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

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

2. Insert the following lines inside the dependencies block in android/app/build.gradle:

dependencies {
+   compile project(':react-native-enjoy-sdk')
    compile fileTree(dir: "libs", include: ["*.jar"])
    compile "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
    compile "com.facebook.react:react-native:+"  // From node_modules
}

3. Open up android/app/src/main/java/[...]/MainApplication.java

• Add import link.enjoy.rnsdk.RNEnjoySdkPackage; to the imports at the top of the file
• Add new RNEnjoySdkPackage() to the list returned by the getPackages() method

 import android.app.Application;
 import com.facebook.react.ReactApplication;
 import com.facebook.react.ReactPackage;
 import com.facebook.react.shell.MainReactPackage;
+import link.enjoy.rnsdk.RNEnjoySdkPackage;

 import java.util.Arrays;
 import java.util.List;

 public class MainApplication extends Application implements ReactApplication {
 	...
 	...
     @Override
     protected List<ReactPackage> getPackages() {
       return Arrays.<ReactPackage>asList(
           new MainReactPackage(),
+          new RNEnjoySdkPackage()
       );
     }
 }

Android - After installation instruction

After installation instruction

1. Open up android/build.gradle and add mvn.dreamsky.me:6080 repository to your project.

allprojects {
    repositories {
        mavenLocal()
        jcenter()
+       maven {
+           url 'http://mvn.enjoy.link:6080/'
+       }
        maven {
            // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
            url "$rootDir/../node_modules/react-native/android"
        }
    }
}

2. In android/app/src/main[...]/MainActivity.java, rewrite Activity related life-cycle method, and invoke corresponded Enjoy SDK method from it. Pass your Enjoy App Id to Enjoy SDK onCreate method.

Full list of corresponded life-cycle method:

Activity Life Cycle	Enjoy SDK Corresponded method
onCreate()	onCreate()
onStart()	onStart()
onResume()	onResume()
onPause()	onPause()
onStop()	onStop()
onRestart()	onRestart()
onDestroy()	onDestroy()

Example:

 import com.facebook.react.ReactActivity;
+import link.enjoy.rnsdk.EnjoyLifecycleHandler;
+import android.os.Bundle;

 public class MainActivity extends ReactActivity {
+     private  final  String  ENJOY_APP_ID  =  ""; // Fill with Enjoy App Id

+     @Override
+     protected void onCreate(Bundle savedInstanceState) {
+         super.onCreate(savedInstanceState);
+         EnjoyLifecycleHandler.getInstance().onCreate(this, ENJOY_APP_ID);
+     }

+     @Override
+     protected void onStart() {
+         super.onStart();
+         EnjoyLifecycleHandler.getInstance().onStart();
+     }

+     @Override
+     protected void onResume() {
+         super.onResume();
+         EnjoyLifecycleHandler.getInstance().onResume();
+     }

+     @Override
+     protected void onPause() {
+         super.onPause();
+         EnjoyLifecycleHandler.getInstance().onPause();
+     }

+     @Override
+     protected void onStop() {
+         super.onStop();
+         EnjoyLifecycleHandler.getInstance().onStop();
+     }

+     @Override
+     protected void onRestart() {
+         super.onRestart();
+         EnjoyLifecycleHandler.getInstance().onRestart();
+     }

+     @Override
+     protected void onDestroy() {
+         super.onDestroy();
+         EnjoyLifecycleHandler.getInstance().onDestroy();
+     }

     /**
      * Returns the name of the main component registered from JavaScript.
      * This is used to schedule rendering of the component.
      */
     @Override
     protected String getMainComponentName() {
         return "example";
     }
 } 

Usage

Import it in your JS:

import EnjoySdk from 'react-native-enjoy-sdk';

Available Methods

• initWallAd(placementId: string, adMark?: string): Promise<AdObj>
  • Initiate Wall Ad with placementId.
  • If you want to give the current ad a unique identification, you can use adMark, which is optional.

EnjoySdk.initWallAd(WALL_AD_PLACEMENT_ID, userId)
    .then(adObj => console.log('adObj', adObj))
    .catch(err => console.log('err', err))

• showWallAd(adObj: AdObj): Promise<AdObj>
  • Show Wall Ad

EnjoySdk.showWallAd(adObj)
    .then(adObj => console.log('adObj', adObj))
    .catch(err => console.log('err', err))

• addOnWallAdCloseListener(clb: (adObj: AdObj) => void ): Subscription
  • Callback is called when Wall Ad is closed
  • Use remove() method from Subscription object to remove listener

componentDidMount () {
    this.onWallAdCloseSubscription = EnjoySdk.addOnWallAdCloseListener(adObj => {
      console.log('OnWallAdClose', adObj);
    });
}

componentWillUnmount () {
    this.onWallAdCloseSubscription.remove();
}

• addOnWallAdClickedListener(clb: (adObj: AdObj) => void ): Subscription
  • Callback is called when user click on Wall Ad
  • Use remove() method from Subscription object to remove listener

componentDidMount () {
    this.onWallAdClickedSubscription = EnjoySdk.addOnWallAdClickedListener(adObj => {
      console.log('OnWallAdClicked', adObj);
    });
}

componentWillUnmount () {
    this.onWallAdClickedSubscription.remove();
}

• addOnRewardedListener(clb: (data: { rewards: Array<rewardObj> }) => void): Subscription
  • Callback is called when user needs to receive reward(s)
  • Use remove() method from Subscription object to remove listener

componentDidMount () {
    this.onRewardedSubscription = EnjoySdk.addOnRewardedListener(data => {
      console.log('onRewarded', data);
    });
}

componentWillUnmount () {
    this.onRewardedSubscription.remove();
}

• finishReward(rewardId: String): Promise<void>
  • Call this method when you reward your user

EnjoySdk.finishReward(rewardId)
    .then(() => console.log('Finished'))
    .catch(err => console.log('err', err))

Data Types

type AdObj = {
    adType: string;
    placementId: string;
}

type Subscription = {
    remove: () => void
}

type RewardObj = {
    rewardId: string;
    rewardNum: number;
    adMark: string;
    transactionId: string;
}