From 871f335ea20b969082dd0a814890861dbafd68f7 Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:20:43 +0800 Subject: [PATCH 1/7] Update README.md --- README.md | 187 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 145 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 315197c..cd099a4 100644 --- a/README.md +++ b/README.md @@ -21,51 +21,155 @@ A Flutter im plugin. import 'package:flutter_openim_sdk/flutter_openim_sdk.dart'; -### Usage - -#### 初始化 - - var msgListener = AdvancedMsgListener(); - - /// 初始化SDK - OpenIM.iMManager - ..initSDK( - platform: 0, - ipApi: 'Api接口地址', - ipWs: 'WebSocket地址', - dbPath: '数据库目录', - listener: new InitSDKListener(), +#### 3， 初始化配置 + +``` +/// 初始化SDK +OpenIM.iMManager + ..initSDK( + platform: IMPlatform.ios, + ipApi: 'Api接口地址', + ipWs: 'WebSocket地址', + dbPath: '数据库目录', + listener: InitSDKListener(), + ) + + /// 添加消息监听(不使用的时候remove) + ..messageManager.addAdvancedMsgListener(AdvancedMsgListener()) + + /// 设置消息发送进度监听 + ..messageManager.setMsgSendProgressListener(MsgSendProgressListener()) + + /// 设置好友关系监听 + ..friendshipManager.setFriendshipListener(FriendshipListener()) + + /// 设置会话监听 + ..conversationManager.setConversationListener(ConversationListener()) + + /// 设置群监听 + ..groupManager.setGroupListener(GroupListener()); +``` + +#### 4， 登录 + +``` + OpenIM.iMManager.login(uid: uid, token: token).then((value){ + ///登录成功 + }); +``` + +#### 5，获取会话列表 + +``` + OpenIM.iMManager.conversationManager.getAllConversationList().then((list) { + /// 返回会话列表list + }); +``` + +#### 6，获取联系人列表 + +``` + OpenIM.iMManager.friendshipManager.getFriendList().then((list) { + /// 返回好友列表list + }); +``` + +#### 7，获取聊天记录 + +``` +List chatMsgList = List.empty(growable: true); + +/// 自定义消息监听 +class CustomAdvancedMsgListener extends AdvancedMsgListener { + final ValueChanged? onNewMessage; + + CustomAdvancedMsgListener({ + this.onNewMessage, + }); + + @override + void onRecvNewMessage(Message msg) { + if (null != onNewMessage) onNewMessage!(msg); + } +} +``` + +- 历史消息 + +``` + /// 如果userID不为null，groupID为null，获取的是单聊消息 + /// 如果userID为null，groupID不为null，获取的是群聊消息 + OpenIM.iMManager.messageManager.getHistoryMessageList( + userID: uid,//用户id + startMsg: startMsg,//上一条消息,取chatMsgList[0] + groupID: gid,//群id + count: 12,//分页大小 ) - - /// 添加消息监听(移除消息监听: OpenIM.iMManager.messageManager.removeAdvancedMsgListener(msgListener)) - ..messageManager.addAdvancedMsgListener(msgListener) - - /// 设置发送消息进度监听 - ..messageManager.setMsgSendProgressListener(MsgSendProgressListener()) - - /// 设置好友关系监听 - ..friendshipManager.setFriendshipListener(FriendshipListener()) - - /// 设置会话监听 - ..conversationManager.setConversationListener(ConversationListener()) - - /// 设置群监听 - ..groupManager.setGroupListener(GroupListener()); + .then((list) => chatMsgList.addAll(list)); + +``` + +- 新消息 + +``` +/// 创建消息监听 +var msgListener = CustomAdvancedMsgListener(onNewMessage: (message) { + if (message.sendID == uid || message.groupID == gid) { + if (!chatMsgList.contains(message)) { + chatMsgList.add(event.message); + } + } +}); + +/// 添加消息监听 +OpenIM.iMManager.messageManager.addAdvancedMsgListener(msgListener); + +/// 移除消息监听 +// OpenIM.iMManager.messageManager.removeAdvancedMsgListener(msgListener); +``` + +#### 8，发送消息 + +``` +/// 创建消息 +var message = await OpenIM.iMManager.messageManager.createTextMessage( + text: '我是消息内容', + ); +/// 发送 +OpenIM.iMManager.messageManagersendMessage( + message: message, + onlineUserOnly: false, + userID: uid, + groupID: gid, + ).then((v) { + /// 发送成功 + }).catchError((e){ + /// 发送失败 + }); +``` + +#### 9，登出 + +``` +OpenIM.iMManager.logout(); +``` + + #### OpenIM.iMManager -| 方法 | 描述 | -| ---------------- | ------------------------------------------------------- | -| initSDK | 初始化sdk，platform：iOS-1，Android-0；listener初始监听 | -| unInitSDK | | -| login | 登录 | -| logout | 登出 | -| getLoginStatus | 登录状态 | -| getLoginUid | 当前uid | -| getLoginUserInfo | 当前用户信息 | -| setSelfInfo | 修改资料 | -| getUsersInfo | 根据uid获取用户资料 | -| forceReConn | 强制重连 | +| 方法 | 描述 | +| ---------------- | ------------------- | +| initSDK | 初始化sdk | +| unInitSDK | | +| login | 登录 | +| logout | 登出 | +| getLoginStatus | 登录状态 | +| getLoginUid | 当前uid | +| getLoginUserInfo | 当前用户信息 | +| setSelfInfo | 修改资料 | +| getUsersInfo | 根据uid获取用户资料 | +| forceReConn | 强制重连 | @@ -150,4 +254,3 @@ A Flutter im plugin. | getGroupApplicationList | 获取群申请列表 | | acceptGroupApplication | 接受群邀请 | | refuseGroupApplication | 拒绝群邀请 | - From f84ad2c41e55ac0cad77b0db38371626e1217202 Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:24:44 +0800 Subject: [PATCH 2/7] Update README.md --- README.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index cd099a4..a4c36ef 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ A Flutter im plugin. #### 3， 初始化配置 ``` -/// 初始化SDK +// 初始化SDK OpenIM.iMManager ..initSDK( platform: IMPlatform.ios, @@ -34,19 +34,19 @@ OpenIM.iMManager listener: InitSDKListener(), ) - /// 添加消息监听(不使用的时候remove) + // 添加消息监听(不使用的时候remove) ..messageManager.addAdvancedMsgListener(AdvancedMsgListener()) - /// 设置消息发送进度监听 + // 设置消息发送进度监听 ..messageManager.setMsgSendProgressListener(MsgSendProgressListener()) - /// 设置好友关系监听 + // 设置好友关系监听 ..friendshipManager.setFriendshipListener(FriendshipListener()) - /// 设置会话监听 + // 设置会话监听 ..conversationManager.setConversationListener(ConversationListener()) - /// 设置群监听 + // 设置群监听 ..groupManager.setGroupListener(GroupListener()); ``` @@ -54,7 +54,7 @@ OpenIM.iMManager ``` OpenIM.iMManager.login(uid: uid, token: token).then((value){ - ///登录成功 + ///登录成功 }); ``` @@ -62,7 +62,7 @@ OpenIM.iMManager ``` OpenIM.iMManager.conversationManager.getAllConversationList().then((list) { - /// 返回会话列表list + // 返回会话列表list }); ``` @@ -70,7 +70,7 @@ OpenIM.iMManager ``` OpenIM.iMManager.friendshipManager.getFriendList().then((list) { - /// 返回好友列表list + // 返回好友列表list }); ``` @@ -97,8 +97,8 @@ class CustomAdvancedMsgListener extends AdvancedMsgListener { - 历史消息 ``` - /// 如果userID不为null，groupID为null，获取的是单聊消息 - /// 如果userID为null，groupID不为null，获取的是群聊消息 + // 如果userID不为null，groupID为null，获取的是单聊消息 + // 如果userID为null，groupID不为null，获取的是群聊消息 OpenIM.iMManager.messageManager.getHistoryMessageList( userID: uid,//用户id startMsg: startMsg,//上一条消息,取chatMsgList[0] @@ -112,39 +112,40 @@ class CustomAdvancedMsgListener extends AdvancedMsgListener { - 新消息 ``` -/// 创建消息监听 +// 创建消息监听 var msgListener = CustomAdvancedMsgListener(onNewMessage: (message) { if (message.sendID == uid || message.groupID == gid) { if (!chatMsgList.contains(message)) { + // 当前聊天窗口新增消息 chatMsgList.add(event.message); } } }); -/// 添加消息监听 +// 添加消息监听 OpenIM.iMManager.messageManager.addAdvancedMsgListener(msgListener); -/// 移除消息监听 +// 移除消息监听 // OpenIM.iMManager.messageManager.removeAdvancedMsgListener(msgListener); ``` #### 8，发送消息 ``` -/// 创建消息 +// 创建消息 var message = await OpenIM.iMManager.messageManager.createTextMessage( text: '我是消息内容', ); -/// 发送 +// 发送 OpenIM.iMManager.messageManagersendMessage( message: message, onlineUserOnly: false, userID: uid, groupID: gid, ).then((v) { - /// 发送成功 + // 发送成功 }).catchError((e){ - /// 发送失败 + // 发送失败 }); ``` From bdf61d3091cd75eb8f544c93d9179a4ef62202bf Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:25:13 +0800 Subject: [PATCH 3/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4c36ef..7dc834d 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ OpenIM.iMManager ``` OpenIM.iMManager.login(uid: uid, token: token).then((value){ - ///登录成功 + //登录成功 }); ``` From 3503a9db4924c059544424a9949c86eeeddbc34f Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:26:41 +0800 Subject: [PATCH 4/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7dc834d..142ab6b 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ OpenIM.iMManager ``` OpenIM.iMManager.login(uid: uid, token: token).then((value){ - //登录成功 + // 登录成功 }); ``` From 80ebf5fdb9a2f2389ca94664ef15f75b0e8ad302 Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:28:02 +0800 Subject: [PATCH 5/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 142ab6b..914dc85 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ var message = await OpenIM.iMManager.messageManager.createTextMessage( text: '我是消息内容', ); // 发送 -OpenIM.iMManager.messageManagersendMessage( +OpenIM.iMManager.messageManager.sendMessage( message: message, onlineUserOnly: false, userID: uid, From 91c051cdd8ad70d3f930724c39070fae2e0f4f29 Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:32:39 +0800 Subject: [PATCH 6/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 914dc85..91f2a45 100644 --- a/README.md +++ b/README.md @@ -251,7 +251,7 @@ OpenIM.iMManager.logout(); | getGroupsInfo | 获取群信息 | | joinGroup | 加入群 | | quitGroup | 退出群 | -| transferGroupOwner | 群权限交接 | +| transferGroupOwner | 群权限转移 | | getGroupApplicationList | 获取群申请列表 | | acceptGroupApplication | 接受群邀请 | | refuseGroupApplication | 拒绝群邀请 | From a9c6f18bb26f16b3627cab59a16b20c16de71471 Mon Sep 17 00:00:00 2001 From: hrxiang Date: Tue, 20 Jul 2021 11:34:49 +0800 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91f2a45..013b1c8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # flutter_openim_sdk -A Flutter im plugin. +A flutter IM plugin for android and ios. ##### [Android体验包(密码：123456)](https://www.pgyer.com/openim)