Push Notification

Integrate FireBase to the Application#

Step 1: Create Project in the firebase console using your app package name. Ex: com.testapp

Step 2: After the project creation download the google-service.json file which is automatically generated.

Step 3: Add the google-service.json file to your android Application with in the /android/app/ folder.

Installation#

Install the react-native-firebase package in your project.

Using NPM:

npm install --save @react-native-firebase/app @react-native-firebase/messaging

Using Yarn

yarn add @react-native-firebase/app @react-native-firebase/messaging

Configure Firebase in Android:#

To allow Firebase on Android to use the credentials, the google-services plugin must be enabled on the project. This requires modification to two files in the Android directory.

First, add the google-services plugin as a dependency inside of your /android/build.gradle file

    buildscript {
        dependencies {
            // ... other dependencies
            classpath ("com.google.gms:google-services:4.3.15")
            // Add me --- /\
        }
    }

Next, execute the plugin by adding the following to your /android/app/build.gradle file:

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services' // <- Add this line

Lastly, execute the plugin by adding the following to your AndroidManifest.xml file:

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

Register User with FCM token#

 import messaging from '@react-native-firebase/messaging';

 const fcmToken = await messaging().getToken();

 await SDK.register('USER_IDENTIFIER', 'FCM_TOKEN');

Request Params#

Status	Description	Type	Required
`USER_IDENTIFIER`	Unique Id to Register the User	String	true
`FCM_TOKEN`	Unique Id	String	false

Response Params#

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Username and Password	Object

Sample Response:#

{
  statusCode: 200,
  message: "Success",
  data: {
    username: "123456789",
    password: "987654321"
  }
}

Background Message Handling Configuration#

Please add the following code to your index.js file

 import messaging from '@react-native-firebase/messaging';

 messaging().setBackgroundMessageHandler(async remoteMessage => {
    await SDK.getNotificationData(remoteMessage);
 })

Sample Response:

{
  msgType: "", // String - value "receiveMessage"
  chatType: "", // String - Chat Type - "chat" - Single
  publisherJid: "", // String - Jid - One Who Sends the Message
  publisherId: "", // String - Id - One Who Sends the Message
  fromUserJid: "", // String - From User Jid -
                   // Will Be Same as PublisherJid in Case of Single Chat
  fromUserId: "", // String - From User Id
  toUserJid: "", // String - Jid - One Who Receives the Message
  toUserId: "", // String - To User Id - One Who Receives the Message
  metaData: {}, //Object - Meta data for the message
  msgBody: {
    message: "", // String - Message Body
    message_type: "", // String - Message Type text, image, video, audio & file
    nickName: "", // String - User Nickname
    mentionedUsersIds: [] // Array - Mentioned Ids In case of Group
    media: { // For Media Message Only
      androidHeight: 0,
      androidWidth: 0,
      audioType: "" // String - "file" or "recording"
      caption: "", // String - Media Caption
      duration: "", // String - Duration - For Audio/Videos
      fileName: "", // String - File Name
      file_key: "", // String - File Key
      file_size: "", // Number - File Size
      file_url: "", // String - File Url
      is_downloaded: "", // Number - Downloaded Status
      is_uploading: "", // Number - Uploading Status
      local_path: "", // String - Local Path
      msgId: "", // String - Message Id
      originalHeight: 0, // Number
      originalWidth: 0, // Number
      thumb_image: "", // Base64 - Thumb Image
      webHeight: 0, // Number
      webWidth: 0, // Number
    }
  },
  msgId: "", // String - Message Id
  topicId: "", //String - Topic Id for the message
  msgStatus: "", // Number - Message Status
  timestamp: 1681185232284, // Number - TimeStamp - Milliseconds
  profileDetails:{
    {
        email: "", // String
        fromUser: "", // String
        image: "", // String - File Url
        mobileNumber: "", // String
        nickName: "", // String
        status: "", // String
        thumbImage: "", // Base64 - Thumb Image
        userId: "", // String
    }

}