com.emarsys:common

common module of the EmarsysSDK


Keywords
android, emarsys-sdk, mobilesdk
License
MPL-2.0

Documentation

build

Contents

What is the Emarsys SDK?

The Emarsys SDK enables you to use Mobile Engage and Predict in a very straightforward way. By incorporating the SDK in your app, we, among other things, support you in handling credentials, API calls, tracking of opens and events as well as logins and logouts in the app. The Emarsys SDK is open-sourced to enhance transparency and to remove privacy concerns. This also means that you will always be up-to-date with what we are working on.

Using the SDK is also beneficial from the product aspect: it simply makes it much easier to send push messages through your app. Please always use the latest version of the SDK in your app.

1. Setup

1.1 Sample app

We created a sample application to help in the integration and give an example. Find instructions for the build process here.

1.2 Installation with Gradle

Gradle is a build system for Android, which automates and simplifies the process of using 3rd-party libraries.

1.3 Add Gradle dependency

To integrate EmarsysSDK into your Android project using Gradle, specify it in your application's build.gradle file:

dependencies {
	implementation 'com.emarsys:emarsys-sdk:‹latest_released_version_of_emarsys-sdk›'
}

2. Requirements

  • The minimum Android version should be at least API level 21.
  • Requires compileSdkVersion 28 or higher.
  • Emarsys SDK is using AndroidX.

2.1 Using AndroidX

See Migrating to AndroidX to learn how to migrate an existing project.

If you want to use Emarsys SDK in a new project, you need to set the compile SDK to Android 9.0 (API level 28) or higher and set both of the following Android Gradle plugin flags to true in your gradle.properties file.

android.useAndroidX: When set to true, the Android plugin uses the appropriate AndroidX library instead of a Support Library. The flag is false by default if it is not specified.

android.enableJetifier: When set to true, the Android plugin automatically migrates existing third-party libraries to use AndroidX by rewriting their binaries. The flag is false by default if it is not specified.

2.2 Push Notifications

Emarsys SDK supports multiple push providers(Firebase, Huawei). Integrating both, or one of them is necessary for using the Mobile Engage Push feature.

If you want to support both providers, you can include both of them in your application.

You can set a custom notification icon, by specifying it as a meta-data between your application tag:

<meta-data
android:name="com.emarsys.mobileengage.small_notification_icon"
android:resource="@drawable/notification_icon" />

2.2.1 Firebase

When the pushToken arrives we need to set it using Emarsys.Push.setPushToken(). For more information about how to obtain your FCM token please consult the Firebase integration guides:

The recommended way of using the SDK is to enable the Emarsys SDK to automatically handle setPushToken and trackMessageOpen calls for you, please register this service in your manifest:

<service android:name="com.emarsys.service.EmarsysFirebaseMessagingService"
         android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
    </intent-filter>
</service>

If it is needed, you can add your custom implementation to handle setPushToken and trackMessageOpen.

Java
public class MyMessagingService extends FirebaseMessagingService {

    @Override
    public void onNewToken(String token) {
        super.onNewToken(token);

        Emarsys.Push.setPushToken(token);
    }

    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
    super.onMessageReceived(remoteMessage);

        boolean handledByEmarsysSDK = EmarsysFirebaseMessagingServiceUtils.handleMessage(this, remoteMessage);

        if (!handledByEmarsysSDK) {
            //handle your custom push message here
            ...
        }
    }
}
Kotlin
class MyMessagingService : FirebaseMessagingService() {

    override fun onNewToken(token: String?) {
        super.onNewToken(token)
        Emarsys.Push.setPushToken(token!!)
    }

    override fun onMessageReceived(remoteMessage: RemoteMessage?) {
        super.onMessageReceived(remoteMessage)
        val handledByEmarsysSDK =
        EmarsysFirebaseMessagingServiceUtils.handleMessage(this, remoteMessage)
        if (!handledByEmarsysSDK) {
            //handle your custom push message here
            ...
        }
    }
}

2.2.2 Huawei

Important Note: Push sending for Huawei is unavailable for devices below API level 22!

Huawei Push Messaging is only available from Emarsys SDK 3.0.0!

Emarsys SDK checks if the device has Google Play Services available and if not, it is considered as a Huawei device. Please note that as Google Play Services is not availeble with Huawei only integrations, Geofencing will not work!

When the pushToken arrives we need to set it using Emarsys.Push.setPushToken(). For more information about how to obtain your HMS token please consult the Huawei integration guides:

The recommended way of using the SDK is to enable the Emarsys SDK to automatically handle setPushToken and trackMessageOpen calls for you, please register this service in your manifest:

<meta-data
    android:name="com.huawei.hms.client.channel.androidMarket"
    android:value="false" />
<meta-data
android:name="push_kit_auto_init_enabled"
android:value="true" />
<service
    android:name="com.emarsys.service.EmarsysHuaweiMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.huawei.push.action.MESSAGING_EVENT"/>
    </intent-filter>
</service>

If it is needed, you can add your custom implementation to handle setPushToken and trackMessageOpen.

Java
public class MyMessagingService extends HmsMessageService {

    @Override
    public void onNewToken(String token) {
        super.onNewToken(token);

        Emarsys.Push.setPushToken(token);
    }

    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
    super.onMessageReceived(remoteMessage);

        boolean handledByEmarsysSDK = EmarsysHuaweiMessagingServiceUtils.handleMessage(this, remoteMessage);

        if (!handledByEmarsysSDK) {
            //handle your custom push message here
            ...
        }
    }
}
Kotlin
class MyMessagingService : HmsMessageService() {

    override fun onNewToken(token: String?) {
        super.onNewToken(token)
        Emarsys.Push.setPushToken(token!!)
    }

    override fun onMessageReceived(remoteMessage: RemoteMessage?) {
        super.onMessageReceived(remoteMessage)
        val handledByEmarsysSDK =
        EmarsysHuaweiMessagingServiceUtils.handleMessage(this, remoteMessage)
        if (!handledByEmarsysSDK) {
            //handle your custom push message here
            ...
        }
    }
}

For further informations about how to use our SDK please visit our Documentation