Android:
1. Firebase Setup
If you have a firebase account for your application you can skip this step. If you do not have a Firebase account for your application, refer https://firebase.google.com/docs/android/setup and create an account for you application.
2. Chat FCM key configuration
In Firebase Console Under your project go to cloud messaging tab and you will see your Server Key, copy that.
In Chat web portal, paste your Server Key under Admin Settings > Channels > Chat & Messaging > Mobile SDK.
3. Add Android Project to Firebase
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.
During the process, you'll download a google-services.json file. You can download this file again at any time.
Add rules to your root-level build.gradle file, to include the google-services plugin and the Google's Maven repository,
buildscript {
// ...
dependencies {
// ...
classpath 'com.google.gms:google-services:4.2.0' // google-services plugin
}
}
allprojects {
// ...
repositories {
// ...
google() // Google's Maven repository
}
}
v. Then, in your module Gradle file (usually the app/build.gradle), add the apply plugin line at the bottom of the file to enable the Gradle plugin,
apply plugin: 'com.android.application'
android {
// ...
}
dependencies {
// ...
implementation 'com.google.firebase:firebase-core:16.0.6'
// Getting a "Could not find" error? Make sure you have
// added the Google maven respository to your root build.gradle
}
// ADD THIS AT THE BOTTOM
apply plugin: 'com.google.gms.google-services'
After you add the initialization code, run your app to send verification to the Firebase console that you've successfully installed Firebase.
4. Receiving push token
You need to create FirebaseMessagingService.java
To use FirebaseMessagingService, you need to add the following code in your app manifest,
<service android:name=".java.MyFirebaseMessagingService">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
Push token will be received in onNewToken function of FirebaseMessagingService class.
Refer https://firebase.google.com/docs/cloud-messaging/android/client#monitor-token-generation for more details.
On receiving the push token, you can pass it to Chat using the below snippet.
HTML
Freshchat.getInstance(context).setPushRegistrationToken(token);
5. Receiving push notification and passing to React native Chat SDK
By overriding the method onMessageReceived() in FirebaseMessagingService, you can access the push notification payload.
Use the below snippet to pass the receive payload to React native Chat SDK. Add it to FirebaseMessagingService.java
package com.example.hotlineapp;
import com.freshchat.consumer.sdk.Freshchat;
import com.google.firebase.messaging.FirebaseMessagingService;
import com.google.firebase.messaging.RemoteMessage;
public class MyFirebaseMessagingService extends FirebaseMessagingService {
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
if (Freshchat.isFreshchatNotification(remoteMessage)) {
Freshchat.handleFcmMessage(this, remoteMessage);
}
}
}
Note: Since Chat native SDK is part of React Native Chat SDK, you might see “com.freshchat.consumer.sdk.Freshchat” in red color (Cannot resolve class error). But these classes will be added while build generation.iOS:
1. Push Notification p12 Certificate creation and uploading to Chat
Refer https://support.freshchat.com/support/solutions/articles/232534.
2. Enabling Push Notification capabilities
Go to capabilities section of your Xcode project and enable Push Notification feature.
3. UserNotifiications Framework setup
i. Import UserNotifications framework inside your Appdelegate class.
ii. Make your Appdelegate class conforms to UNUserNotificationCenterDelegate protocol and add the following code inside.
application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions [UIApplicationLaunchOptionsKey: Any]?) -> Bool function,
UNUserNotificationCenter.current().delegate = self
UNUserNotificationCenter.current().requestAuthorization(options:[.badge, .alert, .sound]){ (granted, error) in }
UIApplication.shared.registerForRemoteNotifications()
iii. Implement the following methods of the UNUserNotificationCenterDelegate protocol in Appdelegate class.
* func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void)
// To handle Push notification click event.
* func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)
// To pass the device token generated from the device
4. Passing Device token to Chat
The following function will get executed after user gives permission for Push Notification, then pass the device token back to Chat SDK.
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Freshchat.sharedInstance().setPushRegistrationToken(deviceToken)
}
5. Handling push notification click on app killed state
Add the following line under application(_ application: UIApplication,didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool function,
if Freshchat.sharedInstance().isFreshchatNotification(launchOptions) {
Freshchat.sharedInstance().handleRemoteNotification(launchOptions, andAppstate: application.applicationState)
}
First check if the notification is from Chat, if yes pass the details to Chat SDK by calling handleRemoteNotification function.
6. Handling push notification click on app running state
Add the following code to handle push notification click handling when app is in running state,
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
let dictionary = response.notification.request.content.userInfo
let appstate = UIApplication.shared.applicationState
if Freshchat.sharedInstance().isFreshchatNotification(dictionary) {
Freshchat.sharedInstance().handleRemoteNotification(dictionary, andAppstate: appstate)
}
}