Flutter集成悟空IM插件wukongimfluttersdk的使用

悟空IM flutter sdk 源码 详细文档

快速入门

安装

dependencies:
  wukongimfluttersdk: ^version // 版本号看上面

引入

import 'package:wukongimfluttersdk/wkim.dart';

初始化sdk

WKIM.shared.setup(Options.newDefault('uid', 'token'));

初始化IP

WKIM.shared.options.getAddr = (Function(String address) complete) async {
    // 可通过接口获取后返回
    String ip = await HttpUtils.getIP();
    complete(ip);
};

连接

WKIM.shared.connectionManager.connect();

断开

// isLogout true：退出并不再重连 false：退出保持重连
WKIM.shared.connectionManager.disconnect(isLogout)

发消息

WKIM.shared.messageManager.sendMessage(WKTextContent('我是文本消息'), WKChannel(channelID, channelType));

监听

连接监听

WKIM.shared.connectionManager.addOnConnectionStatus('home',
        (status, reason, connectInfo) {
      if (status == WKConnectStatus.connecting) {
        // 连接中
      } else if (status == WKConnectStatus.success) {
        var nodeId = connectInfo?.nodeId; // 节点id
        // 成功
      } else if (status == WKConnectStatus.noNetwork) {
        // 网络异常
      } else if (status == WKConnectStatus.syncMsg) {
        // 同步消息中
      } else if (status == WKConnectStatus.syncCompleted) {
        // 同步完成
      }
    });

消息入库

WKIM.shared.messageManager.addOnMsgInsertedListener((wkMsg) {
      // todo 展示在UI上
    });

收到新消息

WKIM.shared.messageManager.addOnNewMsgListener('chat', (msgs) {
      // todo 展示在UI上
    });

刷新某条消息

WKIM.shared.messageManager.addOnRefreshMsgListener('chat', (wkMsg) {
      // todo 刷新消息
    });

命令消息(cmd)监听

WKIM.shared.cmdManager.addOnCmdListener('chat', (cmdMsg) {
    // todo 按需处理cmd消息
});

• 包含key的事件监听均有移除监听的方法，为了避免重复收到事件回调，在退出或销毁页面时通过传入的key移除事件。

许可证

悟空IM 使用 Apache 2.0 许可证。有关详情，请参阅 LICENSE 文件。

示例代码

example

A new Flutter project.

Getting Started

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

• Lab: Write your first Flutter app
• Cookbook: Useful Flutter samples

For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

以下是一个完整的示例代码，展示了如何在Flutter项目中集成悟空IM插件wukongimfluttersdk。

import 'package:flutter/material.dart';
import 'package:wukongimfluttersdk/wkim.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化SDK
    WKIM.shared.setup(Options.newDefault('uid', 'token'));

    // 初始化IP
    WKIM.shared.options.getAddr = (Function(String address) complete) async {
      String ip = await HttpUtils.getIP();
      complete(ip);
    };

    // 添加连接状态监听
    WKIM.shared.connectionManager.addOnConnectionStatus('home',
            (status, reason, connectInfo) {
          if (status == WKConnectStatus.connecting) {
            print("正在连接...");
          } else if (status == WKConnectStatus.success) {
            var nodeId = connectInfo?.nodeId;
            print("连接成功，节点ID: $nodeId");
          } else if (status == WKConnectStatus.noNetwork) {
            print("网络异常");
          } else if (status == WKConnectStatus.syncMsg) {
            print("同步消息中");
          } else if (status == WKConnectStatus.syncCompleted) {
            print("同步完成");
          }
        });

    // 连接
    WKIM.shared.connectionManager.connect();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('悟空IM Flutter SDK Demo'),
      ),
      body: Center(
        child: Text('点击按钮发送消息'),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          // 发送消息
          WKIM.shared.messageManager.sendMessage(
              WKTextContent('Hello, World!'), WKChannel('channelID', 'channelType'));
        },
        tooltip: '发送消息',
        child: Icon(Icons.send),
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    // 移除连接状态监听
    WKIM.shared.connectionManager.removeOnConnectionStatus('home');

    // 断开连接
    WKIM.shared.connectionManager.disconnect(false);

    super.dispose();
  }
}