Connecting notifications on Android🔗

To integrate notifications, you need to make a few simple steps:

Receiving notifications🔗

Step 1. Import the notification module🔗

dependencies {
    def mrgsVersion = "5.0.0"
    implementation "games.my.mrgs:notifications:$mrgsVersion"
}

dependencies {
    implementation(name: 'MRGSNotifications', ext:'aar')

    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'com.google.firebase:firebase-messaging:23.1.2'

    // Uncomment for Huawei/AppTouch Store
    // implementation 'com.huawei.hms:push:6.11.0.300'
}

Step 2. (Optional) Server notifications🔗

If you want to send notifications to the client via your server or MGC server, you need to connect Firebase Cloud Messaging or Huawei Push Kit for Huawei/AppTouch Store.

Firebase Cloud Messaging🔗

• Copy the googe-services.json file downloaded from the Google Firebase console to the root directory of your project.
• Add a dependency to google-services plugin to the build.gradle file:

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        //...
        classpath 'com.google.gms:google-services:4.3.13'
    }
}

• Add a call to the google-services plugin with the last line in the build.gradle file:

apply plugin: 'com.google.gms.google-services'

Huawei Push Kit🔗

• Sign in to AppGallery Connect and click My projects.
• Find your app project and click the app.
• Go to Project settings > General information. In the App information area, download the agconnect-services.json file. Add this json file to the root of your project.
• Add a dependency to agconnect plugin to the build.gradle file:

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        //...
        classpath 'com.huawei.agconnect:agcp:1.8.0.300'
    }
}

• Add a call to the agconnect plugin with the last line in the build.gradle file:

apply plugin: 'com.huawei.agconnect'

• For full information on integrating Huawei Push Kit see documentation.

Step 3. Configure the notification receiving delegate🔗

To receive a callback about a notification arrival, or about a click on it, it is necessary to install a listener:

import games.my.mrgs.MRGSMap;
import games.my.mrgs.notifications.MRGSNotificationCenter;
import games.my.mrgs.notifications.MRGSPushNotificationHandler;

final MRGSPushNotificationDelegate notifyDelegate = new MRGSPushNotificationDelegate() {
    @Override
    public void clickOnNotification(int idNotify, String title, String msg, MRGSMap developerPayload, boolean isLocal) {

    }

    @Override
    public void receivedNotification(int idNotify, String title, String msg, MRGSMap developerPayload, boolean isLocal) {

    }
};

MRGSNotificationCenter.getInstance().setLocalDelegate(notifyDelegate);

• idNotify - id of the scheduled notification.
• title - notification title.
• msg - notification message.
• developerPayload - additional information, if the developer added any when creating the notification.
• isLocal - true if local notification, false if a server one.

Working with notifications🔗

Creating notifications🔗

To create notifications, use the MRGSPushNotification class. To display a notification, you need to create an instance of this class using the create method and specify the main notification parameters: id (digital identifier of the notification that can help you determine which notification worked), message text (message) and time in seconds in Unix Time format that shows when the notification will be made.

int time = MRGS.timeUnix() + 10; // After 10 seconds
int notifyId = 12345;
MRGSPushNotification notification = MRGSPushNotification.create("Local Push notification", notifyId, time);

Sending notifications🔗

After the notification was created using the MRGSPushNotification.create method, it can be sent to the notification scheduler:

import games.my.mrgs.notifications.MRGSNotificationCenter;

MRGSNotificationCenter.getInstance().addLocalPush(notification);

notification.setChannelId("my_channel_id");
notification.setChannelGroupId("my_group_id");

MRGSNotificationCenter.getInstance().addLocalPush(notification);

Getting a list of notifications🔗

For a list of all scheduled notifications, use the following method:

import games.my.mrgs.MRGSList;
import games.my.mrgs.notifications.MRGSNotificationCenter;

MRGSList notifications = MRGSNotificationCenter.getInstance().getAllLocalPushes();

Receiving notification information🔗

If you want to get the MRGSPushNotification object by its id, use the following method:

import games.my.mrgs.notifications.MRGSNotificationCenter;
import games.my.mrgs.notifications.MRGSPushNotification;

MRGSPushNotification notification = MRGSNotificationCenter.getInstance().getLocalPush(notificationId);

Canceling notifications🔗

If you want to cancel (delete) a scheduled notification, use the following method:

import games.my.mrgs.notifications.MRGSNotificationCenter;

MRGSNotificationCenter.getInstance().removeLocalPush(context, notificationId);

• context - Application Context.
• notificationId - notification id that you've set when calling the MRGSPushNotification.create method.

Visibility of notifications on LockScreen(secure)🔗

If you need additional control over the visibility of notifications on a secure lock screen (which is protected by a password, pin, etc.), you must specify the scope.

import games.my.mrgs.notifications.MRGSNotificationCenter;
import games.my.mrgs.notifications.MRGSPushNotification;

MRGSPushNotification notification = MRGSPushNotification.setVisibility(visibility);
MRGSNotificationCenterImpl.getInstance().addLocalPush(notification);

• visibility - one of the parameters of MRGSPushNotification.VISIBILITY_PUBLIC, MRGSPushNotification.VISIBILITY_PRIVATE, MRGSPushNotification.VISIBILITY_SECRET;