MoEngage SDK allows the client application to optionally customize the notification display and extend/customize the behavior of the notification. Some of the possible customizations are deciding whether to show a notification or not, and tweaking the NotificationCompat.Builder object, etc. To do so you need to extend a class called PushMessageListener provided by the MoEngage SDK and pass on the instance of this class to the MoEngage SDK. Once you have done this you can override the default implementation as per the requirement. Let's look at the above steps in more detail.

Extending PushMessageListener

The first thing required to customize the notification is creating a class that extends PushMessageListener, we will call this class CustomPushMessageListener (only for illustration purposes you can have any class name you want). The barebones of this class would look something like below.

class CustomPushMessageListener : PushMessageListener() {
}

public class CustomPushMessageListener extends PushMessageListener {
}

Passing the instance of CustomPushMessageListener to MoEngage SDK

You need to pass on the instance of CustomPushMessageListener to the MoEngage SDK in the onCreate() of the Application class. You need to pass the instance to MoEPushHelper.getInstance().registerMessageListener() API. A sample call is described.

MoEPushHelper.getInstance().registerMessageListener(CustomPushMessageListener())

MoEPushHelper.getInstance().registerMessageListener(new CustomPushMessageListener());

Optionally control notification display

To control whether a notification is shown to the user or not, you need to override isNotificationRequired() in the CustomPushMessageListener class created above.
If you intend to show the notification overridden, the implementation should return true or false.

The structure for implementation is described as follows:
If this method returns false, this notification is discarded by the SDK; that is, the notification will not be displayed on the device, and the impression will not be tracked.

class CustomPushMessageListener : PushMessageListener() {

  // decide whether notification should be shown or not.
  override fun isNotificationRequired(context: Context, payload: Bundle): Boolean {
      // app's logic to decide whether to show notification or not.
      // for illustration purpose reading notification preference from SharedPreferences and
      // deciding whether to show notification or not. Logic can vary from application to
      // application.
      val preferences = context.getSharedPreferences("demoapp", 0)
      return preferences.getBoolean("notification_preference", true)
  }
}

public class CustomPushMessageListener extends PushMessageListener {
  // decide whether a notification should be shown or not.
  @Override public boolean isNotificationRequired(Context context, Bundle payload) {
    // app's logic to decide whether to show a notification or not.
    //For illustration purposes reading notification preference from SharedPreferences and
    // deciding whether to show a notification or not. Logic can vary from application to
    // application.
    SharedPreferences preferences = context.getSharedPreferences("demoapp", 0);
    return preferences.getBoolean("notification_preference", true);
  }
}

For more information, refer to API Reference.

Notification Received Callback

To receive a callback whenever a push is received, override the onNotificationReceived() in the CustomPushMessageListener class.

class CustomPushMessageListener : PushMessageListener() {
  override fun onNotificationReceived(context: Context, payload: Bundle) {
    super.onNotificationReceived(context, payload)
    //callback for push notification received.
  }
}

public class CustomPushMessageListener extends PushMessageListener {
  @Override public void onNotificationReceived(Context context, Bundle payload) {
    super.onNotificationReceived(context, payload);
    //callback for push notification received.
  }
}

Notification Clicked Callback

To receive a callback whenever a push is clicked, override the onNotificationClicked() in the CustomPushMessageListener class created as described in the Notification Received Callback.
This method doubles as a callback and can be used for handling redirection. If you want to handle redirection on notification, click the method should return true, or else false.

class CustomPushMessageListener : PushMessageListener() {
  override fun onNotificationClicked(activity: Activity, payload: Bundle) {
    // If you want to handle redirection on notification, click the method should return true, or else false.
    return false
  }
}

public class CustomPushMessageListener extends PushMessageListener {
  @Override public void onNotificationClicked(Activity activity, Bundle payload) {
    // If you want to handle redirection on notification, click the method should return true, or else false.
    return false;
  }
}

Notification Cleared Callback

To receive a callback whenever a push is cleared, override the onNotificationCleared() in the CustomPushMessageListener class created above.

public class CustomPushMessageListener extends PushMessageListener {
  @Override public void onNotificationCleared(Context context, Bundle payload) {
    super.onNotificationCleared(context, payload);
    // callback for notification cleared.
  }
}

public class CustomPushMessageListener extends PushMessageListener {
  @Override public void onNotificationCleared(Context context, Bundle payload) {
    super.onNotificationCleared(context, payload);
    // callback for notification cleared.
  }
}

Custom Action on Action Button Click

To use a custom action on the Action Button click override the handleCustomAction() in the CustomPushMessageListener class created above.

class CustomPushMessageListener : PushMessageListener() {
  override fun handleCustomAction(context: Context, payload: String) {
    super.handleCustomAction(context, payload)
    // callback for notification custom action
  }
}

public class CustomPushMessageListener extends PushMessageListener {
  @Override public void handleCustomAction(Context context, String payload) {
    super.handleCustomAction(context, payload);
    // callback for notification custom action
  }
}

Customize Notification

To further customize the notification object, override the customizeNotification(). This allows for additional settings to be added or modified, such as vibration patterns/LED colors, etc. It is important to note that the super method should be called before adding any customizations to ensure that the default settings are applied.

class CustomPushMessageListener : PushMessageListener() {

  override fun customizeNotification(notification: Notification, context: Context, payload: Bundle) {

    super.customizeNotification(notification, context, payload)

    // You can customize the `notification` object here

  }

}

public class CustomPushMessageListener extends PushMessageListener {

  @Override public void customizeNotification(Notification notification, Context context, Bundle payload) {

    super.customizeNotification(notification, context, payload);

    // You can customize the `notification` object here

  }

}

Customize Notification Builder

The SDK provides the customizeNotificationBuilder() callback to customize the notification builder object as needed. This feature allows developers to update various properties of the notification builder, such as the channel ID, the auto-dismiss time, etc. It is important to note that the super method should be called before adding any customizations to ensure that the default settings are applied.

class CustomPushMessageListener : PushMessageListener() {

  override fun customizeNotificationBuilder(notificationBuilder: NotificationCompat.Builder, context: Context, notificationPayload: NotificationPayload) {

    super.customizeNotificationBuilder(notificationBuilder, context, notificationPayload)

    // You can customize the `notificationBuilder` object here

  }

}

public class CustomPushMessageListener extends PushMessageListener {

  @Override public void customizeNotificationBuilder(Notification notification, Context context, NotificationPayload notificationPayload) {

    super.customizeNotificationBuilder(notification, context, payload);

    // You can customize the `notificationBuilder` object here

  }

}