只支持 Android 和 iOS。

最低支持 iOS12。

插件市场地址

Github

• 3.在项目中引用插件

import {  InitPushParams, initPush, setDebugMode, addEventCallBack, EventCallBack, EventCallBackParams, setBadge, SetBadge, getRegistrationId } from "@/uni_modules/engagelab-mtpush"

{
    "ENGAGELAB_PRIVATES_APPKEY" : "xxx",
    "ENGAGELAB_PRIVATES_CHANNEL": "xxx",
    "ENGAGELAB_PRIVATES_PROCESS": ":remote",
	"XIAOMI_APPID" : "MI-xxx",
	"XIAOMI_APPKEY" : "MI-xxx",
	"MEIZU_APPID" : "MZ-xxx",
	"MEIZU_APPKEY" : "MZ-xxx",
	"OPPO_APPID" :  "OP-xxx",
	"OPPO_APPKEY" : "OP-xxx",
	"OPPO_APPSECRET" : "OP-xxx",
	"VIVO_APPID":  "xxx",
	"VIVO_APPKEY" : "xxx",
	"HONOR_APPID" : "xxx"
}

如果支持谷歌通道，在应用的 nativeResources/android 目录下，放入 google-services.json 文件。 如果支持华为通道，在应用的 nativeResources/android 目录下，放入 agconnect-services.json 文件。

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

• 厂商通道参数申请指南

官方文档

集成了 sdk 回调的事件

• param:返回的事件数据
  • param["event_name"]: 为事件类型
    • android:
      • "onNotificationStatus":应用通知开关状态回调,Map格式。enable属性：true为打开，false为关闭
      • "onConnectStatus":长连接状态回调, Map格式。enable属性：true为打开，false为关闭
      • "onNotificationArrived":通知消息到达回调，内容为通知消息体
      • "onNotificationClicked":通知消息点击回调，内容为通知消息体
      • "onNotificationDeleted":通知消息删除回调，内容为通知消息体
      • "onCustomMessage":自定义消息回调，内容为通知消息体
      • "onPlatformToken":厂商token消息回调，内容为厂商token消息体
      • "onTagMessage":tag操作回调
      • "onAliasMessage":alias操作回调
      • "onNotificationUnShow":在前台，通知消息不显示回调（后台下发的通知是前台信息时）
      • "onInAppMessageShow": 应用内消息展示
      • "onInAppMessageClick": 应用内消息点击
    • ios:
      • "onNotificationStatus":检测通知权限授权情况。Map格式。enable属性：true为打开，false为关闭。需要先调用getNotiAuth() 接口。
      • "onConnectStatus":长连接状态回调, Map格式。enable属性：true为打开，false为关闭
      • "onNotificationArrived":通知消息到达回调，内容为通知消息体（同原生平台willPresentNotification回调）
      • "onNotificationClicked":通知消息点击回调，内容为通知消息体
      • "onCustomMessage":自定义消息回调，内容为通知消息体
      • "onTagMessage":tag操作回调 //todo
      • "onAliasMessage":alias操作回调
      • "onInAppMessageShow": 应用内消息展示
      • "onInAppMessageClick": 应用内消息点击
      • "onNotiInMessageShow": 增强提醒展示
      • "onNotiInMessageClick": 增强提醒点击
  • param["event_data"]: 为对应内容，Map格式

let eventCallBack = {
	callback: (res: EventCallBack) => {
		console.log(res);
	}
} as EventCallBackParams;
addEventCallBack(eventCallBack);

初始化sdk

  function initPush(param: InitPushParams): void

// appkey对iOS生效，安卓的appkey需要配置在应用的 nativeResources/android/manifestPlaceholders.json中
let options = {
	appkey: '您的appkey',
	channel: 'test',
	isProduction: false
} as InitPushParams;
initPush(options);

设置是否debug模式，debug模式会打印更对详细日志

function setDebugMode(paramA : boolean) : void

• param: 是否调试模式，true为调试模式，false不是

setDebugMode(true);//发布前要删除掉

开启或者关闭设备更换时重置RegistrationID的功能。若开启时，当检测到设备发生变化时（只有当设备型号发生变化时），会自动清除注册信息，重新注册。

需要在 initPush 之前调用。

默认为关闭。

function setEnableResetOnDeviceChange(enable: boolean): void

• enable: 是否开启设备更换时重置RegistrationID功能，true为开启，false为关闭

setEnableResetOnDeviceChange(true);

RegistrationID 定义: 获取当前设备的registrationId，Engagelab唯一标识，可同于推送

function getRegistrationId(): string

调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 MTPush 的服务器时才返回对应的值，否则返回空字符串。

const rid = getRegistrationId();

android: 仅华为/荣耀生效

function setBadge(param: number) : void 

无

 setBadge(2);

设置为true, 可以在国内测试fcm通道，需要在初始化函数之前调用。

该接口只用作测试，正式环境请不要调用该接口！！！

export function testConfigGoogle(enable: boolean) : void 

• enable: 是否开启fcm调试模式，true为是，false不是

testConfigGoogle(true);

调用该函数之前，请先调用 addEventCallBack(param: EventCallBackParams) : void 接口注册事件监听。

回调 event_name 为 "onNotificationStatus" 事件。

export function getNotiAuth() : void 

无

getNotiAuth();