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

SDK Installation

Installing Using BOM

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

dependencies {
      ...
      implementation("com.moengage:hms-pushkit")
}

Alternatively, you can add the dependency using Artifact ID as described in Installation using Artifact ID. However, installation using BOM is the recommended approach as installing using Artifact ID may lead to version mismatch if mapped incorrectly. 

Push Token Management

When using MoEngage SDK, you can either register for a token and pass it 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.

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

MoEPushKitHelper.Companion.getInstance().passPushToken(context, token);

Token Registration Handled by MoEngage

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

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

MoEngage moEngage =
    new MoEngage.Builder(this, "XXXXXXXXXX")
        .enablePushKitTokenRegistration()
        .build();
MoEngage.initialise(moEngage);

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

 <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()

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.