Push Notification

Overview

You can set up push notifications to notify your end users for incoming chat messages. For managing push notifications, you must have a Firebase account.

Obtain server key from firebase

If you already have a Firebase account and code to retrieve firebase registration token for the client app instance, then skip this step.

  1. If you haven't already added firebase to your project, add Firebase to your Android project

  2. Once you're done with above setup, For getting FCM server key from firebase click Settings icon --> Project settings

firebase_fcm_1.png

  1. Once you clicked project settings select Cloud Messaging tab under Settings. Under Project Credentials, copy your Server Key which is highlighted blue in the following image.

firebase_fcm_2.png

Add your server key to Kommunicate

Go to Push notification section in Kommunicate dashboard and update the GCM/FCM server key under the 'GCM/FCM Key' section. You can find it in the Settings -> Cloud Messaging -> Server Key section of your Firebase console.

Note: Make sure you add the Server key in Kommunicate and not the Legacy key or Sender ID.

Important: Skip the step Kommunicate.registerForPushNotification in this doc if you are using KmChatBuilder without calling Kommunicate.login or Kommunicate.loginAsVistor methods. This step needs to be called only in onSuccess of Kommunicate login.

If using you are using KmChatBuilder, this will automatically be called if you pass the deviceToken with the builder or pass the token to Kommunicate in onTokenRefersh method of the FirebaseInstanceIdListener service. Pass the token to Kommunicate explicitly as below:

  Kommunicate.setDeviceToken(context, "deviceToken");

FCM

If you are already using Firebase in your application, add the below code inside Kommunicate.login's onSuccess() method and pass the FCM registration token as below (skip this step if using KmChatBuilder):

if(MobiComUserPreference.getInstance(context).isRegistered()) {
    Kommunicate.registerForPushNotification(context, deviceToken, new KmPushNotificationHandler() {
                    @Override
                    public void onSuccess(RegistrationResponse registrationResponse) {

                    }

                    @Override
                    public void onFailure(RegistrationResponse registrationResponse, Exception exception) {

                    }
                }); 
}

The deviceToken is obtained from the onTokenRefresh method of FcmListenerIdService class:

String deviceToken = FirebaseInstanceId.getInstance().getToken();

Add the below code inside your FcmInstanceIDListenerService's onTokenRefresh() method:

if (MobiComUserPreference.getInstance(this).isRegistered()) {
    new RegisterUserClientService(this).updatePushNotificationId(<deviceToken>);
}

For Receiving FCM Notifications in your app, add the following code in your FcmListenerService inside onMessageReceived(RemoteMessage remoteMessage) method:

if (Kommunicate.isKmNotification(this, remoteMessage.getData())) {
    return;
}

GCM

If you already have GCM enabled in your app, add the below code inside Kommunicate.login'a onSuccess() method and pass the GCM registration token as below:

if(MobiComUserPreference.getInstance(context).isRegistered()) {
   Kommunicate.registerForPushNotification(context, deviceToken, new KmPushNotificationHandler() {
                    @Override
                    public void onSuccess(RegistrationResponse registrationResponse) {

                    }

                    @Override
                    public void onFailure(RegistrationResponse registrationResponse, Exception exception) {

                    }
                }); 
}

Add the below code to the place where you are getting the GCM registration token:

if (MobiComUserPreference.getInstance(this).isRegistered()) {
    new RegisterUserClientService(this).updatePushNotificationId(deviceToken);
}

For Receiving GCM Notifications in the app, add the following code in your GcmListenerService inside onMessageReceived method:

if (Kommunicate.isKmNotification(this, remoteMessage.getData())) {
    return;
}

Don't have Android push notification code?

If you are not using any push notification code in your app, you can do it using Firebase Cloud Messaging(FCM). To enable Android push notifications using FCM, visit the Firebase console and create a new project. Add the Google service JSON to your app and configure the build.gradle files in your app.

If you don't have the existing FCM related code, then copy the push notification related files from our sample app to your project from this link and add the below lines in your AndroidManifest.xml file:

<service android:name="<CLASS_PACKAGE>.FcmListenerService">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>

<service android:name="<CLASS_PACKAGE>.FcmInstanceIDListenerService"
       android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
    </intent-filter>
</service>

Register for push notification

Now Setup the PushNotificationTask by adding the below lines of code inside onSuccess() method of Kommunicate.login:

Kommunicate.registerForPushNotification(context, Kommunicate.getDeviceToken(context) , new KmPushNotificationHandler() {
                    @Override
                    public void onSuccess(RegistrationResponse registrationResponse) {

                    }

                    @Override
                    public void onFailure(RegistrationResponse registrationResponse, Exception exception) {

                    }
                });
← ConversationCustomization →