Basic Setup

Follow the basic setup outlined in this section to enable push notifications on an Android device using MoEngage.

• FCM Setup on MoEngage Dashboard - FCM Authentication is the method to enable sending push notifications to your app installed on Android devices. Use the methods mentioned in this article to authenticate MoEngage to access Firebase services.
• Adding metadata for push notification - Set the small icon and large icon drawable and other options to handle push notifications using the methods available in this article.
• Android Notification Runtime Permissions - When the application is running on Android 13 to show notifications to the user, applications would need to request the user for notification permission. Refer to the methods available in this article to handle permission requests.
• Push Registration and Receiving - To use Push Notification in your React Native application, you must configure Firebase. Configuring Firebase steps will depend on how you want to integrate it. MoEngage recommends leaving the push handling to MoEngage SDK, as the best practices are properly integrated. You can also handle the push at your app level. In any case, look at the following section that applies to you and finish the integration steps.
  Let MoEngage handle Push(Recommended) You handle Push via Android Native You handle Push via Capacitor (Not Recommended)

  Add messaging service
  You must add the messaging service to the Manifest file for MoEngage SDK to show the notifications. Refer to this document here.

  Callback on token registration (optional)
  To get a callback whenever a new token is registered or refreshed, refer to the method here.

  Notification Clicked Callback

  To receive a callback whenever a push is clicked and for custom handling redirection, use the method in this article.

  How to opt out of MoEngage Registration?
  The MoEngage SDK attempts to register for a push token; since your application handles push, you need to opt out of SDK's token registration using the method in this article.

  Pass the Push Token To MoEngage SDK - After receiving the push token from FCM, use the method in this article to pass the Push Token to the MoEngage SDK to set it in the MoEngage platform.

  Passing the Push payload to the MoEngage SDK - After receiving the push payload on the app, use the method in this article to send out push notifications to the device.

  warning

  Warning MoEngage recommends using the Android native APIs to pass the push payload to the MoEngage SDK instead of the React-Native/Javascript APIs. React-Native Engine might not get initialized if the application is killed or if the notification is not sent at a high priority.

  • Pass the Push Token To MoEngage SDK
  • Pass the Push payload to the MoEngage SDK
  • Callbacks and customizations

   

   

Capacitor APIs

Passing Push Token

import { MoECapacitorCore } from 'capacitor-moengage-core'
// pass the push token as a string
passFcmPushToken({ token: "TOKEN", appId: "YOUR_APP_ID" });

Passing Push Payload

import { MoECapacitorCore } from 'capacitor-moengage-core'
// pass the push payload object
passFcmPushPayload(payload: object, appId: "YOUR_APP_ID" });

Notification Runtime Permission

Android 13 (API level 33) and higher supports runtime permission for sending non-exempt(including Foreground Services (FGS)) notifications from an app POST_NOTIFICATIONS. This change helps users focus on the notifications that are most important to them.

Refer to the official documentation for more details.

The below-mentioned APIs are supported from Plugin version 2.0.0

When the application is running on Android 13 to show notifications to the user, applications would need to request the user for notification permission.

For applications integrating the MoEngage SDK, would need to 

• Notify the SDK of the permission request's response from the user.
• If the application has already requested push permission(before MoEngage integration) help MoEngage set up notification channels for notification display.

Notify SDK of permission result

Once the application requests the user for notification permission notify the SDK of the user response using the below API.

import { MoECapacitorCore} from 'capacitor-moengage-core'
MoECapacitorCore.pushPermissionResponseAndroid({ isGranted: true/false });

Setup Notification Channels

If the application has already taken notification permission from the user call the below API to set up Notification Channels for showing push notifications.

import { MoECapacitorCore} from 'capacitor-moengage-core'
MoECapacitorCore.setupNotificationChannelsAndroid();

MoEngage SDK provides helper APIs to show the permission request to the end-user or navigate the user to the settings screen for enabling notifications.

Use the below API to show the permission request dialog to the user.

When using the below API SDK automatically tracks the response, sets up the required notification channel, etc, mentioned above.

import { MoECapacitorCore} from 'capacitor-moengage-core'
MoECapacitorCore.requestPushPermissionAndroid();

Use the below API to show navigate the user to the Notification Settings for the application on the device.

Note: Below Android 8(API level 26) the user is directed to the Application Info screen of your application.

import { MoECapacitorCore} from 'capacitor-moengage-core'
MoECapacitorCore.navigateToSettingsAndroid();