Push Notifications

1. Configure in NotifyVisitors Panel

a) Go to FCM and register your app.

b) Copy Sender Id and Server key from FCM.

c) Go to NotifyVisitors panel and from mobile push menu go to Android section inside configuration section from left side menu panel and Paste Sender Id and Server key there.

2. Configure in App

Follow the undermentioned steps, in case you don't have your own Firebase Integration:

a) Download the latest config json file (google-service.json file) and paste it into your app folder in IDE.

b) Add a Google Services plugin as a dependency in your project-level build.gradle file.

plugins {
   id 'com.google.gms.google-services' version '4.4.0' apply false
}

plugins {
   id("com.google.gms.google-services") version "4.4.0" apply false
}

c) Add a Google Services plugin in your module-level build.gradle file.

plugins {
   id 'com.google.gms.google-services'
}

plugins {
   id("com.google.gms.google-services") 
}

d) Add the dependency for Firebase Cloud Messaging in your module-level build.gradle file.

dependencies {
  implementation platform('com.google.firebase:firebase-bom:30.3.1')
  implementation ('com.google.firebase:firebase-messaging')
}

e) Add the below NotifyVisitors service for Firebase Messaging Service in the app module’s manifest file.

<service
   android:exported="false"
   android:name="com.notifyvisitors.notifyvisitors.NVFirebaseMessagingService"
   android:permission="${applicationId}.notifyvisitors.custom.PERMISSION">
   <intent-filter>
       <action android:name="com.google.firebase.MESSAGING_EVENT" />
   </intent-filter>
</service>

Perform the below function in case you have your own firebase integration:

try {
   if (intent.hasExtra("nv_source")) {
       String value = intent.getExtras().getString("nv_source");
       if (value.equals("1")) {
           if(NotifyVisitorsApi.getInstance(this).isPayloadFromNvPlatform(remoteMessage.toIntent())) {
                  NotifyVisitorsApi.getInstance(this).getNV_FCMPayload(remoteMessage.toIntent());
           }
       }
   }
} catch (Exception e) {
   e.printStackTrace();
}

try {
    if (intent.hasExtra("nv_source")) {
       val value = intent.extras!!.getString("nv_source")
       if (value == "1") {
             if (NotifyVisitorsApi.getInstance(this).isPayloadFromNvPlatform(remoteMessage.toIntent())) {
                   NotifyVisitorsApi.getInstance(this).getNV_FCMPayload(remoteMessage.toIntent())
             }
       }
    }
} catch (e: Exception) {
    e.printStackTrace()
}

3. Configure Icons -- IMPORTANT

Small Icon

Small icon density and size.

📘

Note

To change the default small push icon, add the icon as “sm_push_logo.png” in your app’s module app/src/main/res/drawable folder.

Follow the undermentioned steps, to get a small push icon effect in your status bar,

1. Go to Android Asset Studio.

2. Select Notification Icon Generator.

3. Select Image under the Source menu ( Note: Here, select your Monochrome icon).

4. Copy and paste your small push icon there on.

5. Enter its name in the 'Name Menu' on the left side ( Note: Name here will be as 'sm_push_logo') .

6. Download the images from the top-right-corner icon. Download it as a zip file.

7. Unzip it and paste all folders in your app.

Small Icon Accent Color

Android 5.0+ enforces your small icon to only be white and transparent, however, it still allows tinting on the notification, known as the "accent color". (The status bar icon color will still be unaffected).

To set a default color, add the following line to your res/values/colors.xml file in your project.

<resources>
    <!-- It sets all NotifyVistors push notification's accent color to Dark Red by default.  -->
   <color name="push_small_icon_background">#a03844</color>
</resources>

Some device manufacturers display the image as it is (multi-colored image; ignoring the alpha channel rule).

We highly recommend following the alpha rule as the icons may not look consistent on all devices. Google designed it in this way, since the icon is too small to see any meaningful detail, so enforcing a single color helps enforce an easier-to-recognize icon at a glance.

Large Icon

The large notification icon will show up to the left of the notification text on Android 4.0.3 - 6.0 devices and to the right for Android 7.0+ devices. If you do not set a large icon, the app icon will be used instead. The recommended size of the large icon is 200x200 pixels.

