Example integration project can be found here.

Integration Steps

1

Create a Firebase project in the firebase console

To start sending notifications from FCM, you’ll have to first create a firebase project. Create a firebase project and application in firebase console with your applications package name which you can find in AndroidManifest.xml

2

Adding google-services.json to your project

You can get your Service Account JSON from Firebase Console Project Settings. Download google-services.json and add the file inside your android > app folder.

3

Adding Firebase dependencies and plugins

3.1. Add the below dependency inside projects build.gradle inside dependencies

dependencies {
        ...
        classpath 'com.google.gms:google-services:4.3.10' // or latest version
}

3.2. Add the below plugin inside the app build.gradle

apply plugin: 'com.google.gms.google-services'

3.3 Add the below dependency inside apps build.gradle inside dependencies

implementation("com.google.firebase:firebase-messaging:22.0.0") // or latest version
4

Implementing push

Push feature can be implemented in two ways:

Targeting Android 13 (API-33)

In Android13 (API 33) or higher notification permission will be disabled by default so permission needs to be asked to enable notifications if you are targeting android 13 users. You can follow this doc to update to support Andriod 13(API 33), if not already supported. Please test the application as well as upgrading to API 33 may causes breaking changes.

1

Add POST_NOTIFICATIONS permission in AndroidManifest.xml if not present already.

<manifest ...>
    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/> 
    <application ...>
        ...
    </application>
</manifest>
2

Ask notification permission to show push notifications

You can use permission_handler or any other package to ask notification permission to user.

From v2.4.0, we have removed internal method to ask notification permission (suprsend.askNotificationPermission). You can use external package to ask notification permission.

Once notification permission is granted, users can be able to see push notifications.