Required Dependencies and Permissions

09 Feb 2024
2 Minutes to read

Required Dependencies and Permissions

Updated on 09 Feb 2024
2 Minutes to read

Article Summary

Share feedback

Thanks for sharing your feedback!

This guide helps you understand the requirements for SDK setup, native steps, required dependencies and permissions.

Required for Setup

An Android device or emulator with minimum APi 19
A Google / Firebase Cloud Messaging Server Key and google-services.json imported in your app
Android Studio

your title goes here

Your project needs to support AndroidX libraries.

Android Native Steps

1. Open your project level build.gradle file.
2. Add google-services inside of your project dependencies.
3. Add https://mobilesdk.useinsider.com/android inside of repositories for all projects.

Your title goes here

If you do not want to target Huawei devices, remove Huawei dependencies.

buildscript {
    repositories {        
        google()        
        jcenter()        
        maven { url "https://developer.huawei.com/repo/"}    
    }    
    dependencies {
        classpath 'com.android.tools.build:gradle:4.0.0'        
        classpath 'com.google.gms:google-services:4.3.3'        
        classpath 'com.huawei.agconnect:agcp:1.2.1.301'    
    }
}
allprojects {
    repositories {        
        google()        
        jcenter()        
        maven {url "https://mobilesdk.useinsider.com/android"}        
        maven {url "https://developer.huawei.com/repo/"}    
    }
}
task clean(type: Delete) {
    delete rootProject.buildDir
}

4. Open your module level build.gradle file.
5. Declare manifestPlaceholders inside android > defaultConfig with your Insider partner name.

android {
...
   defaultConfig {
       // DO NOT FORGET to change your_partner_name.
       // Use only lowercase and your_partner_name is provided by Insider.
       manifestPlaceholders = [partner:"your_partner_name"]
...
   }
...
}

6. Add "single task" as launchMode on your main activity in AndroidManifest.xml file.

AndroidManifest.xml:

android:launchMode="singleTask"

Your title goes here

<uses-permission android:name="android.permission.WAKE_LOCK"/> is optional.

Required Only For React Native and Flutter SDKs

1. Remove android:allowBackup="false" from your AndroidManifest.xml file.

2. If you are using proguard, add the following lines to your proguard-rules.pro file.

-keep class com.useinsider.insider.Insider { *; }

-keep interface com.useinsider.insider.InsiderCallback { *; }
-keep class com.useinsider.insider.InsiderUser { *; }
-keep class com.useinsider.insider.InsiderProduct { *; }
-keep class com.useinsider.insider.InsiderEvent { *; }
-keep class com.useinsider.insider.InsiderCallbackType { *; }
-keep class com.useinsider.insider.InsiderGender { *; }
-keep class com.useinsider.insider.InsiderIdentifiers { *; }

-keep interface com.useinsider.insider.RecommendationEngine$SmartRecommendation { *; }
-keep interface com.useinsider.insider.MessageCenterData { *; }
-keep class com.useinsider.insider.Geofence { *; }
-keep class com.useinsider.insider.ContentOptimizerDataType { *; }
-keep class org.openudid.** { *; }
-keep class com.useinsider.insider.OpenUDID_manager { *; }