Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

nearit/Android-SDK

Repository files navigation

NearIT Android SDK

NearIT allows to engage app users by sending context-aware targeted content.

API license Download CircleCI Documentation Status

Recipes

NearIT allows to manage apps by defining recipes. Those are simple rules made of 3 ingredients:

  • WHO: define the target users
  • WHAT: define what action NearIT should do
  • TRIGGER: define when the action should be triggered

How it works

NearIT web interface allows you to configure all the features, in a snap. Once the settings are configured, everyone - even people without technical skills - can manage context-aware mobile contents.

NearIT SDK synchronize with servers and behave accordingly to the settings and the recipes. Any content will be delivered at the right time, you just need to handle its presentation.

Installation

Minimum Requirements:

  • Android API level: 16+

To start using the SDK, include this in your app build.gradle

dependencies {
    compile 'it.near.sdk:nearit:2.12.5'
}

In AndroidManifest.xml, add the following element as a child of the <application> element, by inserting it just before the closing </application> tag:

<meta-data
       android:name="near_api_key"
       android:value="<your-near-api-key>" />

then, re-build your application.

In your app, you can access the NearItManager instance with

NearItManager.getInstance()

Integration guide

For information on how to integrate all NearIT features in your app, follow the integration guide

Migration

If you are upgrading your NearIt dependency from 2.1.x follow this guide