SDK Installation

Installing using BOM

Integration using BOM is the recommended way of integration; refer to the Install Using BOM document. Once you have configured the BOM add the dependency in the app/build.gradle file as shown below

dependencies {
    ...
    implementation("com.moengage:rich-notification")
}

Version numbers are not required for this dependency; the BOM manages it.

Timer with Progress Bar

Schedule Exact Alarm Permission

The SDK uses Alarms to periodically update the progress in the progress bar. Starting Android 12, additional permission is required to use exact alarms. Refer to the documentation for more details. To support the Timer with Progress Bar template on Android 12 and above devices, add the following permission in your manifest file.

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

Starting Android 14, the Alarm permission is off by default. So you need to ask for explicit Alarm permission if you want to show Timer notifications apart from adding the previous line in your manifest file. Verify if the permission is already granted and accordingly call the following line to get the Alarm permission from the customer.

startActivity(Intent(Settings.ACTION_REQUEST_SCHEDULE_EXACT_ALARM))

startActivity(new Intent(Settings.ACTION_REQUEST_SCHEDULE_EXACT_ALARM));

If the application does not have the SCHEDULE_EXACT_ALARM permission, the Timer with Progress Bar template is not shown. Instead, the SDK falls back to the backup template configured for the campaign on the MoEngage dashboard. The backup template is the alternate notification you select when creating a Timer with Progress Bar campaign — it shows the timer but omits the progress bar so the notification can still be delivered.

Customization

The SDK defines the default color values for the progress bar’s background and progress color. These can be customized to suit the application’s theme by overriding the values for the below SDK-defined color attributes. To set the custom color in light and dark mode, override the values in res/values/colors.xml and res/values-night/colors.xml, respectively.

<color name="moe_rich_push_progress_bar_background_color">[YOUR_COLOR]</color>
<color name="moe_rich_push_progress_bar_progress_color">[YOUR_COLOR]</color>

Icon Shortcuts

Icon Shortcuts displays a row of three to six tappable icons, each with its own click action, on Android 12 and above. Marketers configure the template in the campaign as a moeFeatures key-value pair, so your app needs no additional code.

Minimum versions: com.moengage:moe-android-sdk 15.04.00 and com.moengage:rich-notification 7.2.0. Users on app versions built with older SDKs receive the Basic notification.
Destinations: make sure your app handles every deep link and screen name used in an icon. An icon can also carry a custom action, which reaches your handleCustomAction() override.

For the payload reference and the campaign steps, refer to Icon Shortcuts Template for Android.

​SDK Installation

​Installing using BOM

​Timer with Progress Bar

​Schedule Exact Alarm Permission

​Customization

​Icon Shortcuts