BAKit-android

BoardActive’s Android SDK


Engage and Retain Mobile Users

Connect with customers using BoardActive's exclusive location-based marketing technology.


Installation

BoardActive for Android supports APK 15 and greater.

 

SDK 

Download and add the BoardActive into your project using Jitpack Repository. Building with Android Studio is required. 

 

Dependencies

 Your app must include Google Play Services. Our Google Play Services Overview contains the full setup and initialization instructions. 

JitPack is the repository service that we use, you will add a few lines to the gradle files to import our SDK into your project. (Instructions are available upon request for Maven, sbt, leiningen)

/ Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.2.1'
        //Add the following to your Top-Level build.gradle
        classpath 'com.google.gms:google-services:4.1.0'
    }
}
// Add JitPack repository to top level build.gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}

Include the following into your App-level build.gradle

dependencies {...// This line imports the BoardActive Android SDK to your project, it acts as if you added our source code to your projectimplementation 'com.github.BoardActive:backpack-android:-SNAPSHOT'...}


How to Use This SDK


Permissions

BoardActive will ask for your user location permissions on the first time it launches.


Firebase Cloud Messaging

You should have installed Firebase Cloud Messaging to your app so it can receive BoardActive notifications.
 

Launch BAKit Service

Include the following into your MainActivity.java

private BoardActive mBoardActive;

    public final static String APP_KEY = "ADD_APP_KEY_HERE";
    public final static String APP_ID = "ADD_APP_ID_HERE";
    public final static String APP_VERSION = Build.VERSION.RELEASE;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Instantiate BoardActive
mBoardActive = new BoardActive(MainActivity.this);

        // Retrieve Firebase Token
        String fcmToken = FirebaseInstanceId.getInstance().getToken();
     
      //Initialize BoardActive
        mBoardActive.initialize(
          fcmToken,
          APP_KEY,
          APP_ID,
          APP_VERSION
        );

      //Register Device
        mBoardActive.RegisterDevice(new BoardActive.RegisterCallback() {
            @Override
            public void onResponse(Object value) {
                Log.d("RegisterDevice", value.toString());
            }
        }, null);
    }


Example App

There is an example app provided for Android here.


Setup and Configuration

[TODO] Our installation guide contains full setup and initialization instructions.
[TODO] Read "Configuring BoardActive for Android".[TODO] Read our guide on PushNotifications. Please contact us on BoardActive with any questions you may have, we're only a click away! 


Customer Support

👋 [TODO] Contact us with any issues at our BoardActive Developer Hub available here. If you bump into any problems or need more support, just start a conversation using Intercom there and it will be immediately routed to our Customer Support Engineers.


Cordova/Phonegap Support

[TODO] Looking for Cordova/Phonegap support? We have a Cordova Plugin for BoardActive 🎉

 

What About X, Y, or Z?

BoardActive for Android has support for everything you need. For full details please read our documentation.

 

Did this answer your question?