集成筹备
注册账号
应用PushSDK之前,须要先在MobTech官网注册开发者账号,并获取MobTech提供的AppKey和AppSecret,详情能够点击查看注册流程
MobPush后盾配置
注册MobTech账号后,须要在MobTech后盾进行相干信息的配置,详情能够点击查看具体配置信息
MobPush流程图
Flutter 插件导入
这是一个基于 MobPush 性能的扩大的 Flutter 插件。应用此插件可能帮忙您在应用 Flutter 开发利用时,疾速地实现推送性能。
在pubspec.yaml文件中退出上面依赖
dependencies: mobcommonlib: mobpush_plugin:
而后执行:flutter packages get 导入package 在你的dart工程文件中,导入上面头文件,开始应用
import 'package:mobcommonlib/mobcommonlib.dart';import 'package:mobpush_plugin/mobpush_plugin.dart';
Android端配置
配置Maven
在我的项目根目录的build.gradle中增加以下代码:
buildscript { repositories { // 配置Mob Maven库 maven { url "https://mvn.mob.com/android" } // 配置HMS Core SDK的Maven仓地址。(集成华为厂商须要增加) maven { url 'https://developer.huawei.com/repo/'} } ... } dependencies { ... // 集成MobPush classpath "com.mob.sdk:MobSDK2:+" }}
配置引入
在 /android/app/build.gradle 中增加以下代码:
// 导入MobSDKapply plugin: 'com.mob.sdk'
配置依赖
在我的项目的/android/app/build.gradle中增加:
MobSDK { appKey "您的MobTech平台appKey" appSecret "您的MobTech平台appSecret" //配置MobPush MobPush { //配置厂商推送(可选配置,不须要厂商推送可不配置,须要哪些厂商推送只需配置哪些厂商配置即可) devInfo { //配置小米厂商推送 XIAOMI { appId "您的小米平台appId" appKey "您的小米平台appKey" } //配置华为厂商推送 HUAWEI { appId "您的华为平台appId" } //配置魅族厂商推送 MEIZU { appId "您的魅族平台appId" appKey "您的魅族平台appKey" } //配置FCM厂商推送 FCM { //设置默认推送告诉显示图标 iconRes "@mipmap/default_ic_launcher" } //配置OPPO厂商推送 OPPO { appKey "您的OPPO平台appKey" appSecret "您的OPPO平台appSecret" } //配置VIVO厂商推送 VIVO { appId "您的VIVO平台appId" appKey "您的VIVO平台appKey" } } }}
增加混同代码
在我的项目中增加如下混同代码
-keep class com.mob.**{*;}-dontwarn com.mob.**
隐衷受权
为保障您的App在集成MobSDK之后可能满足工信部相干合规要求,您应确保App装置首次冷启动且获得用户浏览您《隐衷政策》受权之后,调用Mobcommonlib.submitPolicyGrantResult(true, null)回传隐衷协定受权后果。反之,如果用户不批准您App《隐衷政策》受权,则不能调用Mobcommonlib.submitPolicyGrantResult(true, null回传隐衷协定受权后果。 请参考链接合规指南
/** * 回传用户隐衷受权后果 * @param status 用户是否批准隐衷协定 * @param result 默认传null */ Mobcommonlib.submitPolicyGrantResult(bool status, Function(bool)? result)
参数
类型
作用
必填
status
bool
是否批准隐衷
是
result
Function(bool)
回调
是
例:
Mobcommonlib.submitPolicyGrantResult(true, null);
日志调试
请在AndroidManifest.xml文件中 <application>
下增加下面配置,在日志控制台即可查看到TAG为MobPushLog的相干日志:
<meta-data android:name="com.mob.mobpush.debugLevel" android:value="4" />
测试确认
- 确认通过gradle已拉取到fluuter的push插件 mobpush\_pligin\_x.x.x
- 确认 AppKey曾经正确的写入 Androidmanifest.xml(可在app-debug.apk中的Androidmanifest查看确认)
- 确认测试手机曾经调用隐衷协定接口,并上传true : Mobcommonlib.submitPolicyGrantResult(true, null);
- 确认测试手机(或者模拟器)已胜利连入网络 + 客户端调用,不要应用网络代理和VPN,如果一切正常,启动我的项目后应有MobPushLog的日志信息,参考tag如下
iOS
配置推送
在我的项目的Info.plist中增加2个字段:“MOBAppKey”和“MOBAppSecret”,对应的值是在Mob.com官网申请的利用的AppKey和AppSecret。
Xcode 配置
1.在我的项目中增加Capability配置:Push Notifications,如下图所示
2.在我的项目中增加Capability配置:Background Modes,并勾选“Remote notifications”,如下图所示)
隐衷受权
为保障您的App在集成MobSDK之后可能满足工信部相干合规要求,您应确保App装置首次冷启动且获得用户浏览您《隐衷政策》受权之后,调用Mobcommonlib.submitPolicyGrantResult(true, null)回传隐衷协定受权后果。反之,如果用户不批准您App《隐衷政策》受权,则不能调用Mobcommonlib.submitPolicyGrantResult(true, null回传隐衷协定受权后果。 请参考链接合规指南
/** * 回传用户隐衷受权后果 * @param status 用户是否批准隐衷协定 * @param result 默认传null */ Mobcommonlib.submitPolicyGrantResult(bool status, Function(bool)? result)
参数
类型
作用
必填
status
bool
是否批准隐衷
是
result
Function(bool)
回调
是
例:
Mobcommonlib.submitPolicyGrantResult(true, null);
SDK API
回传用户隐衷受权后果 (submitPrivacyGrantResult)
/** * 回传用户隐衷受权后果 * @param status 用户是否批准隐衷协定 * @param result 默认传null */ Mobcommonlib.submitPolicyGrantResult(bool status, Function(bool)? result)
参数
类型
作用
必填
status
bool
是否批准隐衷
是
result
Function(bool)
回调
是
例:
Mobcommonlib.submitPolicyGrantResult(true, null);
设置近程推送环境,向用户受权(setCustomNotification仅 iOS)
setCustomNotificationif (Platform.isIOS) { MobpushPlugin.setCustomNotification();}
设置近程推送环境 (setAPNsForProduction仅 iOS)
setAPNsForProductionif (Platform.isIOS) { // 开发环境 false, 线上环境 true MobpushPlugin.setAPNsForProduction(false)}
增加推送回调监听(addPushReceiver 接管自定义透传音讯回调、接管告诉音讯回调、接管点击告诉音讯回调、接管别名或标签操作回调)
addPushReceiverMobpushPlugin.addPushReceiver(_onEvent, _onError);void _onEvent(Object event) {}void _onError(Object event) {}
进行推送(stopPush)
stopPushMobpushPlugin.stopPush();
从新关上推送服务(restartPush)
restartPushMobpushPlugin.restartPush();
是否已进行接管推送(isPushStopped)
isPushStoppedMobpushPlugin.isPushStopped();
设置别名(setAlias)
setAliasMobpushPlugin.setAlias("别名").then((Map<String, dynamic> aliasMap){ String res = aliasMap['res']; String error = aliasMap['error']; String errorCode = aliasMap['errorCode']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> setAlias -> res: $res error: $error");});
获取别名(getAlias)
getAliasMobpushPlugin.getAlias().then((Map<String, dynamic> aliasMap){ String res = aliasMap['res']; String error = aliasMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> getAlias -> res: $res error: $error");});
删除别名(deleteAlias)
deleteAliasMobpushPlugin.deleteAlias().then((Map<String, dynamic> aliasMap){ String res = aliasMap['res']; String error = aliasMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> deleteAlias -> res: $res error: $error");});
增加标签(addTags)
addTagsList tags = new List();tags.add("tag1");tags.add("tag2");MobpushPlugin.addTags(tags).then((Map<String, dynamic> tagsMap){ String res = tagsMap['res']; String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> addTags -> res: $res error: $error");});
获取标签(getTags)
getTagsMobpushPlugin.getTags().then((Map<String, dynamic> tagsMap) { List<String> resList; if (tagsMap['res'] == null) { resList = []; } else { resList = tagsMap['res'].toList(); } String error = tagsMap['error']; print( ">>>>>>>>>>>>>>>>>>>>>>>>>>> getTags -> res: $resList error: $error"); });
删除标签(deleteTags)
deleteTagsList tags = new List();tags.add("tag1");tags.add("tag2");MobpushPlugin.deleteTags(tags).then((Map<String, dynamic> tagsMap){ String res = tagsMap['res']; String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> deleteTags -> res: $res error: $error");});
清空标签(cleanTags)
cleanTagsMobpushPlugin.cleanTags().then((Map<String, dynamic> tagsMap){ String res = tagsMap['res']; String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> cleanTags -> res: $res error: $error");});
发送本地告诉(addLocalNotification)
addLocalNotificationMobpushPlugin.addLocalNotification();
绑定手机号(bindPhoneNum)
bindPhoneNumMobpushPlugin.bindPhoneNum("110");
测试模仿推送,用于测试(send)
send/** * 测试模仿推送,用于测试 * type:模仿音讯类型,1、告诉测试;2、内推测试;3、定时 * content:模仿发送内容,500字节以内,UTF-8 * space:仅对定时音讯无效,单位分钟,默认1分钟 * extras: 附加数据,json字符串 */MobpushPlugin.send(int type, String content, int space, String extras).then((Map<String, dynamic> sendMap){ String res = sendMap['res']; String error = sendMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> send -> res: $res error: $error");});
设置点击告诉是否跳转默认页 (setClickNotificationToLaunchMainActivity 仅Android)
setClickNotificationToLaunchMainActivityMobpushPlugin.setClickNotificationToLaunchMainActivity (bool enable);
移除本地告诉(removeLocalNotification 仅Android)
removeLocalNotificationMobpushPlugin.removeLocalNotification(int notificationId);
清空本地告诉(clearLocalNotifications 仅)
clearLocalNotificationsMobpushPlugin.clearLocalNotifications();
设置告诉栏icon,不设置默认取利用icon(setNotifyIcon 仅Android)
setNotifyIconMobpushPlugin.setNotifyIcon(String resId);
设置告诉静音时段(推送选项)(setSilenceTime 仅Android)
setSilenceTime/** * 设置告诉静音时段(推送选项)(仅Android) * @param startHour 开始工夫[0~23] (小时) * @param startMinute 开始工夫[0~59](分钟) * @param endHour 完结工夫[0~23](小时) * @param endMinute 完结工夫[0~59](分钟) */MobpushPlugin.setSilenceTime(int startHour, int startMinute, int endHour, int endMinute)
设置角标 (setBadge仅 iOS)
setBadgeMobpushPlugin.setBadge(int badge);
清空角标,不革除告诉栏音讯记录 (clearBadge仅 iOS)
clearBadgeMobpushPlugin.clearBadge();
获取注册Id(getRegistrationId)
getRegistrationIdMobpushPlugin.getRegistrationId().then((Map<String, dynamic> ridMap) { print(ridMap); String regId = ridMap['res'].toString(); print('------>#### registrationId: ' + regId);});
Flutter iOS端注意事项
因为插件更新,SDK的Pod依赖被替换,Flutter 自身写入Pod文件不会先执行删除原有依赖,导致可能会呈现原有本地库仍然存在,请查看Pod文件夹下文件,间接手动删除mob\_pushsdk 以及 MOBFoundation文件即可,如有疑难,请间接通过官网和咱们分割。
其余问题
demo地址
demo: GitHub地址
推送证书制作
推送证书申请流程见:推送证书文档