APXOR Android SDK Integration Guide

Getting started with Apxor Android SDK

Plugin Name	Latest Version	Release Date
apxor-android-sdk-rtm	1.7.1	2021-09-09
apxor-android-sdk-core	2.7.7	2021-07-30
apxor-android-sdk-push	1.2.5	2021-07-30
apxor-android-sdk-qe	1.4.3	2021-07-21
surveys	1.3.1	2021-07-21
wysiwyg	1.1.9	2021-07-21
jit-log	1.0.0	2020-10-28
apxor-cf	1.0.0	2020-09-14
apxor-android-crash-reporter	1.0.5	2019-05-01

1. Add Maven URL in root level build.gradle

   allprojects {
       repositories {
           // ...
           maven {
              url "https://repo.apxor.com/artifactory/list/libs-release-android/"
           }
           // ...
       }
   }
   

2. Add Apxor Android SDK to your App

   // ...
   apply plugin: 'com.android.application'
   
   android {
       // ...
       defaultConfig {
           minSdkVersion 16 // Minimum Sdk version must be 16 and above
           // ...
       }
       // ...
   }
   
   dependencies {
       // ...
   
       // Event tracking and a must have dependency for other plugins
       implementation 'com.apxor.androidx:apxor-android-sdk-core:2.7.7@aar'
   
       // Getting a "Could not find" error? Make sure that you've added
       // Apxor's Maven repository to your root-level build.gradle file
   }
   

3. If you use proguard, add the following in your proguard-rules.pro file

   -keep class com.apxor.** { *; }
   -dontwarn com.apxor.**
   

4. If you are using rtm >= 1.7.1, add the following property in gradle.properties file

   android.enableDexingArtifactTransform = false
   

Initialize Apxor Android SDK

1. To Auto initialize SDK (Recommended), add following meta-data tag inside your application tag in your AndroidManifest.xml file

   <application>
       <!-- You must replace your app in android:value attribute -->
       <meta-data android:name="APXOR_APP_ID" android:value="APP_ID" />
   </application>
   

2. To manually initialize SDK, call ApxorSDK.initialize method in your Applicaiton class

   //...
   import com.apxor.androidsdk.core.ApxorSDK;
   
   public class MyApplication extends Application {
       @Override
       public void onCreate() {
           // ...
           ApxorSDK.initialize(<YOUR_APP_ID>, this.getApplicationContext());
       }
   }
   

   Note

   To get your app ID, please contact us at contact@apxor.com

Plugins integration

1. Add apxor-android-sdk-core dependency in app/build.gradle file

2. Add plugin dependencies to your application build.gradle file

   dependendies {
   
       // Add this to track uninstalls and send push notifications from Apxor dashboard
       // Note: We don't support firebase-messaging >= 22.0.0 yet
       implementation('com.apxor.androidx:apxor-android-sdk-push:1.2.5@aar') {
           exclude group: 'com.google.firebase'
       }
   
       // Add these for Realtime Actions and Surveys
       implementation 'com.apxor.androidx:apxor-android-sdk-qe:1.4.3@aar'
       implementation 'com.apxor.androidx:apxor-android-sdk-rtm:1.7.1@aar'
       implementation 'com.apxor.androidx:surveys:1.3.1@aar'
   
       // Add this to track application crashes
       implementation 'com.apxor.androidx:apxor-android-crash-reporter:1.0.5@aar'
   
       // Helper plugin to create walkthroughs
       implementation 'com.apxor.androidx:wysiwyg:1.1.9@aar'
   
       // Add this to execute Client Functions
       implementation 'com.apxor.androidx:apxor-cf:1.0.0@aar'
   
       // Add this to log events without attributes at runtime
       implementation 'com.apxor.androidx:jit-log:1.0.0@aar'
   
       // Getting a "Could not find" error? Make sure that you've added
       // Apxor's Maven repository to your root-level build.gradle file
   }
   

3. Create plugins.json file in your assets folder (usual path is src/main/assets/plugins.json) and add required JSON configs in it.

   For every plugin dependency you add in dependencies section, there will be a corresponding entry in this file.

   • If an entry for plugin exists in this file and the corresponding dependency doesn't exist in the dependencies section of app/build.gradle file, the SDK silently throws a ClassNotFoundException error log in logcat
   • If the dependency exists in dependencies section of app/build.gradle file and the corresponding entry doesn't exist in this file, that plugin will not initialize at runtime.

   {
     "plugins": [
       {
         "name": "rtm",
         "class": "com.apxor.androidsdk.plugins.realtimeui.ApxorRealtimeUIPlugin"
       },
       {
         "name": "crash",
         "class": "com.apxor.androidsdk.plugins.crash.CrashReporterPlugin"
       },
       {
         "name": "push",
         "class": "com.apxor.androidsdk.plugins.push.PushPlugin"
       },
       {
         "name": "surveys",
         "class": "com.apxor.androidsdk.plugins.survey.SurveyPlugin"
       },
       {
         "name": "wysiwyg",
         "class": "com.apxor.androidsdk.plugins.wysiwyg.WYSIWYGPlugin"
       },
       {
         "name": "cf",
         "class": "com.apxor.androidsdk.plugins.cf.ApxorCFPlugin"
       },
       {
         "name": "jitlog",
         "class": "com.apxor.androidsdk.plugins.jitlog.ApxorJITLogPlugin"
       }
     ]
   }
   

   Note

   • If you would like to track uninstalls, you must include apxor-android-sdk-push dependency in app/build.gradle file and corresponding JSON object in assets/plugins.json file
   • Apxor sends silent push notifications to track uninstalls. Please make sure you handle push notifications which will be sent with your SENDER_ID and ignore all notifications other than your SENDER_ID

4. Enable Apxor Push notifications [Optional]

   If you are not using FirebaseMessagingService, you can skip this step. Otherwise, add the following

   public class MyFirebaseMessagingService extends FirebaseMessagingService {
       @Override
       public void onMessageReceived(RemoteMessage remoteMessage) {
           if (remoteMessage.getFrom().equals(YOUR_FCM_SENDER_ID)) {
               // Push Notification receiver with your Sender Id
           } else {
               // Check if Push Notification received from Apxor
               if (ApxorPushAPI.isApxorNotification(remoteMessage)) {
                   ApxorPushAPI.handleNotification(remoteMessage, getApplicationContext());
               } else {
                   // Silent or Data push notification which you can send through Apxor dashboard
               }
           }
       }
    }
   

Ensuring ApxorSDK is initialised successfully

• Lookout for the following log in logcat,

  ApxorSDK(v2**) successfully initialized for: APP_ID
  

• By default, only error logs are enabled. To see debug logs, run the below command in terminal

adb shell setprop log.tag.Apxor VERBOSE

command in terminal.

Note

Apxor uploads data only when the app is minimized to the background. If you are running from Android Studio (emulators or devices), do not stop the app, just press on the "home" button in order for data to be uploaded.

API Guide

Read API Guide here