Integrate FCM (for Android)

Google FCM (Firebase Cloud Messaging) is a cross-platform messaging solution that lets you reliably deliver messages.

Before using ZIM SDK's offline push notification feature, please implement the Google FCM push notification first by referring to this document.

Prerequisites

Before the push notification implementation using FCM, make sure you complete the following:

• Your mobile device supports the GMS (Google Mobile Services), and has connected to the network.

• Integrate the latest version of ZIM SDK. For details, see Getting Started - Integrate the SDK.

• Integrate the ZPNs SDK. For more, refer to the Implement offline push notification.

• Complete the Firebase-related steps below:

  1. Go to Firebase, log in with your Google account.

  2. Select Add project, and complete the project information.

     

  3. Click on the area shown below.

     

  4. Click the button shown below to create an Android application.

     

  5. Enter your Application's package name, and click Register App.

     

  6. Download a google-services.json file. And move the downloaded google-services.json file into your Android app module root directory when integrating the SDK.

     

Implementation steps

Add the FCM push notification to the Android app

1. In the root level build.gradle file, configure Google's Maven repository for adding Google dependencies.

   <project>/build.gradle

   buildscript {
       repositories {
           // Check that you have the following line (if not, add it):
           google()  // Google's Maven repository
       }
       dependencies {
           ...
           // Add this line
           classpath 'com.google.gms:google-services:4.3.10'
   
       }
   }
   
   allprojects {
       ...
       repositories {
           // Check that you have the following line (if not, add it):
           google()  // Google's Maven repository
           ...
       }
   }
   

   1

   Copied!

2. In the module level build.gradle file, add the Firebase-related dependencies.

   <project>/<app module>/build.gradle

   apply plugin: 'com.android.application'
   
   // Add this line
   apply plugin: 'com.google.gms.google-services'
   
   dependencies {
       // Import the Firebase BoM
       implementation platform('com.google.firebase:firebase-bom:29.3.1')
   
       // Add the dependency for the Firebase SDK for Google Analytics
       // When using the BoM, don't specify versions in Firebase dependencies
       implementation 'com.google.firebase:firebase-analytics'
   
       // Add the dependencies for any other desired Firebase products
       // https://firebase.google.com/docs/android/setup#available-libraries
   }
   

   1

   Copied!

3. In the module level build.gradle file (path: <project>/<app module>/build.gradle), adding the Google notification dependencies.

   Untitled

   implementation 'com.google.firebase:firebase-messaging:21.1.0'
   

   1

   Copied!

5. Preventing code obfuscation

   Add a -keep rule in the "proguard-rules.pro" file to protect the public classes of the FCM SDK from being obfuscated, ensuring the normal operation of FCM features.

   Untitled

   -dontwarn com.google.**
   -keep class com.google.** {*;}
   

   1

   Copied!

In this case, you have added the FCM push notification to your Android app project.

Now, all you have left to do is go to the ZEGOCLOUD Admin Console to authorize the FCM. Check the following:

Add FCM credentials on Admin Console

1. Get a Firebase service account credential

   The android project supports a Google service account, so you will need to get credential files using your Google service account, and allow ZEGOCLOUD Server to call the Firebase server API.

   Suggested steps:
   Go to Firebase Project Settings > Service accounts.
   Click the Generate new private key, then confirm by clicking Generate Key.

   

2. Upload FCM credentials

   Log in to the ZEGOCLOUD Admin Console, select Service Management > In-app Chat tab, and add FCM credentials in the Notification configuration session.

At this point, you have completed the configuration of the FCM offline push notification.