FCM Integration in Android - Kotlin

-
                                              

Firebase Cloud Messaging inherits GCM’s core infrastructure but simplifies the client development. It works for all platforms (Android, IOS and Web). Let's see how to integrate FCM in Android with Kotlin.

FCM Messages:

        Two types of FCM messages are there.
  •      Notification messages,  which are handled by the FCM SDK automatically.
  •      Data messages, which are handled by the client app. It can have custom fields, which have to be sent by our server.

1. Configure FCM in Firebase Console
(a) Go to https://console.firebase.google.com/


(b) Then click Add Project, a dialog will be prompted. Enter project name and choose country in it and click on Create Project.


(c) Click on Add Firebase to your Android App, another dialog will be prompted. In that, enter package name (SHA-1 and App Nickname are optional for FCM) and click Register App.
fire4.png
fire5.png
(d) Then download google_services.json file, by clicking download button and follow the instructions on that screen. Now the FCM is configured.
fire6.png
fire7.png

2. Integrate in Application:

               Create new project with Kotlin support and proceed with following.

(a) Make following changes in Project's build.gradle.
buildscript {
  ext.kotlin_version = '1.1.51'
  repositories {
      google()
      jcenter()
  }
  dependencies {
      classpath 'com.android.tools.build:gradle:3.0.0'
      classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
      classpath 'com.google.gms:google-services:3.1.1'
      // NOTE: Do not place your application dependencies here; they belong
      // in the individual module build.gradle files
  }
}
allprojects {
  repositories {
      google()
      jcenter()
  }
}
task clean(type: Delete) {
  delete rootProject.buildDir
}

