API Reference

This page guides you to enable sending push notifications to your users.

Enable Push Notification

To enable push notifications for your application, follow these steps:

  1. For Android 13 and above:

    • You must explicitly seek the user's consent to receive push notifications.
    • Open the AndroidManifest.xml file and add the following permission:
      <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
      
  2. For Android 12 and below:

    • If your device has Android 12 or an older version, it automatically allows notifications to be sent.
  3. Use the following code based on the user's permission to allow/deny push notifications:

Contlo.subscribeToMobilePush()
Contlo.unsubscribeToMobilePush()

Based on the consent received, the function will subscribe or unsubscribe your audience from Mobile Push on your Contlo dashboard.

Set up Mobile push credentials

Open your Firebase project and follow the steps below:

  1. Go to the Project Settings and click the Service Account tab.

  1. Click the Generate new private key button to generate a JSON file with Firebase admin SDK credentials. If you have already generated one, use it for the next steps.
  2. Open the JSON file to get the credentials required for Contlo.

Push settings on Contlo Dashboard

To configure sending Push notifications from the Contlo platform, follow the steps below:

  1. Go to the Contlo Dashboard and navigate to the App Market on the left navigation bar.
  2. On the App Market screen, choose All category & search for the Mobile Push app.
  3. Open the App, go to the Android tab & set the credentials as per your Firebase JSON file, and then click Save Settings.

Use only Contlo notifications

If you have not set up Push Notification for your application, and only want to use Contlo’s push notification,
add the following service to the AndroidManfest.xml file:

<service
        android:name="com.contlo.androidsdk.push.NotificationHandler"
        android:exported="true"
        tools:ignore="Instantiatable">
          <intent-filter>
             <action android:name="com.google.firebase.MESSAGING_EVENT" />
          </intent-filter>
</service>

Use Contlo notifications with your Push notifications

  1. Once you have set up Firebase and Mobile SDK in Contlo, navigate to the class that uses FirebaseMessagingService().
  2. For sending the Firebase token to Contlo, navigate to the onNewToken method and call the updateFcmToken() method as shown below:
ContloNotification.updateFcmToken(this, token)
  1. In the onMessageReceived() method, call the processContloNotification() method as shown below:
ContloNotification.processContloNotification(this, message)

Sample code:

package com.contlo.mobilesdk

import com.contlo.androidsdk.push.ContloNotification
import com.google.firebase.messaging.FirebaseMessagingService
import com.google.firebase.messaging.RemoteMessage

class NotificationService(): FirebaseMessagingService() {

    override fun onMessageReceived(message: RemoteMessage) {
        super.onMessageReceived(message)
        ContloNotification.processContloNotification(this, remoteMessage = message)
    }

    override fun onNewToken(token: String) {
        super.onNewToken(token)
        ContloNotification.updateFcmToken(this, token)
    }
}
  1. After completing these steps, ensure that you have included your class within the AndroidManifest.xml file.