Android Firebase Push Notification Integration

What is Firebase ?

Firebase is a mobile and web application development platform developed by Firebase, Inc. in 2011,then acquired by Google in 2014.It helps you quickly develop high-quality apps and grow your business. Some of the important products that it offers are -

• Cloud Messaging
Send targeted messages and notifications
• Real-time Database
Store and sync data between users and devices in realtime using a cloud-hosted, noSQL database
• Crash Reporting
Diagnose problems in your mobile app with detailed reports of bugs and crashes
• Authentication
Manage your users in a simple and secure way
• AdMob
Maximize revenue with in-app ads

Firebase Cloud Messaging (FCM) is a cross-platform messaging solution that lets you reliably deliver messages at no cost. Using FCM, you can notify a client app that new email or other data is available to sync. You can send notification messages to drive user re-engagement and retention. For use cases such as instant messaging, a message can transfer a payload of up to 4KB to a client app.

In this blog, we will be discussing how can we integrate Android Apps with Firebase Cloud Messaging(FCM). We will be sending a notification message to our Android App from FCM Console. Steps to develop this can be summarized below -

• Create a Firebase project in the Firebase console
• Click Add Firebase to your Android app and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just download the config file.
• When prompted, enter your app's package name. It's important to enter the package name your app is using; this can only be set when you add an app to your Firebase project.
• At the end, you'll download a google-services.json file.
• Add the SDK.
• Register com.google.firebase.MESSAGING_EVENT service in Android App's manifest.
• Register Instance_ID_Event service in Android app's manifest.
• Fetch the Twitter token from Android Monitor and use it in the Firebase console to send message.

Used Concepts & Used Version: (Version of Android API, Twitter API)

We will be using google-services.json here which is provided by Firebase(Downloaded Earlier).

• app module Dependency - 'com.google.firebase:firebase-messaging:10.0.1'
• compileSdkVersion 26
• buildToolsVersion "26.0.1"

Now, let’s begin the development...

1.Create a Firebase project

• Visit the link - console.firebase.google.com

• Click on the button - Add Firebase to your Android App

• Add Package name and click on Register App button

• Download the json file

• Make changes in the gradle file to add dependencies in your project.

// Top-level build file (Module Project)where you can add configuration options common to all sub-projects/modules. buildscript { repositories { jcenter() } dependencies { classpath 'com.android.tools.build:gradle:2.3.3' classpath 'com.google.gms:google-services:3.1.0' // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files } } allprojects { repositories { jcenter() } } task clean(type: Delete) { delete rootProject.buildDir } //app module gradle file apply plugin: 'com.android.application' android { compileSdkVersion 26 buildToolsVersion "26.0.1" defaultConfig { applicationId "example.fcmexample3" minSdkVersion 16 targetSdkVersion 26 versionCode 1 versionName "1.0" testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { exclude group: 'com.android.support', module: 'support-annotations' }) compile 'com.android.support:appcompat-v7:26.+' compile 'com.android.support.constraint:constraint-layout:1.0.2' compile 'com.google.firebase:firebase-messaging:10.0.1' testCompile 'junit:junit:4.12' } apply plugin: 'com.google.gms.google-services'

google-services.json

You need to include this directory in your app. Refer to below screenshot to find out the exact location of the directory.

{ "project_info": { "project_number": "914130847040", "firebase_url": "https://macro-parity-167205.firebaseio.com", "project_id": "macro-parity-167205", "storage_bucket": "macro-parity-167205.appspot.com" }, "client": [ { "client_info": { "mobilesdk_app_id": "1:914130847040:android:242a2b24e07b1cf2", "android_client_info": { "package_name": "example.fcmexample3" } }, "oauth_client": [ { "client_id": "914130847040-p1opgrrp9r6g3f4dojkkmf32cqf4hofd.apps.googleusercontent.com", "client_type": 3 } ], "api_key": [ { "current_key": "AIzaSyAadAR-B7yDem4z7FkIueQNea5EM1ixiC4" } ], "services": { "analytics_service": { "status": 1 }, "appinvite_service": { "status": 1, "other_platform_oauth_client": [] }, "ads_service": { "status": 2 } } } ], "configuration_version": "1" }

Put Manifest entries in your app for services to be used

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.sis_cpu_6.myapplication"> <uses-permission android:name="android.permission.INTERNET"/> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name=".FCM2"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> <service android:name=".MyFirebaseMessagingService"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT"/> </intent-filter> </service> <service android:name=".MyFirebaseInstanceIDService"> <intent-filter> <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/> </intent-filter> </service> </application> </manifest>

Main Activity

There is no change to be done in MainActivity.class for this project. Also, no change in layout for the activity- MainActivity.class

import android.support.v7.app.AppCompatActivity; import android.os.Bundle; public class MainActivity extends AppCompatActivity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); } }

We added 2 services here which will help us to generate token and receive messages coming from Firebase console.

MyFirebaseInstanceIDService

Create MyFirebaseInstanceIDService in the project. This service generates token which is used by firebase Console to send messages to a particular device. Every device generates its unique token which enables single device targetted messages.

import android.util.Log; import com.google.firebase.iid.FirebaseInstanceId; import com.google.firebase.iid.FirebaseInstanceIdService; public class MyFirebaseInstanceIDService extends FirebaseInstanceIdService { private static final String TAG = "MyFirebaseIIDService"; @Override public void onTokenRefresh() { String refreshedToken = FirebaseInstanceId.getInstance().getToken(); Log.d(TAG, "Refreshed token: " + refreshedToken); } private void sendRegistrationToServer(String token) { //You can implement this method to store the token on your server //Not required for this project } }

MyFirebaseMessagingService

This service is responsible for receiving the notification message from the Firebase console.

onMessageReceived(RemoteMessage remoteMessage) is called once the message is received and we will be calling sendNotification(remoteMessage.getNotification().getBody()) inside it to prepare a notification.

import android.app.NotificationManager; import android.app.PendingIntent; import android.content.Context; import android.content.Intent; import android.media.RingtoneManager; import android.net.Uri; import android.support.v4.app.NotificationCompat; import android.util.Log; import com.google.firebase.messaging.FirebaseMessagingService; import com.google.firebase.messaging.RemoteMessage; public class MyFirebaseMessagingService extends FirebaseMessagingService{ private static final String TAG = "MyFirebaseMsgService"; @Override public void onMessageReceived(RemoteMessage remoteMessage) { //Displaying data in log //It is optional Log.d(TAG, "From: " + remoteMessage.getFrom()); Log.d(TAG, "Notification Message Body: " + remoteMessage.getNotification().getBody()); //Calling method to generate notification sendNotification(remoteMessage.getNotification().getBody()); } //This method is only generating push notification private void sendNotification(String messageBody) { Intent intent = new Intent(this, MainActivity.class); intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); PendingIntent pendingIntent = PendingIntent.getActivity(this, 0, intent, PendingIntent.FLAG_ONE_SHOT); Uri defaultSoundUri= RingtoneManager.getDefaultUri(RingtoneManager.TYPE_NOTIFICATION); NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(this) .setSmallIcon(R.mipmap.ic_launcher) .setContentTitle("Firebase Push Notification") .setContentText(messageBody) .setAutoCancel(true) .setSound(defaultSoundUri) .setContentIntent(pendingIntent); NotificationManager notificationManager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE); notificationManager.notify(0, notificationBuilder.build()); } }

Sending Message from Firebase Console

Visit Firebase Console and click on the Notification tab at the left margin.

Click on the Create Message button to start creating a message.

Compose the message, Select target as Single device and enter the token in the FCM Token registration field to sendthe message. The device will receive the message like a notification.