(b) Make following changes in app's build.gradle.
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
android {
  compileSdkVersion 26
  defaultConfig {
      applicationId "com.developer.firebasedemo"
      minSdkVersion 15
      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 {
  implementation fileTree(dir: 'libs', include: ['*.jar'])
  implementation"org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"
  implementation 'com.android.support:appcompat-v7:26.1.0'
  implementation 'com.android.support.constraint:constraint-layout:1.0.2'
  testImplementation 'junit:junit:4.12'
  androidTestImplementation 'com.android.support.test:runner:1.0.1'
  androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
  compile 'com.google.firebase:firebase-messaging:11.4.2'
}
apply plugin: 'com.google.gms.google-services'

(c) Create two services as follows:


FirebaseIDService.kt

        This class handles the token generation and updation on its own.
Token may change on following instances and it will be handled automatically.
  • The app deletes Instance ID
  • The app is restored on a new device
  • The user uninstalls/reinstall the app
  • The user clears app data.
class FirebaseIDService : FirebaseInstanceIdService() {
  internal var dataStorage: DataStorage = DataStorage()
  override fun onTokenRefresh() {
      super.onTokenRefresh()
      // Get updated InstanceID token.
      val refreshedToken = FirebaseInstanceId.getInstance().token
      Log.d("FirebaseIDService", "Refreshed token: " + refreshedToken!!)
      dataStorage.saveFcmToken(applicationContext, refreshedToken)
      // If you want to send messages to this application instance or
      // manage this apps subscriptions on the server side, send the
      // Instance ID token to your app server.
      sendRegistrationToServer(refreshedToken)
  }
  private fun sendRegistrationToServer(refreshedToken: String?) {
      Log.v("Sending to server!!", "Sending==" + refreshedToken!!)
  }
}
FirebaseMessageService.kt
        This class handles the notification received. Both the FCM message types will be handled here.
class FirebaseMessageService : FirebaseMessagingService() {
  private val TAG = "FirebaseMessageService"
  override fun onMessageReceived(remoteMessage: RemoteMessage?) {
      super.onMessageReceived(remoteMessage)
      // Check whether the remoteMessage contains a notification payload.
      if (remoteMessage!!.getNotification() != null) {
          Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()!!)
          sendNotification(remoteMessage.getNotification().getBody())
      }
      //Check whether the remoteMessage contains a data payload.
      if (remoteMessage.getData().size > 0) {
          Log.e(TAG, "Data Payload: " + remoteMessage.getData().toString())
          try {
              val map = remoteMessage.getData()
              handleDataMessage(map)
          } catch (e: Exception) {
              Log.e(TAG, "Exception: " + e.message)
          }
      }
  }
  private fun handleDataMessage(map: Map<String, String>) {
      Log.e(TAG, "push json: " + map.toString())
      try {
          val type = map["type"]
          val id = map["id"]
          val message = map["message"]
          val title = map["title"]
          Log.e(TAG, "type: " + type)
          Log.e(TAG, "message: " + message)
          Log.e(TAG, "id: " + id)
          /** Do the things you would like to do with the data, here **/
      } catch (e: Exception) {
          Log.e(TAG, "Exception: " + e.message)
      }
  }
  private fun sendNotification(messageBody: String?) {
      val channelId: String = getString(R.string.app_name);
      val notificationBuilder: NotificationCompat.Builder =
              NotificationCompat.Builder(this, channelId)
                      .setSmallIcon(R.mipmap.ic_launcher)
                      .setContentTitle(getString(R.string.app_name))
                      .setContentText(messageBody)
                      .setAutoCancel(true)
      val notificationManager: NotificationManager = getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager;
      notificationManager.notify(2, notificationBuilder.build());
  }
}
(d) Register the created two firebase services in Manifest file.
 <service
          android:name=".FirebaseMessageService">
          <intent-filter>
              <action android:name="com.google.firebase.MESSAGING_EVENT"/>
          </intent-filter>
      </service>
      <service
          android:name=".FirebaseIDService">
          <intent-filter>
              <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
          </intent-filter>
      </service>
(e) Include the following <meta-data> in manifest, to configure the notification to be shown while the app is in background.
 <!-- Set custom default icon. This is used when no icon is set for incoming notification messages. -->
      <meta-data
          android:name="com.google.firebase.messaging.default_notification_icon"
          android:resource="@mipmap/ic_launcher" />
      <!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
           notification message. -->
      <meta-data
          android:name="com.google.firebase.messaging.default_notification_color"
          android:resource="@color/colorAccent" />


(f) DataStorage class to store data using SharedPreference

 DataStorage.kt
class DataStorage {
  internal lateinit var savedSession: SharedPreferences
  private val KEY: String = ""
  fun saveFcmToken(context: Context, tokenId: String) {
      // TODO Auto-generated method stub
      val editor = context
              .getSharedPreferences(KEY, Activity.MODE_PRIVATE).edit()
      editor.putString("FCM_TOKEN_ID", tokenId)
      editor.commit()
  }
  fun getFcmToken(context: Context): String {
      savedSession = context.getSharedPreferences(KEY, Activity.MODE_PRIVATE)
      return savedSession.getString("FCM_TOKEN_ID", "")
  }
}


3. Run Application
              Now run the application. After that, go to Firebase console and navigate to Notification in Side bar. Then send Notification from there, by choosing any target of your choice. Now the notification has shown up.


Comments

Post a Comment

Popular posts from this blog

SOAP Client using ksoap2 in Android - Kotlin

-
Image
Introduction: SOAP stands for Simple Object Access Protocol. It is XML-based protocol that allows programs that run on different operating systems (like Windows, Linux, etc) to communicate using HTTP and XML. Pros: Security - SOAP provides its own security known as WS Security . Platform Independent - SOAP web services can be written in any programming language and executed in any platform Cons: Slow - It uses XML format that must be parsed, to be read. It defines many standards to be followed while developing. So its slow and consumes more bandwidth and resource. WSDL dependent - It uses WSDL mechanism and doesn't have any other mechanism to discover the service. Things to know: The following are the things we have to know before we proceed further:                     URL - It is the URL of WSDL file.                     NAMESPACE - It is ta...
Read more

Retrofit Integration in Android - Kotlin

-
Image
Retrofit is a Networking library, which is faster to use and easier to develop. Let’s see how to integrate Retrofit in Android with Kotlin. If you'd like to integrate RxJava as well, you can check here . 1. Configure: Include the following in app-level build.gradle. build.gradle compile "com.squareup.retrofit2:retrofit:2.3.0" compile "com.squareup.retrofit2:converter-gson:2.3.0" Include internet permission in Manifest file. AndroidManifest.xml <uses-permission android:name="android.permission.INTERNET" /> 2. Preparing Helper classes: ApiInterface.kt interface ApiInterface {    @POST("get_users_detail") // Your url    fun getUser(@Body requestBody: RequestBody): Call<UserResponse> } Model classes:                      Response from Retrofit will be stored in POJO classes dir...
Read more

Using Camera in Android - Kotlin

-
Image
Nowadays, most of our Android app require access to Camera to capture picture or Video. We can do that in two ways.                                 (i) Using built-in Camera,                                 (ii) Using custom Camera. Using Built-in Camera In this post, Let's see how to use the built-in camera to capture images and save it. Its a simple way to capture pics. We can use the mobile's built-in camera app using Intent.  val REQUEST_IMAGE_CAPTURE = 1 private fun takePictureIntent() { val takePictureIntent = Intent(MediaStore . ACTION_IMAGE_CAPTURE) if (takePictureIntent . resolveActivity(packageManager) != null) { startActivityForResult(takePictureIntent, REQUEST_IMAGE_CAPTURE) } } After the picture has been captured, the result will received on on...
Read more

Room with LiveData, ViewModel - Android Architecture Components - Kotlin

-
Image
Introduction: We have already learnt about Room in last post,  Room-Kotlin . In this post, lets learn about how to use ViewModel and LiveData with Room to improve usablity. Using LiveData with Room, allows views to be notified about data changes automatically. LiveData: LiveData is nothing but observable data holder class. It allows us to observer changes in data across multiple components of app. It is also aware of and respects lifecycle of Activities/Fragments. It also ensures that LiveData only updates app component observers that are in an active lifecycle state. The following image depicts the Lifecycle and States: Here, CREATED, STARTED, RESUMED - Active States           INTIALIZED, DESTROYED - InActive States So, LiveData will remove the updates automatically while in InActive States, i.e., INTIALIZED and DESTROYED. ViewModel: ViewModel is an entity that is free of Activity/Fragment's lifecycle. So it allows us...
Read more

Map, Location update and AutoComplete Places - Kotlin

-
Image
Let's see how to show current location in Maps and also show the location which is chosen from AutoComplete in Maps with the updated Google play services. That is, for location listening we gonna use   FusedLocationProviderClient and for autocomplete places, we gonna use, GeoDataClient with AutoCompletePrediction, i.e., no need to call places url from our end, Google Playservices will do that work for you. Okiee, Let's start now. You can find the project in Github . PreRequisite: Navigate to  https://developers.google.com/maps/documentation/android-api/signup and do as per the instructions to start. Manifest: Include your API key, which you got from previous step in AndroidManifest.xml <meta-data android:name= "com.google.android.geo.API_KEY" android:value= "AIzXXXXXXXXXX_XXXXXXXXXXXXXX" /> Gradle: Include the following in app-level build 's dependencies. implementation 'com...
Read more

RecyclerView with different number of columns using SpanSizeLookup

-
Image
We already know how to design RecyclerView. But how to create RecyclerView with different columns depending on its row? Like below image? Yeah, we can do that, by using two different layouts with different viewType on Adapter. Another way is do some logic to do so. But, it's cumbersome. Luckily, we have another simple way to do that using SpanSizeLookUp . Let's see how to implement that in this post. Implementation: build.gradle Include the following in app-level gradle file. implementation 'com.android.support:recyclerview-v7:27.0.2' implementation 'com.android.support.constraint:constraint-layout:1.1.0-beta5' recycler.xml <?xml version= "1.0" encoding= "utf-8" ?> <android.support.constraint.ConstraintLayout xmlns:android= "http://schemas.android.com/apk/res/android" android:layout_width= "match_parent" android:layout_height= "match_parent" xmlns:ap...
Read more

Bottom Navigation using design Library in Android - Kotlin

-
Image
Introduction: Let's implement BottomNavigationView in our layout using Design Support Library. First, we have to go through the factors like, when  and how to use that. When to use? As per Material Design specs, the following criteria is there: (a) Tabs (TabLayout) - Should be used when there are two navigations. (b) Bottom Navigation - Should be used when there are 3 to 5 navigations. (c) Navigation Drawer - Should be used when there are 6 or more navigations. Also to remember that, Viewpager shouldn't be used with BottomNavigationView. You can read the complete design specs, here . How to use? BottomNavigationView have to be added  at the bottom of the screen. Also, the following are some of the important attributes: app:itemBackground - to apply background color  app:itemTextColor - to apply the color for the text of BottomNavigation item. app:itemIconTint - to apply the color for the icon of BottomNavigation item. app...
Read more

Exploring Android Navigation Architecture Component - MVVM - Kotlin

-
Image
Navigation Architecture Component is released as a part of JetPack and androidx package. Its aim is to simplify the implementation of Navigation in our Android App. It defines a set of principles to build an in-app navigation with consistent and predictable user experience. Its main concept is to use single-activity architecture. It also has support for both Activity and Fragment. Principle of Navigation: The following are the principles of Navigation. App should have fixed starting destination A stack is used to represent the navigation state of app The 'Up' button never exits the app Up and Back are equivalent within your app's task Deep linking to a destination or navigating to the same destination should yield the same stack You can find the detailed explanation, here . Components of Navigation: (i) Navigation Graph - It's nothing but a map/blueprint of our in-app navigation. It has a list of all fragments and activities. We can also ...
Read more

Exploring Android Slices - JetPack

-
Image
Introduction: Slices are a new way of embedding our app's content in other surfaces, like Google Search and later in other places like Google Assistant. Slices are UI templates, which gives look and feel at home in whatever surface, they get hosts in. Also they are rich, interactive and dynamically updatable. Before jumping into that, first migrate your project to AndroidX, (Android Studio 3.2 & above), by navigating as,                                         Refactor --> Migrate  to AndroidX  Setup: build.gradle implementation 'androidx.slice:slice-core:1.0.0' implementation 'androidx.slice:slice-builders-ktx:1.0.0-alpha6' implementation 'androidx.slice:slice-builders:1.0.0' Creating Slice Provider: Slice Provider is a component that let us display the slices we are creating, on outside our application. We can create the Slice Pro...
Read more