Custom Push Notification Style

When a push notification is received, the system will pop up a notification to display the push message.

• FCM Push: For FCM push, if the Push Method set in the Console is Transparent Message, you can customize the notification style using the following methods.
• RC Self-built Push: You can customize the notification style using the following methods. However, due to its lower delivery rate, it is no longer recommended.
• Other Third-party Push: When the SDK receives push notifications from other third-party vendors, the notification popped up is a system notification, which is directly displayed by the underlying system of the phone. Therefore, customization is not supported.

Custom Notification Styles

If you are using FCM push and the Push Method configured in the FCM backend is Transparent Message, you can customize the notification style using the following methods.

Using PushEventListener

You can set up PushEventListener, override the preNotificationMessageArrived method, intercept the notification event, and customize the display.

tip

• This feature is supported starting from SDK version 5.1.0.
• Please register the listener in the onCreate method of the Application.
• Due to the notification trampoline restriction 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.

RongPushClient.setPushEventListener(
                new PushEventListener() {
                    @Override
                    public boolean preNotificationMessageArrived(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        // This callback only takes effect when the notification type is a transparent message. Return true to intercept, false to not intercept.
                        return false;
                    }

                    @Override
                    public void afterNotificationMessageArrived(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        // This callback only takes effect when the notification type is a transparent message.
                    }

                    @Override
                    public boolean onNotificationMessageClicked(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        // Users can define their own notification click event business 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 the FCM notification style using the onNotificationMessageArrived method of PushMessageReceiver. This method has a lower priority than PushEventListener.

tip

Due to the notification trampoline restriction 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 a custom YourCustomPushMessageReceiver and inherit PushMessageReceiver. In onNotificationMessageArrived (notification arrival event), you can receive the push content.

   public class YourCustomMessageReceiver extends PushMessageReceiver {
   
   @Override
   public boolean onNotificationMessageClicked(
           Context context, PushType pushType, PushNotificationMessage message) {
           if (pushType.equals(PushType.GOOGLE_FCM)){
   
           // TODO
           }
           // Return true to intercept, false to not intercept.
           return true;
   }
   }

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

     <receiver
               android:name="xxx.YourCustomPushMessageReceiver"
               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>