更新记录

1.1.0(2024-04-26)

  1. 更新iOS SDK为4.3.3版本
  2. 安卓支持荣耀厂商

1.0.9(2023-12-12)

  1. iOS通过setbadge设置角标时同步设置app右上角角标

1.0.8(2023-11-12)

更新iOS SDK4.3.2版本

查看更多

平台兼容性

Android Android CPU类型 iOS
适用版本区间:4.4 - 11.0 armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 适用版本区间:11 - 16

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


mtpush-hbuilder-plugin

EngageLab AppPush 官方支持的 Hbuilder 插件(Android & iOS)。是基于 HBuilder 提供的 uni-app 原生插件扩展 进而开发出的推送插件。

支持 iOS 和 Android 推送,同时适配各大厂商推送。

uniapp插件市场地址

EngageLab推送官方SDK

接入

  • 1.将 nativeplugins/EL-MTPush 导入项目对应位置。
  • 2.项目 manifest.json 中接入 EL-MTPush 插件,并配置插件配置。
  • 3.在项目中引用插件
    const jv = uni.requireNativePlugin('EL-MTPush');

DEMO 体验

按照以下步骤快速体验 MTPush_Hbuilder_demo:

  • 1.在EngageLab portal注册应用并开通推送功能。
  • 2.在项目 manifest.json 中配置您的推送信息
  • 3.HbuilderX 中制作打包自定义基座,包名,签名,bundleID 需要与对应 appkey 配置的应用信息保持一致
  • 4.HbuilderX 使用自定义基座运行即可

1.2 配置插件

HBuilderX 3.6.2 及之后版本,请打开mainfest配置文件,选择 App模块配置,勾选 Push 模块。

注意:不要勾选uniPush!

打开 manifest.xml,选中App原生插件配置,选择本地插件,导入 EL-MTPush

然后配置各个属性,注意在HBuilderX中可能会出现乱序现象,请仔细认真填写

属性 描述 示例
MTPUSH_APPKEY_ANDROID engagelab appkey (必填) EngageLab portal配置应用信息时分配的AppKey
MTPUSH_CHANNEL_ANDROID engagelab channel (选填) 用于统计分发渠道,不需要可填默认值developer-default
MTPUSH_PROCESS_ANDROID Engagelabsdk work thread (必填) Engagelab process,Engagelabsdk工作所在的进程,请填写 :remote
MTPUSH_SITENAME_ANDROID android 数据中心的名称(选填) 您在ipotal设置的数据中心的名称,不填默认新加坡数据中心
MTPUSH_OPPO_APPKEY android oppo appkey(选填) OP-12345678
MTPUSH_OPPO_APPID android oppo appid(选填) OP-12345678
MTPUSH_OPPO_APPSECRET android oppo appSecret(选填) OP-12345678
MTPUSH_VIVO_APPKEY android vivo appkey(选填) 12345678
MTPUSH_VIVO_APPID android vivo appId(选填) 12345678
MTPUSH_HONOR_APPID android honor appId(选填) 12345678
MTPUSH_MEIZU_APPKEY android meizu appkey(选填) MZ-12345678
MTPUSH_MEIZU_APPID android meizu appId(选填) MZ-12345678
MTPUSH_XIAOMI_GLOBAL_APPKEY android xiaomi global appKey(选填) MI-12345678
MTPUSH_XIAOMI_GLOBAL_APPID android xiaomi global appId(选填) MI-12345678
MTPUSH_HUAWEI_APPID android huawei appId(选填) appid=12345678
MTPUSH_GOOGLE_API_KEY G-拼接google-services.json下的current_key(选填) G-12345678
MTPUSH_GOOGLE_APP_ID G-拼接google-services.json下的mobilesdk_app_id(选填) G-12345678
MTPUSH_GOOGLE_PROJECT_ID G-拼接google-services.json下的project_id(选填) G-12345678
MTPUSH_GOOGLE_PROJECT_NUMBER G-拼接google-services.json下的project_number(选填) G-12345678
MTPUSH_GOOGLE_STORAGE_BUCKET G-拼接google-services.json下的storage_bucket(选填) G-12345678
MTPUSH_APPKEY_IOS engagelab appkey (必填) EngageLab portal配置应用信息时分配的AppKey
MTPUSH_CHANNEL_IOS engagelab channel (选填) 用于统计分发渠道,不需要可填默认值developer-default
MTPush_ISPRODUCTION_IOS iOS 是否是生产环境(选填) 是填true,不是填false或者不填
MTPush_ADVERTISINGID_IOS iOS 广告标识符(IDFA)(选填) 如果不需要使用IDFA,可不填
MTPUSH_SITENAME_IOS iOS 数据中心的名称(选填) 您在ipotal设置的数据中心的名称,不填默认新加坡数据中心
MTPush_DEFAULTINITPUSH_IOS iOS 是否默认初始化(选填) 是填true,不是填false或者不填

Android 厂商配置说明

插件支持 OPPO VIVO 魅族 小米 华为 FCM 荣耀七大厂商推送接入,如需接入请对应配置上述厂商信息。

API

参考资料

官方文档

Support

  • 集成前请先尝试 demo 工程跑通
  • 出现问题请先打开 debug 模式,拿到前端和原生日志

Licensemtpush

MIT © EngageLab

隐私、权限声明

1. 本插件需要申请的系统权限列表:

"android.permission.INTERNET", "android.permission.ACCESS_NETWORK_STATE", "android.permission.VIBRATE", "android.permission.SCHEDULE_EXACT_ALARM", "android.permission.WAKE_LOCK", "com.google.android.c2dm.permission.RECEIVE", "android.permission.READ_EXTERNAL_STORAGE", "android.permission.WRITE_EXTERNAL_STORAGE", "android.permission.FOREGROUND_SERVICE", "com.huawei.android.launcher.permission.CHANGE_BADGE", "${applicationId}.permission.PROCESS_PUSH_MSG", "${applicationId}.permission.PUSH_PROVIDER", "${applicationId}.permission.PUSH_WRITE_PROVIDER", "android.permission.RECEIVE_USER_PRESENT", "android.permission.READ_PHONE_STATE", "android.permission.WRITE_SETTINGS", "android.permission.MOUNT_UNMOUNT_FILESYSTEMS", "android.permission.ACCESS_WIFI_STATE", "android.permission.SYSTEM_ALERT_WINDOW", "android.permission.ACCESS_COARSE_LOCATION", "android.permission.CHANGE_WIFI_STATE", "android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_BACKGROUND_LOCATION", "android.permission.ACCESS_LOCATION_EXTRA_COMMANDS", "android.permission.CHANGE_NETWORK_STATE", "android.permission.GET_TASKS", "android.permission.QUERY_ALL_PACKAGES", "com.coloros.mcs.permission.RECIEVE_MCS_MESSAGE", "com.heytap.mcs.permission.RECIEVE_MCS_MESSAGE", "com.push.permission.UPSTAGESERVICE"

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

详情见 https://www.engagelab.com/license/privacy

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

请参考开源项目地址的开源协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问