MixPush Hybrid Push SDK

MixPush is a hybrid push SDK that integrates six major manufacturer push platforms (Xiaomi, Huawei, OPPO, VIVO, Meizu, and Apple APNs) to ensure high delivery rates (90%+) even when the app is killed. It intelligently selects the best available manufacturer channel for the device, sharing system channels to avoid the need for the app to run continuously in the background.

Key Features:

• High Delivery Rate: Uses system-level manufacturer channels to reach users even if the app is killed.
• Intelligent Selection: Automatically chooses the most appropriate push platform based on device support.
• Low Integration Cost: Provides a unified interface for multiple manufacturers.
• Server-side Support: Includes Java code for easy backend implementation.

Important Note: This SDK does not support commercial third-party push platforms to avoid unauthorized advertising and user interference.

MixPush supports various features across different manufacturers. Use this table to plan your push strategy:

Recommendations:

1. Fallback: If a manufacturer push is not supported, use Xiaomi push.
2. Unified ID: Since Huawei does not support aliases/tags, it is recommended to use regId for all pushes.
3. Passthrough: If you require passthrough support, use Xiaomi push as the primary method.
4. Global Push: Since Huawei and APNs do not support global push, target users who have opened the app in the last 3 months to avoid expired tokens.

To use MixPush, you must first configure your Gradle files to include the Huawei AgConnect plugin and the necessary repositories.

1. Root build.gradle configuration: Add mavenCentral() and the Huawei repository.

2. App build.gradle configuration: Apply the Huawei AgConnect plugin and define manifestPlaceholders for the various manufacturer credentials.

// Root build.gradle
buildscript {
    repositories {
      	...
        mavenCentral()
        maven { url 'http://developer.huawei.com/repo/' }
    }
    dependencies {
        ...
        classpath 'com.huawei.agconnect:agcp:1.6.0.300'
    }
}
allprojects {
    repositories {
        ...
        mavenCentral()
        jcenter()
        maven { url 'http://developer.huawei.com/repo/' }
    }
}

// App build.gradle
apply plugin: 'com.huawei.agconnect'
android {
    compileSdkVersion 31
    defaultConfig {
        ...
        manifestPlaceholders["VIVO_APP_ID"] = "<VIVO_APP_ID>"
        manifestPlaceholders["VIVO_APP_KEY"] = "<VIVO_APP_KEY>"
        manifestPlaceholders["MI_APP_ID"] = "<MI_APP_ID>"
        manifestPlaceholders["MI_APP_KEY"] = "<MI_APP_KEY>"
        manifestPlaceholders["OPPO_APP_KEY"] = "<OPPO_APP_KEY>"
        manifestPlaceholders["OPPO_APP_SECRET"] = "<OPPO_APP_SECRET>"
        manifestPlaceholders["MEIZU_APP_ID"] = "<MEIZU_APP_ID>"
        manifestPlaceholders["MEIZU_APP_KEY"] = "<MEIZU_APP_KEY>"
    }
}
dependencies {
    def mixpush_version = '2.4.0'
    implementation "io.github.mixpush:mixpush-core:$mixpush_version" // Core
    implementation "io.github.mixpush:mixpush-mi:$mixpush_version" // Xiaomi
    implementation "io.github.mixpush:mixpush-meizu:$mixpush_version"  // Meizu
    implementation "io.github.mixpush:mixpush-huawei:$mixpush_version"  // Huawei
    implementation "io.github.mixpush:mixpush-oppo:$mixpush_version"  // OPPO
    implementation "io.github.mixpush:mixpush-vivo:$mixpush_version"  // VIVO
}

To use MixPush, you need to implement a MixPushReceiver to handle registration success and notification clicks, then initialize the SDK in your Application class.

1. Implement MixPushReceiver: Override onRegisterSucceed to upload the regId and platform info to your server. Override onNotificationMessageClicked to handle user interaction with notifications.

2. Initialize in Application: Set the receiver and call register(this). By default, it initializes 5 platforms (Xiaomi, Huawei, Meizu, OPPO, VIVO) using Xiaomi as the recommended default.

3. Retrieve regId: Use MixPushClient.getInstance().getRegisterId() to get the unique registration ID for the current device and send it to your backend.

// 1. Define the Receiver
public class MyPushReceiver extends MixPushReceiver {
    @Override
    public void onRegisterSucceed(Context context, MixPushPlatform mixPushPlatform) {
        // TODO: Upload regId and platform info to your server
    }

    @Override
    public void onNotificationMessageClicked(Context context, MixPushMessage message) {
      // TODO: Handle notification click (e.g., open a specific page)
    }
}

// 2. Initialize in Application
// MixPush.getInstance().setLogger(new PushLogger(){});
MixPush.getInstance().setPushReceiver(new MyPushReceiver());
MixPush.getInstance().register(this);

// 3. Get regId (Call this in your Activity's onCreate, e.g., Home Activity)
MixPushClient.getInstance().getRegisterId(this, new GetRegisterIdCallback() {
    public void callback(MixPushPlatform platform) {
        if (platform != null) {
            Log.e("GetRegisterIdCallback", platform.toString());
            // TODO: Upload regId to your server
        }
    }
});

Add the following rules to your ProGuard configuration to prevent the SDK and its manufacturer-specific providers from being obfuscated or stripped during the build process.

# MixPush
-keep class com.mixpush.mi.MiPushProvider {*;}
-keep class com.mixpush.meizu.MeizuPushProvider {*;}
-keep class com.mixpush.huawei.HuaweiPushProvider {*;}
-keep class com.mixpush.oppo.OppoPushProvider {*;}
-keep class com.mixpush.vivo.VivoPushProvider {*;}
 
# 华为推送
-ignorewarnings
-keepattributes *Annotation*
-keepattributes Exceptions
-keepattributes InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
-keep class com.huawei.hianalytics.**{*;}
-keep class com.huawei.updatesdk.**{*;}
-keep class com.huawei.hms.**{*;}

# 小米推送
-keep class com.xiaomi.**{*;}

# OPPO
-keep public class * extends android.app.Service
-keep class com.heytap.msp.** { *;}

# VIVO
-dontwarn com.vivo.push.** 
-keep class com.vivo.push.**{*; }
-keep class com.vivo.vms.**{*; }

# 魅族
-keep class com.meizu.**{*;}