OHLPush For Flutter #

这是一个基于 OHLPush 功能的扩展的 Flutter 插件。使用此插件能够帮助您在使用 Flutter 开发应用时，快速地实现推送功能。

插件主页：https://pub.dartlang.org/packages/ohlpush_plugin

Demo例子：https://github.com/MobClub/MobPush-for-Flutter/ohlpush_plugin

开始集成

1.参考 Flutter 官方插件集成文档

在pubspec.yaml文件中加入下面依赖

dependencies:
  ohlpush_plugin:

然后执行：flutter packages get 导入package 在你的dart工程文件中，导入下面头文件，开始使用

import 'package:ohlpush_plugin/ohlpush_plugin.dart';

iOS：

平台配置参考 iOS 集成文档

实现 1. ：获取 appKey 和 appSecret 实现 5.1：配置 appkey 和 appSecret

Android：

导入 OHLPush 相关依赖

在项目根目录的build.gradle中添加以下代码：

dependencies {
    classpath 'com.android.tools.build:gradle:3.2.1'
    classpath 'cn.fly.sdk:FlySDK:+'
    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"
// 导入FlySDK
apply plugin: 'cn.fly.sdk'

导入FlySDK {
    appKey "您的appKey"
    appSecret "您的appSecret"

	//配置OHLPush
    OHLPush {
    	//配置厂商推送（可选配置，不需要厂商推送可不配置，需要哪些厂商推送只需配置哪些厂商配置即可）
        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"
            }
            //配置HONOR厂商推送
            HONOR{
                 appId "您的VIVO平台appId"
            }
            //配置亚马逊厂商推送
            AMAZON{}
        }
    }
}

3. 在MainActivity的onCreate中添加以下代码：

 @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    GeneratedPluginRegistrant.registerWith(this);
  }

在项目的/android/app的AndroidManifest.xml文件中添加：

<application
        android:name=".CustomApplication"
        ... 
        >
        ...
</application>

接口方法说明

（1）设置隐私协议授权状态 ： updatePrivacyPermissionStatus

OHLpushPlugin.updatePrivacyPermissionStatus(true);

（2）设置远程推送环境，向用户授权（仅 iOS）：

setCustomNotification

if (Platform.isIOS) {
      OHLpushPlugin.setCustomNotification();
}

（3）设置远程推送环境 (仅 iOS)：

setAPNsForProduction

if (Platform.isIOS) {
     // 开发环境 false, 线上环境 true
      OHLpushPlugin.setAPNsForProduction(false)
}

（4）添加推送回调监听（接收自定义透传消息回调、接收通知消息回调、接收点击通知消息回调）

addPushReceiver

OHLpushPlugin.addPushReceiver(_onEvent, _onError);

void _onEvent(Object event) {

}

void _onError(Object event) {
    
}

（5）停止推送

stopPush

OHLpushPlugin.stopPush();

（6）重新打开推送服务

restartPush

OHLpushPlugin.restartPush();

（7）是否已停止接收推送

isPushStopped

OHLpushPlugin.isPushStopped();

（8）设置别名

setAlias

OHLpushPlugin.setAlias("别名").then((Map<String, dynamic> aliasMap){
	String res = aliasMap['res'];
	String error = aliasMap['error'];
	String errorCode = aliasMap['errorCode'];
	print(">>>>>>>>>>>>>>>>>>>>>>>>>>> setAlias -> res: $res error: $error");
});

（9）获取别名

getAlias

OHLpushPlugin.getAlias().then((Map<String, dynamic> aliasMap){
	String res = aliasMap['res'];
	String error = aliasMap['error'];
	print(">>>>>>>>>>>>>>>>>>>>>>>>>>> getAlias -> res: $res error: $error");
});

(10）删除别名

deleteAlias

OHLpushPlugin.deleteAlias("别名").then((Map<String, dynamic> 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");
OHLpushPlugin.addTags(tags).then((Map<String, dynamic> tagsMap){
	String res = tagsMap['res'];
	String error = tagsMap['error'];
	print(">>>>>>>>>>>>>>>>>>>>>>>>>>> addTags -> res: $res error: $error");
});

（12）获取标签

getTags

OHLpushPlugin.getTags().then((Map<String, dynamic> tagsMap){
	List<String> resList =  List<String>.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");
OHLpushPlugin.deleteTags(tags).then((Map<String, dynamic> tagsMap){
	String res = tagsMap['res'];
	String error = tagsMap['error'];
	print(">>>>>>>>>>>>>>>>>>>>>>>>>>> deleteTags -> res: $res error: $error");
});

（14）清空标签

cleanTags

OHLpushPlugin.cleanTags().then((Map<String, dynamic> tagsMap){
	String res = tagsMap['res'];
	String error = tagsMap['error'];
	print(">>>>>>>>>>>>>>>>>>>>>>>>>>> cleanTags -> res: $res error: $error");
});

（15）测试模拟推送，用于测试

send

/**
    * 测试模拟推送，用于测试
    * type：模拟消息类型，1、通知测试；2、内推测试；3、定时
    * content：模拟发送内容，500字节以内，UTF-8
    * space：仅对定时消息有效，单位分钟，默认1分钟
    * extras: 附加数据，json字符串
    */
OHLpushPlugin.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");
});

（16）设置通知栏icon，不设置默认取应用icon(仅andorid)

setNotifyIcon

OHLpushPlugin.setNotifyIcon(String resId);

（17）设置应用在前台时是否隐藏通知不进行显示，不设置默认不隐藏通知(仅andorid)

setAppForegroundHiddenNotification

OHLpushPlugin.setAppForegroundHiddenNotification(bool hidden);

（18）设置通知静音时段（推送选项）(仅andorid)

setSilenceTime

/**
   * 设置通知静音时段（推送选项）(仅andorid)
   * @param startHour   开始时间[0~23] (小时)
   * @param startMinute 开始时间[0~59]（分钟）
   * @param endHour     结束时间[0~23]（小时）
   * @param endMinute   结束时间[0~59]（分钟）
   */
OHLpushPlugin.setSilenceTime(int startHour, int startMinute, int endHour, int endMinute)

（18）设置角标

setBadge

OHLpushPlugin.setBadge(int badge);

（20）清空角标，不清除通知栏消息记录

clearBadge

OHLpushPlugin.clearBadge();

（21）获取注册Id

getRegistrationId

OHLpushPlugin.getRegistrationId().then((Map<String, dynamic> ridMap) {
	print(ridMap);
	String regId = ridMap['res'].toString();
	print('------>#### registrationId: ' + regId);
});

技术支持 #

如有问题请联系技术支持:

服务电话:   400-685-2216
QQ:        4006852216
节假日值班电话:
    iOS：185-1664-1951
Android: 185-1664-1950
电子邮箱:   [email protected]
市场合作:   021-54623100