Custom Push Notification Click Event

This document describes the default behavior of IMLib when handling user clicks on remote notifications, and how applications can customize the handling of remote push notification click events.

tip

This document only describes the handling of remote push notification click events. If you are unsure how to distinguish between local notifications and remote push notifications, you can read the knowledge base article Understanding Real-time Messages, Local Notifications, and Remote Push Notifications in Instant Messaging (Android).

Implementing SDK Default Jump Behavior

IMLib handles remote push notification click events by default. When a user clicks a notification, the SDK sends a corresponding implicit Intent. You need to configure an Intent-filter in your app's manifest file (AndroidManifest.xml) to receive the Intent and complete the default jump action.

• Notifications from a single contact: When a user clicks one or more notifications from a single contact, the SDK defaults to jumping to the conversation Activity.
• Collapsed notifications from multiple contacts: When multiple contacts send multiple notifications, these notifications are displayed in a collapsed form. When a user clicks a notification from multiple contacts, the SDK defaults to jumping to the conversation list Activity.
• Push-only notifications: When a user clicks a Push-only notification, the SDK also sends an implicit Intent. You can decide which Activity should receive this Intent.

Jump to the Corresponding Conversation Page

When a user clicks one or more notifications from a single contact, the SDK defaults to sending an Intent to jump to the conversation Activity.

Configure the following intent-filter in the conversation Activity in AndroidManifest.xml to jump to the conversation Activity. If you have customized the conversation Activity, replace RongConversationActivity with the class name of your custom Activity.

<activity
android:name="RongConversationActivity"
android:exported="true">
<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <data
        android:host="${applicationId}"
        android:pathPrefix="/conversation"
        android:scheme="rong" />
</intent-filter>
</activity>

Jump to the Conversation List Page

When multiple contacts send multiple notifications, these notifications are displayed in a collapsed form. When a user clicks a notification from multiple contacts, the SDK defaults to sending an Intent to jump to the conversation list Activity.

Configure the following intent-filter in the conversation list Activity in AndroidManifest.xml to jump to the current Activity. If you have customized the conversation list Activity, replace RongConversationListActivity with the class name of your custom Activity.

<activity
android:name="RongConversationListActivity"
android:exported="true">
<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <data
        android:host="${applicationId}"
        android:pathPrefix="/conversationlist"
        android:scheme="rong" />
</intent-filter>
</activity>

Handling Push-only Notification Click Jumps

Push-only notifications initiated through RC are displayed independently. When a user clicks a Push-only notification, the SDK sends an Intent by default.

Configure the following in AndroidManifest.xml to jump to the Activity you specify.

<activity
android:name="Custom Activity"
android:exported="true"
android:launchMode="singleTask"
android:screenOrientation="portrait">

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />

    <data
        android:host="${applicationId}"
        android:pathPrefix="/push_message"
        android:scheme="rong" />
</intent-filter>
</activity>

Customizing Notification Click Jump Behavior

If the default jump behavior does not meet your needs, you can modify the jump behavior when clicking push notifications through either of the following methods:

• Set PushEventListener and override the onNotificationMessageClicked method (recommended).
• Inherit PushMessageReceiver and override the onNotificationMessageClicked method.

Setting PushEventListener

tip

• Starting from version 5.2.1 of the development SDK, all push types support using PushEventListener to customize the jump behavior when clicking notifications.
• Starting from version 5.1.9.2 of the stable SDK, all push types support using PushEventListener to customize the jump behavior when clicking notifications.
• Due to the notification trampoline restrictions in Android 12, when your app's targetVersion >= 31, it is recommended to directly start the Activity in the callback of RongPushClient.setPushEventListener. Do not distribute the message through a broadcast or service before starting the Activity.

You can set PushEventListener in the onCreate method of your Application, override the onNotificationMessageClicked method, and listen for and intercept push notification click events.

RongPushClient.setPushEventListener(
                new PushEventListener() {
                    @Override
                    public boolean preNotificationMessageArrived(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        // This callback is only effective for passthrough messages. Return true to intercept, false to not intercept.
                        return false;
                    }

                    @Override
                    public void afterNotificationMessageArrived(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        // This callback is only effective for passthrough messages.
                    }

                    @Override
                    public boolean onNotificationMessageClicked(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        // Users can define their own notification click event logic here. Return true to intercept, false to not intercept.
                        return false;
                    }

                    @Override
                    public void onThirdPartyPushState(
                            PushType pushType, String action, long resultCode) {}
                });

Using PushMessageReceiver

You can also customize click events through the onNotificationMessageClicked method of PushMessageReceiver. This method has a lower priority than PushEventListener.

tip

• Click events for Huawei and Oppo push notifications cannot be customized through the PushMessageReceiver method.
• Due to the notification trampoline restrictions in Android 12, when your app's targetVersion >= 31, it is recommended to directly start the Activity in the callback of PushMessageReceiver. Do not distribute the message through a broadcast or service before starting the Activity.

1. Create CustomPushMessageReceiver by inheriting the PushMessageReceiver class.

   class CustomPushMessageReceiver extends PushMessageReceiver {
       ...
   }
   

2. Register the push broadcast receiver component in the AndroidManifest.xml of your main project. Please replace the existing PushMessageReceiver registration content in AndroidManifest.xml.

     <receiver
               android:name="xxx.CustomPushMessageReceiver"
               android:exported="true">
               <intent-filter>
                   <action android:name="io.rong.push.intent.MESSAGE_ARRIVED" />
                   <action android:name="io.rong.push.intent.MESSAGE_CLICKED" />
                   <action android:name="io.rong.push.intent.THIRD_PARTY_PUSH_STATE" />
               </intent-filter>
           </receiver>

3. After registering the broadcast, you can override the onNotificationMessageClicked method in the CustomPushMessageReceiver class. Implement your jump logic in this method after interception.

   Parameter Description

   Parameter	Type	Required	Description
   context	Context	Yes	Context object
   pushType	PushType	Yes	Push type
   notificationMessage	PushNotificationMessage	Yes	Push message

   class CustomPushMessageReceiver extends PushMessageReceiver {
       @Override
       public boolean onNotificationMessageClicked(Context context, PushType pushType, PushNotificationMessage notificationMessage) {
           // You can determine the push type through pushType
           // Click events for Huawei and Oppo push notifications will not call back to this method. You need to parse the intent in the corresponding activity according to their respective configuration methods.
   
           if (pushType == PushType.XIAOMI) {
               // Implement your custom notification click jump logic
               return true; // Return true here to prevent the SDK's default implementation from being triggered, and handle the notification click jump event yourself.
           } else if (pushType == PushType.MEIZU) {
               // Implement your custom notification click jump logic
               return true; // Return true here to prevent the SDK's default implementation from being triggered, and handle the notification click jump event yourself.
           } else if (pushType == PushType.VIVO) {
               // Implement your custom notification click jump logic
               return true; // Return true here to prevent the SDK's default implementation from being triggered, and handle the notification click jump event yourself.
           } else if (pushType == PushType.GOOGLE_FCM) {
               // Implement your custom notification click jump logic
               return true; // Return true here to prevent the SDK's default implementation from being triggered, and handle the notification click jump event yourself.
           } else if (pushType == PushType.RONG) {
               // Implement your custom notification click jump logic
               return true; // Return true here to prevent the SDK's default implementation from being triggered, and handle the notification click jump event yourself.
           }
           return false;
       }
   }