getui-flutter-plugin
getui-flutter-plugin copied to clipboard
个推官方提供的推送SDK Flutter 插件(支持 Android & iOS)
Getui Flutter Plugin
1、引用
Pub.dev: getui-flutter-plugin
增加依赖:
flutter pub add getuiflut
或者手动在工程 pubspec.yaml 中加入 dependencies:
dependencies:
getuiflut: ^0.2.13
下载依赖:
flutter pub get
flutter run
2、配置
2.1、Android:
参考官网文档中心进行配置:https://docs.getui.com/getui/mobile/android/overview/
flutter插件默认包含自定义组件,Flutter用户不用处理以下配置:
-
Android->集成指南-> 3.配置推送服务-> FlutterPushService ("继承自 com.igexin.sdk.PushService 的自定义 Service")
-
Android->集成指南-> 6.编写集成代码-> FlutterIntentService ("继承自 com.igexin.sdk.GTIntentService 的自定义 Service")
2.2、iOS:
在你项目的main.dart中添加下列代码:
Getuiflut().startSdk(
appId: "8eLAkGIYnGAwA9fVYZU93A",
appKey: "VFX8xYxvVF6w59tsvY6XN",
appSecret: "Kv3TeED8z19QwnMLdzdI35"
);
启用notification:xcode主工程配置 > Signing & Capabilities > +Push Noticifations
3、使用
import 'package:getuiflut/getuiflut.dart';
3.1、公共 API
- 公共 API
/**
* 绑定别名功能:后台可以根据别名进行推送
*
* @param alias 别名字符串
* @param aSn 绑定序列码, Android中无效,仅在iOS有效
*/
bindAlias(alias, sn);
unbindAlias(alias, sn);
/**
* 给用户打标签 , 后台可以根据标签进行推送
*
* @param tags 别名数组
*/
setTag(tags);
/**
* 停止SDK服务
*
*/
turnOffPush();
/**
* 开启SDK服务
*
*/
turnOnPush();
- 回调方法
Getuiflut().addEventHandler(
// 注册收到 cid 的回调
onReceiveClientId: (String message) async {
print("flutter onReceiveClientId: $message");
setState(() {
_getClientId = "ClientId: $message";
});
},
// 注册 DeviceToken 回调
onRegisterDeviceToken: (String message) async {
setState(() {
_getDeviceToken = "DeviceToken: $message";
});
},
// SDK收到透传消息回调
onReceivePayload: (Map<String, dynamic> message) async {
setState(() {
_onReceivePayload = "$message";
});
},
// 点击通知回调
onReceiveNotificationResponse: (Map<String, dynamic> message) async {
setState(() {
_onReceiveNotificationResponse = "$message";
});
},
// APPLink中携带的透传payload信息
onAppLinkPayload: (String message) async {
setState(() {
_onAppLinkPayLoad = "$message";
});
},
//通知服务开启\关闭回调
onPushModeResult: (Map<String, dynamic> message) async {
print("flutter onPushModeResult: $message");
},
// SetTag回调
onSetTagResult: (Map<String, dynamic> message) async {
print("flutter onSetTagResult: $message");
},
//设置别名回调
onAliasResult: (Map<String, dynamic> message) async {
print("flutter onAliasResult: $message");
},
//查询别名回调
onQueryTagResult: (Map<String, dynamic> message) async {
print("flutter onQueryTagResult: $message");
},
//APNs通知即将展示回调
onWillPresentNotification: (Map<String, dynamic> message) async {
print("flutter onWillPresentNotification: $message");
},
//APNs通知设置跳转回调
onOpenSettingsForNotification: (Map<String, dynamic> message) async {
print("flutter onOpenSettingsForNotification: $message");
},
);
3.2、Android API
/**
*初始化个推sdk
*/
Getuiflut.initGetuiSdk();
3.2、iOS API
- GTSDK<=2.4.6.0版本,需要使用插件版本<=0.2.5
- GTSDK>2.4.6.0版本,需要使用最新插件版本
/**
* 同步服务端角标
*
*/
setBadge(badge);
/**
* 复位服务端角标
*
*/
resetBadge();
/**
* 同步App本地角标
*
*/
setLocalBadge(badge);
/**
* 获取冷启动Apns参数
*
*/
getLaunchNotification();