[ Android 6.0 ]

[ Android 10.0 ]

[ Android 13.0 ]

4. Notification Preferences

Give a user the option to subscribe to a specific category of notifications, or to unsubscribe completely from push notifications.

First, you will need to define the categories in NotifyVisitors Panel. Click here to learn how and then you can implement the below code in your app.

NotifyVisitorsApi.getInstance(activityContext).pushPreferences((preferenceList (JSONArray), isUnSubscribeFromAll (boolean));

NotifyVisitorsApi.getInstance(activityContext).pushPreferences(preferenceList: JSONArray?, isUnSubscribeFromAll: Boolean)

Here the parameter "isUnSubscribeFromAll" is passed as a boolean. If you pass as FALSE, then it will work as a subscribing user according to the preferenceList passed. If you pass as TRUE, then it will work as unsubscribing user according to the preferenceList you passed.

Below are some cases with examples that will help you understand the scenarios of subscribing and unsubscribing.

Case 1: Subscribe the user to all the three categories passed in the array.

JSONArray jsonArray = new JSONArray();
jsonArray.put("category1");
jsonArray.put("category2");
jsonArray.put("category3");
NotifyVisitorsApi.getInstance(activityContext).pushPreferences(jsonArray, false);

val jsonArray = JSONArray()
jsonArray.put("category1")
jsonArray.put("category2")
jsonArray.put("category3")
NotifyVisitorsApi.getInstance(activityContext).pushPreferences(jsonArray, false)

Case 2: Subscribe the user to all the categories by default.

NotifyVisitorsApi.getInstance(activityContext).pushPreferences(null, false);

NotifyVisitorsApi.getInstance(activityContext).pushPreferences(null, false)

Case 3: UnSubscribe the user to all the three categories passed in the array.

JSONArray jsonArray = new JSONArray();
jsonArray.put("category1");
jsonArray.put("category2");
jsonArray.put("category3");
NotifyVisitorsApi.getInstance(activityContext).pushPreferences(jsonArray, true);

val jsonArray = JSONArray()
jsonArray.put("category1")
jsonArray.put("category2")
jsonArray.put("category3")
NotifyVisitorsApi.getInstance(activityContext).pushPreferences(jsonArray, true)

Case 4: UnSubscribe the user from all the categories.

NotifyVisitorsApi.getInstance(activityContext).pushPreferences(null, true);

NotifyVisitorsApi.getInstance(activityContext).pushPreferences(null, true)

5. Callbacks Related to Push Notifications

Implement the callback method below if you want to receive any of the below callbacks in your app. This will provide you with a response in JSONObject format.

NotifyVisitorsApi.getInstance(this).getEventResponse(new OnEventTrackListener() {
   @Override
   public void onResponse(JSONObject data) {
       //do your task here
   }
});

NotifyVisitorsApi.getInstance(activityContext).getEventResponse(object : OnEventTrackListener{
   override fun onResponse(data: JSONObject?) {
       //do your task here
   }
})

I. Push Registered

This callback will be received whenever the user gets registered in our NotifyVisitors Dashboard. Below is the sample output which you will receive in the above callback for this case-

{
   "status":"success",
   "eventName":"Push_Registered",
   "attributes":{
      "subscriptionId":"e90RM4olWRU:APA91bGhn2dL38cpy2r7eMqqqgmctPwU9wvbomq9x1TaPO6u8aDZQoiRWu5oY3-bpPe5oBwVZkzDUK5llw1t2FNnbJ5B3fjjFyi2ojnVDRLqQIFcea6ury5_KCGpwB61iTyu0fQd2ha1"
   }
}

II. Push Clicked

This callback will be received whenever the user clicks on push notification received from NotifyVisitors Dashboard. In this callback, you will also get all attributes associated with the click type of the push notification. Below is the sample output which you will receive in the above callback for this case:

{
   "status":"success",
   "eventName":"Push_Clicked",
   "attributes":{
      "action_params":{
         "KEY4":"989"
      },
      "notification_id":"108219"
   }
}

6. Notification Runtime Permission