update

README.zh-cn.md

@@ -8,7 +8,7 @@
 
 
 
-## 方法名、参数、返回值说明
+## 类方法说明
 
 #### IMManager（初始化管理）
 
@@ -200,6 +200,8 @@
 
 
 
+## 方法名、参数、返回值说明
+
 - ##### initSDK（初始化SDK）
 
 ```

lib/src/enum/group_at_type.dart

@@ -1,6 +1,6 @@
 /// 会话强提示内容
 class GroupAtType {
-  /// 无提示
+  /// 取消所有提示，即调用了resetConversationGroupAtType方法
   static const atNormal = 0;
 
   /// @了我提示

lib/src/enum/im_platform.dart

@@ -1,3 +1,4 @@
+/// 当前flutter平台仅支持Android/ios
 class IMPlatform {
   /// IOS
   static const ios = 1;

lib/src/enum/listener_type.dart

@@ -1,3 +1,4 @@
+/// callback类型
 class ListenerType {
   static final simpleMsgListener = 'simpleMsgListener';
   static final connectListener = 'connectListener';

lib/src/enum/message_type.dart

@@ -83,6 +83,7 @@ class MessageType {
 
   /// 用户信息改变
   static const userInfoUpdatedNotification = 1303;
+
   static const userNotificationEnd = 1399;
 
   /// OA通知
@@ -122,6 +123,7 @@ class MessageType {
 
   /// 解散群
   static const dismissGroupNotification = 1511;
+
   static const groupNotificationEnd = 1599;
 
   /// 群成员被禁言
@@ -143,6 +145,7 @@ class MessageType {
 
   /// 信令
   static const signalingNotification = 1601;
+
   static const signalingNotificationEnd = 1699;
 
   /// 阅后即焚

lib/src/listener/conversation_listener.dart

@@ -18,7 +18,7 @@ class OnConversationListener {
     this.onSyncServerStart,
   });
 
-  /// 会话发送改变
+  /// 会话发生改变
   void conversationChanged(List<ConversationInfo> list) {
     if (onConversationChanged != null) onConversationChanged!(list);
   }
@@ -28,6 +28,12 @@ class OnConversationListener {
     if (onNewConversation != null) onNewConversation!(list);
   }
 
+  /// 未读消息总数发送改变
+  void totalUnreadMessageCountChanged(int i) {
+    if (onTotalUnreadMessageCountChanged != null)
+      onTotalUnreadMessageCountChanged!(i);
+  }
+
   void syncServerFailed() {
     if (onSyncServerFailed != null) onSyncServerFailed!();
   }
@@ -39,10 +45,4 @@ class OnConversationListener {
   void syncServerStart() {
     if (onSyncServerStart != null) onSyncServerStart!();
   }
-
-  /// 未读消息总数发送改变
-  void totalUnreadMessageCountChanged(int i) {
-    if (onTotalUnreadMessageCountChanged != null)
-      onTotalUnreadMessageCountChanged!(i);
-  }
 }

lib/src/listener/msg_send_progress_listener.dart

@@ -4,6 +4,7 @@ class OnMsgSendProgressListener {
 
   OnMsgSendProgressListener({this.onProgress});
 
+  /// 消息发送进度
   void progress(String clientMsgID, int progress) {
     if (null != onProgress) onProgress!(clientMsgID, progress);
   }

lib/src/listener/organization_listener.dart

@@ -1,3 +1,4 @@
+/// 组织架构监听
 class OnOrganizationListener {
   Function()? onOrganizationUpdated;
 

lib/src/listener/signaling_listener.dart

@@ -1,5 +1,6 @@
 import 'package:flutter_openim_sdk/src/models/signaling_info.dart';
 
+/// 信令监听
 class OnSignalingListener {
   final Function(SignalingInfo info)? onInvitationCancelled;
   final Function(SignalingInfo info)? onInvitationTimeout;

lib/src/listener/user_listener.dart

@@ -1,12 +1,13 @@
 import 'package:flutter_openim_sdk/flutter_openim_sdk.dart';
 
+/// 当前用户资料监听
 class OnUserListener {
   /// The information of the logged-in user has been updated
   Function(UserInfo info)? onSelfInfoUpdated;
 
   OnUserListener({this.onSelfInfoUpdated});
 
-  /// 自身信息发送变化
+  /// 自身信息发送变化回调
   void selfInfoUpdated(UserInfo info) {
     onSelfInfoUpdated?.call(info);
   }

lib/src/listener/workmoments_listener.dart

@@ -1,3 +1,4 @@
+/// 朋友圈监听
 class OnWorkMomentsListener {
   Function()? onRecvNewNotification;
 

lib/src/manager/im_manager.dart

@@ -323,7 +323,7 @@ class IMManager {
         ));
   }
 
-  @deprecated
+  /// 反初始化SDK
   Future<dynamic> unInitSDK() {
     return _channel.invokeMethod('unInitSDK', _buildParam({}));
   }
@@ -381,7 +381,7 @@ class IMManager {
       }));
 
   /// 上传图片到服务器
-  /// [path]图片路径
+  /// [path] 图片路径
   /// [token] im token
   /// [objectStorage] 存储对象 cos/minio
   Future uploadImage({