Flutter腾讯云聊天推送插件tencent_cloud_chat_push的使用

Flutter腾讯云聊天推送插件tencent_cloud_chat_push的使用

tencent_cloud_chat_push 插件是一个用于在 Flutter 应用程序中集成推送通知的插件。该插件支持 iOS 和 Android 平台，并允许无缝集成各种原生推送通知提供商，如华为、小米、OPPO、vivo、荣耀、魅族和谷歌 Firebase 云消息传递（FCM）。

特性

• 为 iOS 和 Android 轻松集成原生推送通知提供商
• 自动处理推送通知事件，如接收通知和点击通知
• 通过用户定义的回调函数实现可定制的推送通知处理

开始使用

步骤 1：将插件添加到项目中

要将 tencent_cloud_chat_push 插件添加到您的 Flutter 项目中，请将其作为依赖项添加到 pubspec.yaml 文件中，或者运行以下命令：

flutter pub add tencent_cloud_chat_push

步骤 2：配置推送通知参数

iOS

将您的 iOS APNs 推送证书上传到腾讯云聊天控制台并获取证书 ID。尽早调用 TencentCloudChatPush().setApnsCertificateID 方法并将证书 ID 传递给该方法：

TencentCloudChatPush().setApnsCertificateID(apnsCertificateID: CertificateID);

Android

完成推送通知提供商配置后，在控制台上下载 timpush-configs.json 文件，并将其添加到项目的 android/app/src/main/assets 目录下。如果该目录不存在，请手动创建它。

步骤 3：配置客户端代码

在此步骤中，您需要编写一些原生代码，例如 Swift、Java 和 XML。请按照提供的说明复制代码片段到指定文件。

iOS

编辑 ios/Runner/AppDelegate.swift 文件并粘贴提供的代码片段，如下所示的示例所示：

import UIKit
import Flutter

// 添加这两行导入语句
import TIMPush
import tencent_cloud_chat_push

// 在下面这一行中添加 `, TIMPushDelegate`
@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate, TIMPushDelegate {
    
    override func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        GeneratedPluginRegistrant.register(with: self)
        return super.application(application, didFinishLaunchingWithOptions: launchOptions)
    }
    
    // 添加此函数
    func offlinePushCertificateID() -> Int32 {
        return TencentCloudChatPushFlutterModal.shared.offlinePushCertificateID();
    }
    
    // 添加此函数
    func applicationGroupID() -> String {
        return TencentCloudChatPushFlutterModal.shared.applicationGroupID()
    }
    
    // 添加此函数
    func onRemoteNotificationReceived(_ notice: String?) -> Bool {
        TencentCloudChatPushPlugin.shared.tryNotifyDartOnNotificationClickEvent(notice)
        return true
    }
}

Android

在项目的 android 目录中创建一个新的 Application 类文件，例如 MyApplication.java。如果您已经为其他目的创建了一个自定义的 Application 类，则可以重用它而不必创建新的一个。

import com.tencent.chat.flutter.push.tencent_cloud_chat_push.application.TencentCloudChatPushApplication;
public class MyApplication extends TencentCloudChatPushApplication {
    @Override
    public void onCreate() {
        super.onCreate();
    }
}

在 AndroidManifest.xml 文件中声明它，如下所示：

<application
    android:name="${Package Name}.MyApplication"
... 更多配置

步骤 4：配置推送通知提供商

iOS

此步骤中无需对 iOS 进行额外配置。

Android

打开 android/app/build.gradle 文件并添加您想要支持的推送通知提供商的依赖项。您可以包含以下列表中的所有或部分提供商：

dependencies {
     // 华为
     implementation 'com.tencent.timpush:huawei:${The version of this package}'
     
     // 小米
     implementation 'com.tencent.timpush:xiaomi:${The version of this package}'
     
     // OPPO
     implementation 'com.tencent.timpush:oppo:${The version of this package}'
     
     // vivo
     implementation 'com.tencent.timpush:vivo:${The version of this package}'
     
     // 荣耀
     implementation 'com.tencent.timpush:honor:${The version of this package}'
     
     // 魅族
     implementation 'com.tencent.timpush:meizu:${The version of this package}'
     
     // 谷歌 Firebase 云消息传递（Google FCM）
     implementation 'com.tencent.timpush:fcm:${The version of this package}'
}

步骤 5：处理通知点击事件并解析参数

定义一个函数来处理推送通知点击事件。该函数应具有以下签名：

void onNotificationClicked({required String ext, String? userID, String? groupID})

ext 参数包含消息的完整扩展信息，由发送方指定。如果没有指定，默认值将被使用。您可以解析此参数以导航到相应的页面。

userID 和 groupID 参数由插件从扩展 JSON 字符串中自动解析，分别包含聊天伙伴的 userID 和群聊的 groupID。如果使用默认扩展字段（由 SDK 或 UIKit 指定），则可以使用这些默认值。如果解析失败，它们将为 null。

步骤 6：注册推送插件

通过调用 TencentCloudChatPush().registerPush 方法注册推送插件。登录到腾讯云聊天模块后，但在使用任何其他插件（如 CallKit）之前调用此方法。传入上一步中定义的点击回调函数。

可选地，如果需要，还可以传递 apnsCertificateID（适用于 iOS）和 androidPushOEMConfig（适用于 Android）：

TencentCloudChatPush().registerPush(onNotificationClicked: _onNotificationClicked);

完整示例代码

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

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

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

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _tencentCloudChatPushPlugin = TencentCloudChatPush();

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

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    // We also handle the message potentially returning null.
    try {
      platformVersion =
          await _tencentCloudChatPushPlugin.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('Running on: $_platformVersion\n'),
        ),
      ),
    );
  }
}