Push Token Registration and Display

This page applies to MoEngage Android SDK 15.03.00 and above. For versions below 15.03.00, refer to Push Token Registration and Display (Legacy).If you are upgrading an existing integration, refer to Migrating to Firebase Installation ID.

Prerequisites

Complete the following setup before you begin:

Create a Firebase project for your application and add the google-services.json configuration file. Refer to the Firebase Android setup guide.
Use com.google.firebase:firebase-messaging 25.1.2 or higher. This is the minimum version required for the Firebase Installation ID.
Generate FCM credentials and add them to the MoEngage dashboard. Refer to FCM Authentication and Push Configuration.

Overview

MoEngage Android SDK 15.03.00 registers devices for push using the Firebase Installation ID. Two flows are available, depending on which component generates the Installation ID:

Flow 1: MoEngage Handles Installation ID Generation describes the steps required for the MoEngage SDK to generate the Installation ID and display the notification.
Flow 2: The Application Handles Installation ID Generation describes the steps required for your application to generate the Installation ID and pass it to the MoEngage SDK.

Flow 1: MoEngage Handles Installation ID Generation

CriticalDeclare only one service with the com.google.firebase.MESSAGING_EVENT intent filter in your application manifest file. If the manifest declares more than one such service, only the first service receives the callback. The MoEngage SDK then never receives the push payload, and delivery rates decline.

Step 1: Declare the MoEngage Messaging Service

Add MoEFireBaseMessagingService to the manifest file.

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

Step 2: Enable the Firebase Installation ID

Add the following metadata to the manifest file.

<meta-data
    android:name="firebase_messaging_installation_id_enabled"
    android:value="true" />

Register for the Installation ID (Optional)

Call the registerForInstallationId() API after MoEngage SDK initialization completes, so that the SDK registers for an Installation ID. This call is required only in the following cases:

Firebase auto-initialization is disabled in your application. Refer to the Firebase documentation on preventing auto initialization.
MoEngage SDK initialization is delayed, for example when your application initializes the SDK on a worker thread instead of in the onCreate() method of the Application class.

import com.moengage.firebase.MoEFireBaseHelper

MoEFireBaseHelper.getInstance().registerForInstallationId(context)

import com.moengage.firebase.MoEFireBaseHelper;

MoEFireBaseHelper.getInstance().registerForInstallationId(context);

This API does not register an Installation ID if your application has opted out of MoEngage registration.

Get the Installation ID (Optional)

Apply one of the following options if your application needs to read the Installation ID that MoEngage generates.

Option 1: Get the Installation ID Asynchronously

Register an InstallationIdAvailableListener in your Application class using the addInstallationIdListener() API. The SDK triggers the callback only for an Installation ID that it generates or updates after you register the listener. Call removeInstallationIdListener() to stop receiving the callback.

import com.moengage.firebase.MoEFireBaseHelper

MoEFireBaseHelper.getInstance().addInstallationIdListener { result -> }

import com.moengage.firebase.MoEFireBaseHelper;

MoEFireBaseHelper.getInstance().addInstallationIdListener(result -> {});

Option 2: Get the Installation ID Synchronously

Call the getInstallationId() API from a worker thread. The API returns null if the Installation ID is not available when you call it.

import com.moengage.firebase.MoEFireBaseHelper

// Call this from a worker thread.
MoEFireBaseHelper.getInstance().getInstallationId(context)

import com.moengage.firebase.MoEFireBaseHelper;

// Call this from a worker thread.
MoEFireBaseHelper.getInstance().getInstallationId(context);

Push Display for Non-MoEngage Payloads (Optional)

Implement this callback if your application handles notifications that originate outside MoEngage. When you declare the SDK service in your manifest file, the SDK provides a callback for each push payload it receives from a server other than the MoEngage platform. Implement the NonMoEngagePushListener interface and register it in the onCreate method using MoEFireBaseHelper.getInstance().addNonMoEngagePushListener(). Register the callback in the onCreate() method of your Application class, because the SDK can invoke it while the application is in the background.

Flow 2: The Application Handles Installation ID Generation

Skip this section if the MoEngage SDK generates the Installation ID.

Step 1: Opt Out of MoEngage Push Token Registration

The MoEngage SDK registers for push by default. If your application generates the Installation ID, opt out of MoEngage registration first. Disable token registration through the configureFcm() API on the MoEngage.Builder object.

