Flutter即时通讯插件deadsimplechat_sdk_flutter的使用

添加高度可扩展的聊天功能到你的Flutter应用只需几分钟时间，使用DeadSimpleChat Flutter Chat SDK。

该组件使用DeadSimpleChatController来处理聊天操作，如发送消息、回复、禁止用户等。DeadSimpleChat组件还提供了广泛的事件监听器，您可以用来监听聊天室中的各种事件。

特性

• 实时通信。
• 多通道支持。
• 私人消息。
• 消息历史记录。
• 消息反应。
• 用户封禁/解封。
• 自定义UI。
• 翻译支持。

安装

在您的pubspec.yaml文件中添加以下依赖项以安装DeadSimpleChat：

dependencies:
  deadsimplechat_sdk_flutter: latest_version

使用

要在应用程序中使用DeadSimple Chat组件，首先导入它：

import 'package:deadsimplechat_sdk_flutter/deadsimplechat_sdk_flutter.dart';

然后，使用所需的参数实例化它：

DeadSimpleChat(
  roomId: 'roomId',
  publicKey: 'publicKey',
  controller: DeadSimpleChatController(),
  onMessageReceived: (message) => print('Message received: $message'),
);

使用DeadSimpleChatController

DeadSimpleChatController提供了多种方法，可以调用这些方法执行不同的聊天室操作。

以下是一个简单的DeadSimpleChatController使用示例：

final chatController = DeadSimpleChatController();

// 调用此方法发送消息
chatController.sendMessage('Hello, World!');

// 调用此方法获取在线用户列表
var onlineUsers = await chatController.getOnlineUsers();

// 调用此方法获取消息
var messages = await chatController.getMessages();

// 调用此方法注销
chatController.logout();

以下是DeadSimpleChatController类中可用的方法：

JoinOptions

JoinOptions 类用于提供加入参数，当使用 DeadSimpleChatController.joinRoom() 方法时。例如：

final joinOptions = JoinOptions(
  // 推荐方式
  uniqueUserIdentifier: 'cc8459b0-70b9-4bac-b472-b2d36dc3452e',
  // 推荐方式
  accessToken: 'accessToken', 
  // 不推荐
  username: 'john_doe',
  email: 'john.doe@example.com',
  password: 'password',
  roomPassword: 'roomPassword',
);

chatController.joinRoom(joinOptions);

事件监听器

DeadSimpleChat 组件提供了多种事件监听器，可以用来监听聊天室中的各种事件。例如，监听新消息接收时，可以这样做：

DeadSimpleChat(
  // 其他参数
  onMessage: (message) => print('Message received: $message'),
);

事件监听器包括：

• onMessage(Object message)：当收到新的聊天消息时触发。
• onChannelSelected(String channelId)：当选择聊天中的频道时触发。
• onRoomJoined(String roomId)：当成功加入聊天室时触发。
• onMessageHistory(String messageId)：当成功获取消息历史时触发。
• onMessageApproved(String messageId)：当聊天消息被批准时触发。
• onMessageDeleted(String messageId)：当聊天消息被删除时触发。
• onUpdateUsers(String userId)：当在线用户列表更新时触发。
• onInvalidRoomPassword(String roomId)：当提供无效房间密码时触发。
• onRoomLimitReached(String roomId)：当房间达到限制时触发。
• onNotAuthorized(String errorMessage)：当用户未授权执行某个操作时触发。
• onMessageLiked(String messageId)：当聊天消息被喜欢时触发。
• onConversationCreated(String userId)：当创建对话时触发。
• onConversationMessage(String conversationId)：当收到对话消息时触发。
• onChannelCreated(String channelId)：当创建频道时触发。
• onChannelMessage(String channelId)：当收到频道消息时触发。
• onChannelMessageDeleted(String messageId)：当频道消息被删除时触发。
• onChannelMessageApproved(String messageId)：当频道消息被批准时触发。
• onChannelMessageLiked(String messageId)：当频道消息被喜欢时触发。
• onConnectError(String errorMessage)：当连接聊天服务器时发生错误时触发。
• onConnectSuccess(String message)：当成功连接到聊天服务器时触发。
• onJoinRoomError(String errorMessage)：当加入聊天室时发生错误时触发。
• onLoadCustomizationSuccess(String message)：当自定义加载成功时触发。
• onLoadCustomizationError(String errorMessage)：当加载自定义时发生错误时触发。
• onLoadTranslationSuccess(String message)：当翻译加载成功时触发。
• onLoadTranslationError(String errorMessage)：当加载翻译时发生错误时触发。
• onSendMessageError(String errorMessage)：当发送聊天消息时发生错误时触发。

自定义和翻译

DeadSimpleChat 组件提供了自定义和翻译选项。使用 DeadSimpleChatController.loadCustomization() 和 DeadSimpleChatController.loadTranslation() 方法分别加载自定义配置和翻译。

chatController.loadCustomization(myCustomization);
chatController.loadTranslation(myTranslation);

示例代码

以下是一个完整的示例代码：

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

void main() {
  runApp(const MaterialApp(home: MyApp()));
}

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

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

class _MyAppState extends State<MyApp> {
  final deadsimplechatController = new DeadSimpleChatController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
          title: const Text("Flutter DeadSimpleChat"),
        ),
        body: Column(
          children: [
            Expanded(
                flex: 1,
                child: DeadSimpleChat(
                  debug: false,
                  roomId: "eBbYrkM-o", // 替换为房间ID
                  publicKey:
                      "pub_37325a71334a4c4a325a326b6a2d584d66557847547a724a6a5656754434516f697542582d384a315533587838583159", // 替换为从仪表板获取的公钥
                  controller: deadsimplechatController,
                )),
            Expanded(
                flex: 1,
                child: Wrap(
                  spacing: 10,
                  children: [
                    ElevatedButton(
                        onPressed: () {
                          deadsimplechatController.logout();
                          print("Logout");
                        },
                        child: Text("Logout")),
                    ElevatedButton(
                        onPressed: () {
                          deadsimplechatController.joinRoom(JoinOptions(
                              uniqueUserIdentifier:
                                  "cc8459b0-70b9-4bac-b472-b2d36dc3452e"));
                        },
                        child: Text("Join Room")),
                    ElevatedButton(
                        onPressed: () {
                          deadsimplechatController.connect();
                        },
                        child: Text("Connect")),
                    ElevatedButton(
                      child: Text("Get Messages"),
                      onPressed: () async {
                        var messages =
                            await deadsimplechatController.getMessages();
                        print("**** MESSAGE HISTORY FETCHED ***");
                        print(messages);
                      },
                    ),
                    ElevatedButton(
                        onPressed: () async {
                          var channels = await deadsimplechatController
                              .getActiveChannels();
                          print("**** CHANNELS ****");
                          print(channels);
                        },
                        child: Text("Get Channels"))
                  ],
                ))
          ],
        ));
  }
}