Flutter腾讯云聊天功能插件tencent_cloud_chat_sdk的使用

Flutter腾讯云聊天功能插件tencent_cloud_chat_sdk的使用

整体介绍

Tencent Cloud Chat SDK 是一个用于构建跨平台即时通讯应用的SDK，支持Android、iOS和Web。它提供了丰富的API来实现用户认证、消息发送与接收、会话管理等功能。

安装依赖

首先需要安装Flutter SDK，并确保版本在2.2.0或更高版本。然后通过flutter pub get命令安装tencent_im_sdk_plugin包。

# 克隆TIMSDK仓库
git clone https://github.com/TencentCloud/TIMSDK.git

# 进入TIMSDK/Flutter/Demo/im-flutter-uikit目录
cd TIMSDK/Flutter/Demo/im-flutter-uikit

# 安装依赖
flutter pub get

创建测试账户

在TIM控制台创建应用并完成身份验证后，获取SDKAppID和Key。

1. 在TIM控制台选择你的应用，点击左侧导航栏中的“辅助工具” > “UserSig生成与验证”，创建两个UserID及其对应的UserSig，并将UserID、Key和UserSig复制备用。
2. 为开发和测试目的，账户仅用于开发和测试。正式发布前，正确的UserSig分发方法是将UserSig计算代码集成到服务器中，并提供面向应用的API。当需要UserSig时，应用程序可以向业务服务器请求动态UserSig。更多详情，请参阅生成UserSig。

使用示例

以下是一个完整的Flutter项目示例，展示了如何使用tencent_cloud_chat_sdk进行聊天功能开发。

import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
import 'package:shared_preferences/shared_preferences.dart';
import 'package:tencent_cloud_chat_sdk/manager/v2_tim_manager.dart';
import 'package:tencent_cloud_chat_sdk/models/v2_tim_callback.dart';
import 'package:tencent_cloud_chat_sdk/models/v2_tim_group_info.dart';

void main() {
  runApp(
    MultiProvider(providers: [
      ChangeNotifierProvider(create: (_) => ListenerConfig()),
    ], child: 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';
  bool isLogin = false;
  int count = 0;

  void initConfig() async {
    final SharedPreferences prefs = await SharedPreferences.getInstance();
    String userid = prefs.getString('userid') ?? '';

    if (userid.isNotEmpty) {
      int code = await V2TimManager.initSDK(
        sdkAppID: 0, // Replace `0` with the `SDKAppID` of your IM application during integration
        loglevel: LogLevelEnum.V2TIM_LOG_DEBUG, // Log
        listener: V2TimListener(),
      );

      if (code == 0) {
        setState(() {
          isLogin = true;
        });
      } else {
        prefs.clear();
        Navigator.push(
          context,
          MaterialPageRoute(builder: (context) => Login()),
        );
        setState(() {
          isLogin = false;
        });
      }
    } else {
      prefs.clear();
      Navigator.push(
        context,
        MaterialPageRoute(builder: (context) => Login()),
      );
      setState(() {
        isLogin = false;
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      color: Colors.white,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
          leading: IconButton(
            onPressed: () {
              Navigator.push(
                context,
                MaterialPageRoute(builder: (context) => Login()),
              );
            },
            icon: const Icon(Icons.settings),
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            Navigator.push(
              context,
              MaterialPageRoute(builder: (context) => CallbackPage()),
            );
          },
          tooltip: '获取callback',
          child: Text('${count}'),
        ),
        body: Wrap(
          spacing: 10, // 子小部件之间的水平间距
          runSpacing: 10,
          children: [
            ElevatedButton(
              onPressed: Provider.of<ListenerConfig>(context, listen: true).isLogin
                  ? () {
                      Navigator.push(
                        context,
                        MaterialPageRoute(builder: (context) => V2TIMManagerPage()),
                      );
                    }
                  : null,
              child: const Text('V2TIMManager 基础模块'),
            ),
            ElevatedButton(
              onPressed: Provider.of<ListenerConfig>(context, listen: true).isLogin
                  ? () {
                      Navigator.push(
                        context,
                        MaterialPageRoute(builder: (context) => V2TIMMessageManagerPage()),
                      );
                    }
                  : null,
              child: const Text('V2TIMMessageManager 消息模块'),
            ),
            ElevatedButton(
              onPressed: Provider.of<ListenerConfig>(context, listen: true).isLogin
                  ? () {
                      Navigator.push(
                        context,
                        MaterialPageRoute(builder: context) => V2TIMConversationManagerPage()),
                      );
                    }
                  : null,
              child: const Text('V2TIMConversationManager 会话模块'),
            ),
            ElevatedButton(
              onPressed: Provider.of<ListenerConfig>(context, listen: true).isLogin
                  ? () {
                      Navigator.push(
                        context,
                        MaterialPageRoute(builder: context) => V2TIMGroupManagerPage()),
                      );
                    }
                  : null,
              child: const Text('V2TIMGroupManager 群组模块'),
            ),
            ElevatedButton(
              onPressed: Provider.of<ListenerConfig>(context, listen: true).isLogin
                  ? () {
                      Navigator.push(
                        context,
                        MaterialPageRoute(builder: context) => V2TIMFriendshipManagerPage()),
                      );
                    }
                  : null,
              child: const Text('V2TIMFriendshipManager 好友模块'),
            ),
            ElevatedButton(
              onPressed: null,
              child: const Text('V2TIMOfflinePushManager 推送模块'),
            ),
            ElevatedButton(
              onPressed: null,
              child: const Text('V2TIMSignalingManager 信令模块'),
            ),
            ElevatedButton(
              onPressed: Provider.of<ListenerConfig>(context, listen: true).isLogin
                  ? () {
                      Navigator.push(
                        context,
                        MaterialPageRoute(builder: context) => const V2TIMCommunityManagerPage()),
                      );
                    }
                  : null,
              child: const Text('V2TIMCommunityManager 社群模块'),
            ),
          ],
        ),
      ),
    );
  }
}