Set Up the Android SDK

Prev Next

Overview

To send and receive push notifications in Mapp Engage via Android, start by setting up the Android SDK.

Before you begin, make sure your project meets the requirements for your SDK version. Version-specific requirements are documented in Android SDK v7 and Android SDK v6.


Download

The Android SDK artifacts are available on Maven Central.

Use the artifact corresponding to the SDK version you want to integrate:


Dependencies

The SDK requires Firebase Cloud Messaging (FCM).

Use a Firebase BOM version compatible with your SDK version and Firebase setup. Refer to the respective SDK documentation (v6 or v7) for specific version requirements.


Gradle Setup

Add the following to your build.gradle:

Android SDK v7

implementation 'com.mapp.sdk:engage-android:7.x.x'
implementation platform('com.google.firebase:firebase-bom:<firebase-bom-version>')
implementation 'com.google.firebase:firebase-messaging'
implementation 'com.google.firebase:firebase-analytics'

Android SDK v6

implementation 'com.mapp.sdk:mapp-android:6.x.x'
implementation platform('com.google.firebase:firebase-bom:<firebase-bom-version>')
implementation 'com.google.firebase:firebase-messaging'
implementation 'com.google.firebase:firebase-analytics'

Use a Firebase BOM version compatible with your Firebase setup. For v7, see the SDK v7 requirements.

Maven

<dependency>
  <groupId>com.mapp.sdk</groupId>
  <artifactId>mapp-android</artifactId>
  <version>X.X.X</version>
</dependency>

Project Configuration

AndroidManifest.xml Permissions

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />

AndroidX Support

The SDK requires AndroidX. If needed, follow the official AndroidX migration guide.