Contact Us      Sign Up      Login
If you are using Gradle, please see the simplified integration guide. If you are not using Gradle, follow the steps below to integrate the Plot plugin into your app.
Step 1: Get The Library

Sign up and download the library from our dashboard.

Step 2: Implement Plot_v_.jar

Copy the file Plot_v_<version>.jar to the libs folder in your app project. When the project doesn’t have a folder named libs yet, then create the folder.

Step 3: Set minSdkVersion

Set the minSdkVersion version to at least 8. When using Gradle you can do that by changing build.gradle in the folder of your app.

defaultConfig {
    applicationId "com.myplotapplication"
    minSdkVersion 8
    targetSdkVersion 20
    versionCode 1
    versionName "1.0"
}
When you aren’t using Gradle you can set it using the uses-sdk tag inAndroidManifest.xml with the attributeandroid:minSdkVersion.
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<uses-sdk android:minSdkVersion="8" android:targetSdkVersion="20" />
Step 4: Add Permissions

 Add the following permissions to the manifest element in AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"><uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<uses-permission android:name="android.permission.VIBRATE"/>
Step 5: Add Boot Receiver

Add the following boot receiver to the applicationelement inAndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"><application><receiver android:name="com.plotprojects.retail.android.PlotBootReceiver">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED"/>
<action android:name="android.intent.action.QUICKBOOT_POWERON" />
<action android:name="com.htc.intent.action.QUICKBOOT_POWERON" />
<action android:name="android.intent.action.MY_PACKAGE_REPLACED" />
<action android:name="android.intent.action.ACTION_POWER_CONNECTED" />
<action android:name="android.intent.action.AIRPLANE_MODE" />
<category android:name="android.intent.category.HOME" />
</intent-filter>
</receiver>
Step 6: Add Service

Add the following service to the application element inAndroidManifest.xml

Please note the debug setting in the entry forPlotBackgroundService. Set the value to false to disable logging before releasing your app.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"><application><service android:name="com.plotprojects.retail.android.PlotBackgroundService">
<meta-data android:name="debug" android:value="true" />
</service>
Step 7: Add Provider

Add the following provider to the application element inAndroidManifest.xml

This enables you to retrieve the debug log when debug is enabled.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"><application><!--Replace [[App Package]] with your package name.-->
<provider
android:authorities="[[App Package]].plot.debuglogprovider"
android:name="com.plotprojects.retail.android.DebugLogProvider"
android:exported="true" />
Step 8: Specify Receiver

Specify the following receiver for the OpenNotificationintent. This intent is sent when the user taps on the notification.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"><application><receiver android:exported="false" android:name="com.plotprojects.retail.android.OpenUriReceiver">
<intent-filter>
<!--Replace [[App Package]] with your package name.-->
<action android:name="[[App Package]].plot.OpenNotification" />
</intent-filter>
</receiver>
In the end yourAndroidManifest.xml will look something like this:
Step 9: Specify Landing Page Activity

Specify the following activity for opening a landing page. This activity is opened when a user opens a notification that is marked as an in-app landing page.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"><application><activity
android:name="com.plotprojects.retail.android.LandingPageActivity"
android:configChanges="orientation|screenSize" />
Step 10: Configuration File

Plot uses a configuration file which you have to define asplotconfig.json in yourassets folder. An example of such a config file can be found on our dashboard, as well as the public token you will have to use.

{
    "publicToken": "REPLACE_ME",
    "enableOnFirstRun": true
}
Step 11: Almost Done!

Call Plot.init(context) to initialize the library from your main Activity. When calling init from an activity, you can use the this keyword as the first parameter.

public class MyActivity extends Activity {
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_my);
 
        Plot.init(this);
}
Step 12: Proguard

Add the following snippet to your Proguard configuration. The default filename for this is the proguard.cfg for Ant builds andproguard-rules.pro for Gradle based builds.

-dontwarn org.altbeacon.**

An example configuration file and your public token can be found on the Download page on our dashboard.You are now ready to receive your first notification. Need more help during testing, look at this guide.

For more details, look at the extensive documentation.