val moEngage = MoEngage.Builder(
        application = this,
        appId = "YOUR_WORKSPACE_ID",
        dataCenter = DataCenter.DATA_CENTER_X
    )
    .configureNotificationMetaData(
        NotificationConfig(
            smallIcon = R.drawable.small_icon,
            largeIcon = R.drawable.large_icon,
            notificationColor = R.color.notiColor,
            isMultipleNotificationInDrawerEnabled = false,
            isBuildingBackStackEnabled = false,
            isLargeIconDisplayEnabled = true
        )
    )
    .configureFcm(FcmConfig(isRegistrationEnabled = false))
    .build()
MoEngage.initialiseDefaultInstance(moEngage)

MoEngage moEngage = new MoEngage.Builder(this, "YOUR_WORKSPACE_ID", DataCenter.DATA_CENTER_X)
    .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, true, true, true))
    .configureFcm(new FcmConfig(false))
    .build();
MoEngage.initialiseDefaultInstance(moEngage);

Set up the Installation ID in your application. Refer to the Firebase documentation on accessing the Firebase Installation ID for the FCM setup.

Step 2: Pass the Installation ID to the MoEngage SDK

Your application must pass the Installation ID to the MoEngage SDK using the passInstallationId() API, because the MoEngage platform requires it to deliver notifications to the device.

import com.moengage.firebase.MoEFireBaseHelper

MoEFireBaseHelper.getInstance().passInstallationId(context, "INSTALLATION_ID")

import com.moengage.firebase.MoEFireBaseHelper;

MoEFireBaseHelper.getInstance().passInstallationId(context, "INSTALLATION_ID");

Step 3: Pass the Push Payload to the MoEngage SDK

Pass payloads from the MoEngage platform to the MoEngage SDK even when your application declares its own service, because the SDK renders the notification, including rich push notifications. Call the passPushPayload() API from the onMessageReceived() method of your Firebase service. Check whether the payload originates from the MoEngage platform using the isFromMoEngagePlatform() API before you pass it.

if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.data)) {
    MoEFireBaseHelper.getInstance().passPushPayload(applicationContext, remoteMessage.data)
} else {
    // Your application's logic for displaying its own notification.
}

if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.getData())) {
    MoEFireBaseHelper.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData());
} else {
    // Your application's logic for displaying its own notification.
}

Rich Landing

A rich landing page opens a web URL inside the application from a push campaign. This step is required to display rich landing pages, regardless of which component generates the Installation ID.

The following declaration is included in current SDK versions. Add it only if you need to change the parent activity of MoEActivity.

Add the following activity to the AndroidManifest.xml file.

<activity
  android:name="com.moe.pushlibrary.activities.MoEActivity"
  android:label="[ACTIVITY_NAME]"
  android:parentActivityName="[PARENT_ACTIVITY_NAME]" >
</activity>

Parameter	Description
`[ACTIVITY_NAME]`	The label that appears on the rich landing page.
`[PARENT_ACTIVITY_NAME]`	The parent activity of `MoEActivity`.

​Prerequisites

​Overview

​Flow 1: MoEngage Handles Installation ID Generation

​Step 1: Declare the MoEngage Messaging Service

​Step 2: Enable the Firebase Installation ID

​Register for the Installation ID (Optional)

​Get the Installation ID (Optional)

​Option 1: Get the Installation ID Asynchronously

​Option 2: Get the Installation ID Synchronously

​Push Display for Non-MoEngage Payloads (Optional)

​Flow 2: The Application Handles Installation ID Generation

​Step 1: Opt Out of MoEngage Push Token Registration

​Step 2: Pass the Installation ID to the MoEngage SDK

​Step 3: Pass the Push Payload to the MoEngage SDK

​Rich Landing

Prerequisites

Overview

Flow 1: MoEngage Handles Installation ID Generation

Step 1: Declare the MoEngage Messaging Service

Step 2: Enable the Firebase Installation ID

Register for the Installation ID (Optional)

Get the Installation ID (Optional)

Option 1: Get the Installation ID Asynchronously

Option 2: Get the Installation ID Synchronously

Push Display for Non-MoEngage Payloads (Optional)

Flow 2: The Application Handles Installation ID Generation

Step 1: Opt Out of MoEngage Push Token Registration

Step 2: Pass the Installation ID to the MoEngage SDK

Step 3: Pass the Push Payload to the MoEngage SDK

Rich Landing