Flutter通知推送插件getuiflut_noifa的使用

1、引用

Pub.dev:
getui-flutter-plugin

增加依赖：

flutter pub add getuiflut

或者手动在工程 pubspec.yaml 中加入 dependencies：

dependencies:
  getuiflut: ^0.2.16

下载依赖：

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 Notifications

3、使用

3.1、公共 API

导入插件：

import 'package:getuiflut/getuiflut.dart';

公共 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");
  },
  // 授权回调
  onGrantAuthorization: (String granted) async {
    print("flutter onGrantAuthorization: $granted");
  },
);

3.2、Android API

/**
* 初始化个推sdk
*/
Getuiflut.initGetuiSdk();

/**
* 设置角标
*/
setBadge(badge);

3.3、iOS API

GTSDK <= 2.4.6.0 版本，需要使用插件版本 <= 0.2.5

GTSDK > 2.4.6.0 版本，需要使用最新插件版本

/**
* 启动sdk+通知授权
*
*/
startSdk(appId, appKey, appSecret);

/**
* 启动sdk
*
*/
startSdkSimple(appId, appKey, appSecret);

/**
* 通知授权, 需要先启动sdk
*
*/
registerRemoteNotification(appId, appKey, appSecret);

/**
* 获取冷启动Apns参数
*
*/
getLaunchNotification();

/**
* 同步服务端角标
*
*/
setBadge(badge);

/**
* 复位服务端角标
*
*/
resetBadge();

/**
* 同步App本地角标
*
*/
setLocalBadge(badge);

示例代码

以下是完整的示例代码，展示如何使用 getuiflut_noifa 插件：

import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io';

import 'package:flutter/services.dart';
import 'package:getuiflut/getuiflut.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  String _payloadInfo = 'Null';
  String _userMsg = "";
  String _notificationState = "";
  String _getClientId = "";
  String _getDeviceToken = "";
  String _onReceivePayload = "";
  String _onReceiveNotificationResponse = "";
  String _onAppLinkPayLoad = "";

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    String platformVersion;
    String payloadInfo = "default";
    String notificationState = "default";

    try {
      platformVersion = await Getuiflut.platformVersion;
      print('platformVersion' + platformVersion);
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
      _payloadInfo = payloadInfo;
      _notificationState = notificationState;
    });

    Getuiflut().addEventHandler(
      onReceiveClientId: (String message) async {
        print("flutter onReceiveClientId: $message");
        setState(() {
          _getClientId = "ClientId: $message";
        });
      },
      onRegisterDeviceToken: (String message) async {
        print("flutter onRegisterDeviceToken: $message");
        setState(() {
          _getDeviceToken = "$message";
        });
      },
      onReceivePayload: (Map<String, dynamic> message) async {
        print("flutter onReceivePayload: $message");
        setState(() {
          _onReceivePayload = "$message";
        });
      },
      onReceiveNotificationResponse: (Map<String, dynamic> message) async {
        print("flutter onReceiveNotificationResponse: $message");
        setState(() {
          _onReceiveNotificationResponse = "$message";
        });
      },
      onAppLinkPayload: (String message) async {
        print("flutter onAppLinkPayload: $message");
        setState(() {
          _onAppLinkPayLoad = "$message";
        });
      },
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: ListView(
          children: <Widget>[
            Container(
              alignment: Alignment.center,
              child: Column(
                children: <Widget>[
                  Text('platformVersion: $_platformVersion\n'),
                  Text('clientId: $_getClientId\n'),
                  ElevatedButton(
                    onPressed: () {
                      Getuiflut().startSdk(
                        appId: "your-app-id",
                        appKey: "your-app-key",
                        appSecret: "your-app-secret",
                      );
                    },
                    child: const Text('Start SDK'),
                  ),
                  ElevatedButton(
                    onPressed: () {
                      Getuiflut().turnOffPush();
                    },
                    child: const Text('Stop Push'),
                  ),
                  ElevatedButton(
                    onPressed: () {
                      Getuiflut().turnOnPush();
                    },
                    child: const Text('Resume Push'),
                  ),
                  ElevatedButton(
                    onPressed: () {
                      Getuiflut().bindAlias('test', 'test');
                    },
                    child: const Text('Bind Alias'),
                  ),
                  ElevatedButton(
                    onPressed: () {
                      Getuiflut().unbindAlias('test', 'test');
                    },
                    child: const Text('Unbind Alias'),
                  ),
                  ElevatedButton(
                    onPressed: () {
                      Getuiflut().setTag(['tag1', 'tag2']);
                    },
                    child: const Text('Set Tag'),
                  ),
                ],
              ),
            ),
          ],
        ),
      ),
    );
  }
}