mirror of
https://github.com/WuKongIM/WuKongIMFlutterSDK
synced 2025-05-29 15:12:20 +00:00
87 lines
2.2 KiB
Markdown
87 lines
2.2 KiB
Markdown
## 悟空IM Flutter SDK
|
||
|
||
 
|
||
|
||
[悟空IM](https://github.com/WuKongIM/WuKongIM "文档") flutter sdk 源码 [详细文档](http://githubim.com/sdk/flutter.html "文档")
|
||
|
||
## 快速入门
|
||
|
||
#### 安装
|
||
```
|
||
dependencies:
|
||
wukongimfluttersdk: ^1.0.8
|
||
```
|
||
#### 引入
|
||
```dart
|
||
import 'package:wukongimfluttersdk/wkim.dart';
|
||
```
|
||
|
||
**初始化sdk**
|
||
```dart
|
||
WKIM.shared.setup(Options.newDefault('uid', 'token'));
|
||
```
|
||
**初始化IP**
|
||
```dart
|
||
WKIM.shared.options.getAddr = (Function(String address) complete) async {
|
||
// 可通过接口获取后返回
|
||
String ip = await HttpUtils.getIP();
|
||
complete(ip);
|
||
};
|
||
```
|
||
**连接**
|
||
```dart
|
||
WKIM.shared.connectionManager.connect();
|
||
```
|
||
**断开**
|
||
```dart
|
||
// isLogout true：退出并不再重连 false：退出保持重连
|
||
WKIM.shared.connectionManager.disconnect(isLogout)
|
||
```
|
||
|
||
**发消息**
|
||
```dart
|
||
WKIM.shared.messageManager.sendMessage(WKTextContent('我是文本消息'), WKChannel(channelID, channelType));
|
||
```
|
||
|
||
## 监听
|
||
**连接监听**
|
||
```dart
|
||
WKIM.shared.connectionManager.addOnConnectionStatus('home',
|
||
(status, reason) {
|
||
if (status == WKConnectStatus.connecting) {
|
||
// 连接中
|
||
} else if (status == WKConnectStatus.success) {
|
||
// 成功
|
||
} else if (status == WKConnectStatus.noNetwork) {
|
||
// 网络异常
|
||
} else if (status == WKConnectStatus.syncMsg) {
|
||
//同步消息中
|
||
}
|
||
});
|
||
```
|
||
**消息入库**
|
||
```dart
|
||
WKIM.shared.messageManager.addOnMsgInsertedListener((wkMsg) {
|
||
// todo 展示在UI上
|
||
});
|
||
```
|
||
**收到新消息**
|
||
```dart
|
||
WKIM.shared.messageManager.addOnNewMsgListener('chat', (msgs) {
|
||
// todo 展示在UI上
|
||
});
|
||
```
|
||
**刷新某条消息**
|
||
```dart
|
||
WKIM.shared.messageManager.addOnRefreshMsgListener('chat', (wkMsg) {
|
||
// todo 刷新消息
|
||
});
|
||
```
|
||
|
||
**命令消息(cmd)监听**
|
||
```dart
|
||
WKIM.shared.cmdManager.addOnCmdListener('chat', (cmdMsg) {
|
||
// todo 按需处理cmd消息
|
||
});
|
||
```
|
||
- 包含`key`的事件监听均有移除监听的方法，为了避免重复收到事件回掉，在退出或销毁页面时通过传入的`key`移除事件 |