# bop_mobpush_plugin **Repository Path**: bop_flutter/bop_mobpush_plugin ## Basic Information - **Project Name**: bop_mobpush_plugin - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-12-01 - **Last Updated**: 2021-12-11 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # MobPush For Flutter 这是一个基于 MobPush 功能的扩展的 Flutter 插件。使用此插件能够帮助您在使用 Flutter 开发应用时，快速地实现推送功能。插件主页：https://pub.dartlang.org/packages/mobpush_plugin Demo例子：https://github.com/MobClub/MobPush-for-Flutter/mobpush_plugin >注意：老版本插件mobpush([https://pub.dartlang.org/packages/mobpush](https://pub.dartlang.org/packages/mobpush))不再更新，请使用当前插件mobpush_plugin([https://pub.dartlang.org/packages/mobpush_plugin](https://pub.dartlang.org/packages/mobpush_plugin)) > 开始集成 1.参考 Flutter 官方插件集成文档在pubspec.yaml文件中加入下面依赖 ``` dependencies: mobpush_plugin: ``` 然后执行：flutter packages get 导入package 在你的dart工程文件中，导入下面头文件，开始使用 ``` import 'package:mobpush_plugin/mobpush_plugin.dart'; ``` **iOS：** 平台配置参考[ iOS 集成文档](http://wiki.mob.com/mobpush-for-ios/) 实现 1. ：获取 appKey 和 appSecret 实现 5.1：配置 appkey 和 appSecret **Android：** 导入 MobPush 相关依赖在项目根目录的build.gradle中添加以下代码： ``` dependencies { classpath 'com.android.tools.build:gradle:3.2.1' classpath 'com.mob.sdk:MobSDK:+' classpath 'com.google.gms:google-services:4.0.1' //不需要FCM厂商推送无需配置 } ``` 在 /android/app/build.gradle 中添加以下代码： ``` apply plugin: 'com.android.application' apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle" // 导入MobSDK apply plugin: 'com.mob.sdk' MobSDK { appKey "您的Mob平台appKey" appSecret "您的Mob平台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" } } } } ``` 3. 在MainActivity的onCreate中添加以下代码： ``` @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); GeneratedPluginRegistrant.registerWith(this); } ``` 在项目的/android/app的AndroidManifest.xml文件中添加： ``` ... ``` **接口方法说明** （1）设置隐私协议授权状态： updatePrivacyPermissionStatus ``` MobpushPlugin.updatePrivacyPermissionStatus(true); ``` （2）设置远程推送环境，向用户授权（仅 iOS）： setCustomNotification ``` if (Platform.isIOS) { MobpushPlugin.setCustomNotification(); } ``` （3）设置远程推送环境 (仅 iOS)： setAPNsForProduction ``` if (Platform.isIOS) { // 开发环境 false, 线上环境 true MobpushPlugin.setAPNsForProduction(false) } ``` （4）添加推送回调监听（接收自定义透传消息回调、接收通知消息回调、接收点击通知消息回调） addPushReceiver ``` MobpushPlugin.addPushReceiver(_onEvent, _onError); void _onEvent(Object event) { } void _onError(Object event) { } ``` （5）停止推送 stopPush ``` MobpushPlugin.stopPush(); ``` （6）重新打开推送服务 restartPush ``` MobpushPlugin.restartPush(); ``` （7）是否已停止接收推送 isPushStopped ``` MobpushPlugin.isPushStopped(); ``` （8）设置别名 setAlias ``` MobpushPlugin.setAlias("别名").then((Map aliasMap){ String res = aliasMap['res']; String error = aliasMap['error']; String errorCode = aliasMap['errorCode']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> setAlias -> res: $res error: $error"); }); ``` （9）获取别名 getAlias ``` MobpushPlugin.getAlias().then((Map aliasMap){ String res = aliasMap['res']; String error = aliasMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> getAlias -> res: $res error: $error"); }); ``` (10）删除别名 deleteAlias ``` MobpushPlugin.deleteAlias("别名").then((Map aliasMap){ String res = aliasMap['res']; String error = aliasMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> deleteAlias -> res: $res error: $error"); }); ``` （11）添加标签 addTags ``` List tags = new List(); tags.add("tag1"); tags.add("tag2"); MobpushPlugin.addTags(tags).then((Map tagsMap){ String res = tagsMap['res']; String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> addTags -> res: $res error: $error"); }); ``` （12）获取标签 getTags ``` MobpushPlugin.getTags().then((Map tagsMap){ List resList = List.from(tagsMap['res']); String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> getTags -> res: $resList error: $error"); });; ``` （13）删除标签 deleteTags ``` List tags = new List(); tags.add("tag1"); tags.add("tag2"); MobpushPlugin.deleteTags(tags).then((Map tagsMap){ String res = tagsMap['res']; String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> deleteTags -> res: $res error: $error"); }); ``` （14）清空标签 cleanTags ``` MobpushPlugin.cleanTags().then((Map tagsMap){ String res = tagsMap['res']; String error = tagsMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> cleanTags -> res: $res error: $error"); }); ``` （15）发送本地通知 addLocalNotification ``` MobpushPlugin.addLocalNotification(); ``` （16）绑定手机号 bindPhoneNum ``` MobpushPlugin.bindPhoneNum("110"); ``` （17）测试模拟推送，用于测试 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 sendMap){ String res = sendMap['res']; String error = sendMap['error']; print(">>>>>>>>>>>>>>>>>>>>>>>>>>> send -> res: $res error: $error"); }); ``` （18）设置点击通知是否跳转默认页 (仅andorid) setClickNotificationToLaunchMainActivity ``` MobpushPlugin.setClickNotificationToLaunchMainActivity (bool enable); ``` （19）移除本地通知(仅andorid) removeLocalNotification ``` MobpushPlugin.removeLocalNotification(int notificationId); ``` （20）清空本地通知(仅andorid) clearLocalNotifications ``` MobpushPlugin.clearLocalNotifications(); ``` （21）设置通知栏icon，不设置默认取应用icon(仅andorid) setNotifyIcon ``` MobpushPlugin.setNotifyIcon(String resId); ``` （22）设置应用在前台时是否隐藏通知不进行显示，不设置默认不隐藏通知(仅andorid) setAppForegroundHiddenNotification ``` MobpushPlugin.setAppForegroundHiddenNotification(bool hidden); ``` （23）设置通知静音时段（推送选项）(仅andorid) setSilenceTime ``` /** * 设置通知静音时段（推送选项）(仅andorid) * @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) ``` （24）设置角标 (仅 iOS) setBadge ``` MobpushPlugin.setBadge(int badge); ``` （25）清空角标，不清除通知栏消息记录 (仅 iOS) clearBadge ``` MobpushPlugin.clearBadge(); ``` （26）获取注册Id getRegistrationId ``` MobpushPlugin.getRegistrationId().then((Map ridMap) { print(ridMap); String regId = ridMap['res'].toString(); print('------>#### registrationId: ' + regId); }); ```