Automatically display and track push notification

This document describes how to automatically display and track push notifications using the AEPMessaging extension. You should use this method unless you have a specific requirement to manually display and track push notifications.

Pre-requisites

Integrate and register Messaging extension in your app.

Sync the push token

To retrieve the push token from Firebase Messaging Service, please follow the tutorial within the Firebase documentation. Then use setPushIdentifier API to sync the device's push token with profile in Adobe Experience Platform.

Copy
public class YourApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        FirebaseMessaging.getInstance().getToken().addOnCompleteListener(new OnCompleteListener<String>() {

            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (task.isSuccessful()) {
                    String token = task.getResult();
                    MobileCore.setPushIdentifier(token);
                }       
            }
        });
    }
}
Copied to your clipboard
public class YourApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        FirebaseMessaging.getInstance().getToken().addOnCompleteListener(new OnCompleteListener<String>() {

            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (task.isSuccessful()) {
                    String token = task.getResult();
                    MobileCore.setPushIdentifier(token);
                }       
            }
        });
    }
}

Display and track push notification

Register Messaging extension's FirebaseMessagingService

Messaging extension uses MessagingService to receive, display and track push notifications. To register the MessagingService add the following code to the AndroidManifest.xml file:

Copy
        <service
            android:name="com.adobe.marketing.mobile.messaging.MessagingService"
            android:exported="false">
            <intent-filter>
                <action android:name="com.google.firebase.MESSAGING_EVENT" />
            </intent-filter>
        </service>
Copied to your clipboard
        <service
            android:name="com.adobe.marketing.mobile.messaging.MessagingService"
            android:exported="false">
            <intent-filter>
                <action android:name="com.google.firebase.MESSAGING_EVENT" />
            </intent-filter>
        </service>

Using your own FirebaseMessagingService

If your application already registered a FirebaseMessagingService class, then you can use the following API to display and track push notifications originated from Adobe Journey Optimizer.

Copy
public class YourAppFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(@NonNull RemoteMessage remoteMessage) {
        if (MessagingService.handleRemoteMessage(this, message)) {
            // Push notification originated from Adobe Journey Optimizer is handled by the Messaging extension.
        } else {
            // Handle push notification originated from other sources.
        }       
    }
}
Copied to your clipboard
public class YourAppFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(@NonNull RemoteMessage remoteMessage) {
        if (MessagingService.handleRemoteMessage(this, message)) {
            // Push notification originated from Adobe Journey Optimizer is handled by the Messaging extension.
        } else {
            // Handle push notification originated from other sources.
        }       
    }
}

Notification channel

Notification channels were introduced in Android Oreo (API level 26). They allow you to group notifications and allows users to customize the notification preferences for each channel.

You must create at least one notification channel to display push notifications on devices running Android Oreo or higher. Follow the Android documentation to create and manage notification channels. Once a notification channel is created, you can use the channel ID while designing the push notification in Adobe Journey Optimizer.

Default channel: If you do not create a notification channel, or if the notification channel specified while designing the push notification does not match with any of the created channels, the Messaging extension will present the push notification through its predefined fallback notification channel, which is named "General Notifications."

Configuring small icon

Use MobileCore's API to set the small icon resource ID. This icon will be used as the small icon for all the incoming push notification from Adobe Journey Optimizer.

Copy
MobileCore.setSmallIconResourceId(R.drawable.ic_notification);
Copied to your clipboard
MobileCore.setSmallIconResourceId(R.drawable.ic_notification);

When no custom small icon is specified, the Messaging extension will automatically utilize the application's launcher icon as the default small icon.

Notification actions

Messaging extension will automatically handle any click behaviour that is configured while designing the push notification in Adobe Journey Optimizer or Assurance.