Configuring HMS Push Kit

Prerequisites

  • Ensure that you have configured Push Kit on your application.
    For more information, refer to HMS Push Kit documentation.
  • Ensure that you configure MoEngage SDK for receiving push notifications

Configure your account on MoEngage

Navigate to the Settings Page `Dashboard --> Settings --> Channel --> Push --> Mobile Push --> Push Amp+` on the MoEngage Dashboard and add the Huawei Push Settings under the Push Amp+ Tab

601c695-Screenshot_2020-09-09_at_1.44.24_PM.png

SDK Installation

MavenBadge

build.gradle
implementation("com.moengage:hms-pushkit:$sdkVersion")

replace $sdkVersion with the appropriate SDK version

We recommend integrating the MoEngage Dependency Catalog to easier dependency management. Refer to the documentation to know more.

Push Token Management

When using MoEngage SDK you can either register for token and pass on to the MoEngage SDK or simply let MoEngage SDK register for Push Token.

Token Registration Handled by Application

If your application is registering for Push Notification use the below API to pass the Push token to the MoEngage SDK.

Kotlin Java
MoEPushKitHelper.getInstance().passPushToken(context, token)

Token Registration Handled by MoEngage

By default, the MoEngage SDK does not register for push token. You can enable the token registration using the below API in the MoEngage.Builder while initializing the SDK

Kotlin Java
    val moEngage = MoEngage.Builder(this, "XXXXXXXX")
        .enablePushKitTokenRegistration()
        .build()
    MoEngage.initialise(moEngage)

Add the below Service in your application's Manifest file.

AndroidManifest.xml
 <service
    android:name="com.moengage.hms.pushkit.MoEPushKitMessageService"
    android:exported="false">
  <intent-filter>
    <action android:name="com.huawei.push.action.MESSAGING_EVENT" />
  </intent-filter>
</service>>

When MoEngage SDK handles push registration it optionally provides a callback to the Application whenever a new token is registered or the token is refreshed.
An application can get this callback by implementing PushKitEventListener and registering for a callback in the Application class onCreate() using MoEPushKitHelper.getInstance().addEventListener()

 

To use Push Kit you need to update the moe-android-sdk to 10.3.00 or above.

Version Compatibility

The hms-pushkit artifact/module is dependent on the Core SDK or moe-android-sdk artifact/module.
Based on the version of the Core SDK you are using choose the right version of the Push Kit module.

Core SDK Version Push Kit Version
11.4.00 and above 2.4.00 and above
11.2.00 - 11.3.01 2.2.00 - 2.3.00
11.1.00 2.1.00
11.0.03 - 11.0.05 2.0.01, 2.0.02
11.0.01 - 11.0.02 2.0.00
10.6.00 1.2.00
10.4.00 - 10.5.00 1.1.00
10.3.00 1.0.00
Was this article helpful?
0 out of 0 found this helpful