update

lib/src/manager/im_conversation_manager.dart

@@ -7,14 +7,12 @@ class ConversationManager {
 
   ConversationManager(this._channel);
 
-  /// Observe conversation changes
   /// 会话监听
   Future setConversationListener(OnConversationListener listener) {
     this.listener = listener;
     return _channel.invokeMethod('setConversationListener', _buildParam({}));
   }
 
-  /// Get all conversations
   /// 获取所有会话
   Future<List<ConversationInfo>> getAllConversationList(
           {String? operationID}) =>
@@ -27,8 +25,9 @@ class ConversationManager {
           .then((value) =>
               Utils.toList(value, (map) => ConversationInfo.fromJson(map)));
 
-  /// Paging to get conversation
   /// 分页获取会话
+  /// [offset] 开始下标
+  /// [count] 每页数量
   Future<List<ConversationInfo>> getConversationListSplit({
     int offset = 0,
     int count = 20,
@@ -45,12 +44,9 @@ class ConversationManager {
           .then((value) =>
               Utils.toList(value, (map) => ConversationInfo.fromJson(map)));
 
-  /// Get a conversation, if it doesn't exist it will be created automatically
-  /// [sourceID] if it is a single chat, Its value is userID. if it is a group chat, Its value is groupID
-  /// [sessionType] if it is a single chat, it value is 1. if it is a group chat, it value is 2
-  /// 获取一个会话，如果不存在会自动创建
-  /// [sourceID] 如果是单聊值传用户ID，如果是群聊值传组ID
-  /// [sessionType] 如果是单聊值传1，如果是群聊值传2
+  /// 查询会话，如果会话不存在会自动生成一个
+  /// [sourceID] 如果是单聊会话传userID，如果是群聊会话传GroupID
+  /// [sessionType] 如果是单聊会话传1，如果是群聊会话传2
   Future<ConversationInfo> getOneConversation({
     required String sourceID,
     required int sessionType,
@@ -67,8 +63,8 @@ class ConversationManager {
           .then((value) =>
               Utils.toObj(value, (map) => ConversationInfo.fromJson(map)));
 
-  /// Get conversation list by id list
-  /// 获取多个会话
+  /// 根据会话id获取多个会话
+  /// [conversationIDList] 会话id列表
   Future<List<ConversationInfo>> getMultipleConversation({
     required List<String> conversationIDList,
     String? operationID,
@@ -83,8 +79,8 @@ class ConversationManager {
           .then((value) =>
               Utils.toList(value, (map) => ConversationInfo.fromJson(map)));
 
-  /// Delete conversation by id
-  /// 删除会话
+  /// 通过会话id删除指定会话
+  /// [conversationID] 被删除的会话的id
   Future deleteConversation({
     required String conversationID,
     String? operationID,
@@ -96,8 +92,9 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Set draft
   /// 设置会话草稿
+  /// [conversationID] 会话id
+  /// [draftText] 草稿
   Future setConversationDraft({
     required String conversationID,
     required String draftText,
@@ -111,8 +108,9 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Pinned conversation
   /// 置顶会话
+  /// [conversationID] 会话id
+  /// [isPinned] true：置顶，false：取消置顶
   Future pinConversation({
     required String conversationID,
     required bool isPinned,
@@ -126,12 +124,8 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  // Future<dynamic> markSingleMessageHasRead({required String userID}) =>
-  //     _channel.invokeMethod(
-  //         'markSingleMessageHasRead', _buildParam({'userID': userID}));
-
-  /// Mark group chat all messages as read
   /// 标记群聊会话已读
+  /// [groupID] 群id
   Future<dynamic> markGroupMessageHasRead({
     required String groupID,
     String? operationID,
@@ -143,7 +137,6 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Get the total number of unread messages
   /// 获取未读消息总数
   Future<dynamic> getTotalUnreadMsgCount({
     String? operationID,
@@ -154,9 +147,6 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Query conversation id
-  /// [sourceID] if it is a single chat, Its value is userID. if it is a group chat, Its value is groupID
-  /// [sessionType] if it is a single chat, it value is 1. if it is a group chat, it value is 2
   /// 查询会话id
   /// [sourceID] 如果是单聊值传用户ID，如果是群聊值传组ID
   /// [sessionType] 如果是单聊值传1，如果是群聊值传2
@@ -171,9 +161,8 @@ class ConversationManager {
             "sessionType": sessionType,
           }));
 
-  /// Message Do Not Disturb
-  /// [status] 0: Normal. 1: Do not receive messages. 2: Do not notify when messages are received.
   /// 消息免打扰设置
+  /// [conversationIDList] 会话id列表
   /// [status] 0：正常；1：不接受消息；2：接受在线消息不接受离线消息；
   Future<dynamic> setConversationRecvMessageOpt({
     required List<String> conversationIDList,
@@ -188,9 +177,9 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Message Do Not Disturb
-  /// [{"conversationId":"single_13922222222","result":0}]
   /// 查询免打扰状态
+  /// [conversationIDList] 会话id列表
+  /// 返回：[{"conversationId":"single_13922222222","result":0}]，result值：0：正常；1：不接受消息；2：接受在线消息不接受离线消息；
   Future<List<dynamic>> getConversationRecvMessageOpt({
     required List<String> conversationIDList,
     String? operationID,
@@ -204,8 +193,9 @@ class ConversationManager {
               }))
           .then((value) => Utils.toListMap(value));
 
-  /// burn after reading
   /// 阅后即焚
+  /// [conversationID] 会话id
+  /// [isPrivate] true：开启，false：关闭
   Future<dynamic> setOneConversationPrivateChat({
     required String conversationID,
     required bool isPrivate,
@@ -219,8 +209,8 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Delete conversation from local and service
-  /// 删除会话
+  /// 删除本地以及服务器的会话
+  /// [conversationID] 会话ID
   Future<dynamic> deleteConversationFromLocalAndSvr({
     required String conversationID,
     String? operationID,
@@ -232,8 +222,7 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Delete conversation from local
-  /// 删除会话
+  /// 删除所有本地会话
   Future<dynamic> deleteAllConversationFromLocal({
     String? operationID,
   }) =>
@@ -243,8 +232,8 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Reset group converstaion at type
-  /// 重置at标准位
+  /// 重置强提醒标识[GroupAtType]
+  /// [conversationID] 会话id
   Future<dynamic> resetConversationGroupAtType({
     required String conversationID,
     String? operationID,
@@ -256,13 +245,10 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Get @ all member tag
-  /// 查询at所有人标识
+  /// 查询@所有人标识
   Future<dynamic> getAtAllTag() =>
       _channel.invokeMethod('getAtAllTag', _buildParam({}));
 
-  /// Global Do Not Disturb
-  /// [status] 0: Normal. 1: Do not receive messages. 2: Do not notify when messages are received.
   /// 全局免打扰
   /// [status] 0：正常；1：不接受消息；2：接受在线消息不接受离线消息；
   Future<dynamic> setGlobalRecvMessageOpt({
@@ -276,7 +262,6 @@ class ConversationManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Custom sort for conversation list
   /// 会话列表自定义排序规则。
   List<ConversationInfo> simpleSort(List<ConversationInfo> list) => list
     ..sort((a, b) {

lib/src/manager/im_friendship_manager.dart

@@ -7,16 +7,14 @@ class FriendshipManager {
 
   FriendshipManager(this._channel);
 
-  /// Set up a friend relationship listener
   /// 好友关系监听
   Future setFriendshipListener(OnFriendshipListener listener) {
     this.listener = listener;
     return _channel.invokeMethod('setFriendListener', _buildParam({}));
   }
 
-  /// Get friend info by user id
   /// 查询好友信息
-  /// [uidList] 好友的userID集合
+  /// [uidList] userID集合
   Future<List<UserInfo>> getFriendsInfo({
     required List<String> uidList,
     String? operationID,
@@ -30,10 +28,9 @@ class FriendshipManager {
               }))
           .then((value) => Utils.toList(value, (v) => UserInfo.fromJson(v)));
 
-  /// Send an friend application
   /// 发送一个好友请求，需要对方调用同意申请才能成为好友。
   /// [uid] 被邀请的用户ID
-  /// [reason] 说明
+  /// [reason] 备注说明
   Future<dynamic> addFriend({
     required String uid,
     String? reason,
@@ -47,7 +44,6 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Get someone's request to add me as a friend
   /// 获取别人加我为好友的申请
   Future<List<FriendApplicationInfo>> getRecvFriendApplicationList(
           {String? operationID}) =>
@@ -60,7 +56,6 @@ class FriendshipManager {
           .then((value) =>
               Utils.toList(value, (v) => FriendApplicationInfo.fromJson(v)));
 
-  /// Get friend requests from me
   /// 获取我发出的好友申请
   Future<List<FriendApplicationInfo>> getSendFriendApplicationList(
           {String? operationID}) =>
@@ -73,8 +68,7 @@ class FriendshipManager {
           .then((value) =>
               Utils.toList(value, (v) => FriendApplicationInfo.fromJson(v)));
 
-  /// Find all friends including those who have been added to the blacklist
-  /// 获取好友列表包含已拉入黑名单的好友
+  /// 获取好友列表，返回的列表包含了已拉入黑名单的好友
   Future<List<UserInfo>> getFriendList({String? operationID}) => _channel
       .invokeMethod(
           'getFriendList',
@@ -83,8 +77,7 @@ class FriendshipManager {
           }))
       .then((value) => Utils.toList(value, (v) => UserInfo.fromJson(v)));
 
-  /// Find all friends including those who have been added to the blacklist
-  /// 获取好友列表
+  /// 获取好友列表，返回的列表包含了已拉入黑名单的好友
   Future<List<dynamic>> getFriendListMap({String? operationID}) => _channel
       .invokeMethod(
           'getFriendList',
@@ -93,7 +86,6 @@ class FriendshipManager {
           }))
       .then((value) => Utils.toListMap(value));
 
-  /// Modify friend remark name
   /// 设置好友备注
   /// [uid] 好友的userID
   /// [remark] 好友的备注
@@ -110,9 +102,8 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Add friends to blacklist
   /// 加入黑名单
-  /// [uid]被加入黑名单的好友ID
+  /// [uid] 被加入黑名单的好友ID
   Future<dynamic> addBlacklist({
     required String uid,
     String? operationID,
@@ -124,7 +115,6 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Find all blacklist
   /// 获取黑名单列表
   Future<List<UserInfo>> getBlacklist({String? operationID}) => _channel
       .invokeMethod(
@@ -134,8 +124,8 @@ class FriendshipManager {
           }))
       .then((value) => Utils.toList(value, (v) => UserInfo.fromJson(v)));
 
-  /// Remove from blacklist
   /// 从黑名单移除
+  /// [uid] 用户ID
   Future<dynamic> removeBlacklist({
     required String uid,
     String? operationID,
@@ -147,8 +137,8 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Determine if there is a friendship by userId
   /// 检查友好关系
+  /// [uidList] userID列表
   Future<List<FriendshipInfo>> checkFriend({
     required List<String> uidList,
     String? operationID,
@@ -163,8 +153,8 @@ class FriendshipManager {
           .then((value) =>
               Utils.toList(value, (v) => FriendshipInfo.fromJson(v)));
 
-  /// Dissolve friendship from friend list
   /// 删除好友
+  /// [uid] 用户ID
   Future<dynamic> deleteFriend({
     required String uid,
     String? operationID,
@@ -176,8 +166,9 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Accept application of be friend
   /// 接受好友请求
+  /// [uid] 用户ID
+  /// [handleMsg]备注说明
   Future<dynamic> acceptFriendApplication({
     required String uid,
     String? handleMsg,
@@ -191,8 +182,9 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Refuse application of be friend
   /// 拒绝好友请求
+  /// [uid] 用户ID
+  /// [handleMsg]备注说明
   Future<dynamic> refuseFriendApplication({
     required String uid,
     String? handleMsg,
@@ -206,7 +198,6 @@ class FriendshipManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Search friends
   /// 查好友
   /// [keywordList] 搜索关键词，目前仅支持一个关键词搜索，不能为空
   /// [isSearchUserID] 是否以关键词搜索好友ID(注：不可以同时为false)，为空默认false

lib/src/manager/im_group_manager.dart

@@ -7,15 +7,15 @@ class GroupManager {
 
   GroupManager(this._channel);
 
-  /// Set up group relationship monitoring
   /// 组关系监听
   Future setGroupListener(OnGroupListener listener) {
     this.listener = listener;
     return _channel.invokeMethod('setGroupListener', _buildParam({}));
   }
 
-  /// Invite friends into the group
   /// 邀请进组，直接进组无需同意。
+  /// [groupId] 组ID
+  /// [uidList] 用户ID列表
   Future<List<GroupInviteResult>> inviteUserToGroup({
     required String groupId,
     required List<String> uidList,
@@ -34,8 +34,10 @@ class GroupManager {
           .then((value) =>
               Utils.toList(value, (map) => GroupInviteResult.fromJson(map)));
 
-  /// Remove member from group
   /// 移除组成员
+  /// [groupId] 组ID
+  /// [uidList] 用户ID列表
+  /// [reason]  备注说明
   Future<List<GroupInviteResult>> kickGroupMember({
     required String groupId,
     required List<String> uidList,
@@ -54,8 +56,9 @@ class GroupManager {
           .then((value) =>
               Utils.toList(value, (map) => GroupInviteResult.fromJson(map)));
 
-  /// Get group member's info
   /// 查询组成员资料
+  /// [groupId] 组ID
+  /// [uidList] 用户ID列表
   Future<List<GroupMembersInfo>> getGroupMembersInfo({
     required String groupId,
     required List<String> uidList,
@@ -72,10 +75,9 @@ class GroupManager {
           .then((value) =>
               Utils.toList(value, (map) => GroupMembersInfo.fromJson(map)));
 
-  /// Get the list of group members
   /// 分页获取组成员列表
   /// [groupId] 群ID
-  /// [filter] 过滤成员 1普通成员, 2群主，3管理员，0所有
+  /// [filter] 过滤成员 1普通成员, 2群主，3管理员，0 所有
   /// [offset] 开始下标
   /// [count] 总数
   Future<List<GroupMembersInfo>> getGroupMemberList({
@@ -98,7 +100,6 @@ class GroupManager {
           .then((value) =>
               Utils.toList(value, (map) => GroupMembersInfo.fromJson(map)));
 
-  /// Get the list of group members
   /// 分页获取组成员列表
   /// [groupId] 群ID
   /// [filter] 过滤成员 1普通成员, 2群主，3管理员，0所有
@@ -123,7 +124,6 @@ class GroupManager {
               }))
           .then((value) => Utils.toListMap(value));
 
-  /// Find all groups you have joined
   /// 查询已加入的组列表
   Future<List<GroupInfo>> getJoinedGroupList({String? operationID}) => _channel
       .invokeMethod(
@@ -133,7 +133,6 @@ class GroupManager {
           }))
       .then((value) => Utils.toList(value, (map) => GroupInfo.fromJson(map)));
 
-  /// Find all groups you have joined
   /// 查询已加入的组列表
   Future<List<dynamic>> getJoinedGroupListMap({String? operationID}) => _channel
       .invokeMethod(
@@ -143,8 +142,8 @@ class GroupManager {
           }))
       .then((value) => Utils.toListMap(value));
 
-  /// Check if you are a member of the group
   /// 检查是否已加入组
+  /// [gid] 组ID
   Future<bool> isJoinedGroup({
     required String gid,
     String? operationID,
@@ -153,14 +152,14 @@ class GroupManager {
         operationID: Utils.checkOperationID(operationID),
       ).then((list) => list.where((e) => e.groupID == gid).length > 0);
 
-  /// Create a group
   /// 创建一个组
   /// [groupName] 群名
   /// [notification] 公告
   /// [introduction] 群介绍
   /// [faceUrl] 群头像
+  /// [groupType] 组类型
   /// [ex] 额外信息
-  /// [list] 初创群成员以及其角色
+  /// [list] 初创群成员以及其角色列表，角色参考[GroupRoleLevel]类
   Future<GroupInfo> createGroup({
     String? groupName,
     String? notification,
@@ -189,7 +188,6 @@ class GroupManager {
           .then(
               (value) => Utils.toObj(value, (map) => GroupInfo.fromJson(map)));
 
-  /// Edit group information
   /// 编辑组资料
   /// [groupID] 被编辑的群ID
   /// [groupName] 新的群名
@@ -197,6 +195,7 @@ class GroupManager {
   /// [introduction] 新的群介绍
   /// [faceUrl] 新的群头像
   /// [ex] 新的额外信息
+  /// [needVerification] 进群设置，参考[GroupVerification]类
   Future<dynamic> setGroupInfo({
     required String groupID,
     String? groupName,
@@ -204,6 +203,7 @@ class GroupManager {
     String? introduction,
     String? faceUrl,
     String? ex,
+    int needVerification = 0,
     String? operationID,
   }) =>
       _channel.invokeMethod(
@@ -217,12 +217,13 @@ class GroupManager {
               "introduction": introduction,
               "faceURL": faceUrl,
               "ex": ex,
+              "needVerification": needVerification,
             },
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Find group information by group id
   /// 查询组信息
+  /// [gidList] 组ID列表
   Future<List<GroupInfo>> getGroupsInfo({
     required List<String> gidList,
     String? operationID,
@@ -237,7 +238,6 @@ class GroupManager {
           .then(
               (value) => Utils.toList(value, (map) => GroupInfo.fromJson(map)));
 
-  /// Apply to join the group
   /// 申请加入组，需要通过管理员/群组同意。
   Future<dynamic> joinGroup({
     required String gid,
@@ -252,7 +252,6 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Leave group
   /// 退出组
   Future<dynamic> quitGroup({
     required String gid,
@@ -265,8 +264,9 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Give group permissions to others
   /// 转移组拥有者权限
+  /// [gid] 组ID
+  /// [uid] 新拥有者ID
   Future<dynamic> transferGroupOwner({
     required String gid,
     required String uid,
@@ -280,7 +280,6 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// As the group owner or administrator, the group member's application to join the group received
   /// 作为群主或者管理员，收到的群成员入群申请
   Future<List<GroupApplicationInfo>> getRecvGroupApplicationList(
           {String? operationID}) =>
@@ -293,7 +292,6 @@ class GroupManager {
           .then((value) =>
               Utils.toList(value, (map) => GroupApplicationInfo.fromJson(map)));
 
-  /// Get the record of the group membership application issued by yourself
   /// 获取自己发出的入群申请记录
   Future<List<GroupApplicationInfo>> getSendGroupApplicationList(
           {String? operationID}) =>
@@ -306,9 +304,10 @@ class GroupManager {
           .then((value) =>
               Utils.toList(value, (map) => GroupApplicationInfo.fromJson(map)));
 
-  /// Accept group application
   /// 管理员或者群主同意某人进入某群
   /// 注：主动申请入群需要通过管理员/群组处理，被别人拉入群不需要管理员/群组处理
+  /// [gid] 组id
+  /// [uid] 申请者用户ID
   Future<dynamic> acceptGroupApplication({
     required String gid,
     required String uid,
@@ -324,9 +323,11 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Refuse group application
   /// 管理员或者群主拒绝某人进入某群
   /// 注：主动申请入群需要通过管理员/群组处理，被别人拉入群不需要管理员/群组处理
+  /// [gid] 组id
+  /// [uid] 申请者用户ID
+  /// [handleMsg] 说明
   Future<dynamic> refuseGroupApplication({
     required String gid,
     required String uid,
@@ -342,8 +343,8 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Dissmiss group
   /// 解散群
+  /// [groupID] 群ID
   Future<dynamic> dismissGroup({
     required String groupID,
     String? operationID,
@@ -355,7 +356,6 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Enable group mute
   /// 开启群禁言，所有群成员禁止发言
   /// [groupID] 将开启群禁言的组ID
   /// [mute] true：开启，false：关闭
@@ -372,11 +372,10 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Mute group members
   /// 禁言群成员
   /// [groupID] 群ID
   /// [userID] 将被禁言的成员ID
-  /// [seconds] 被禁言的时间s，设置为0则为接触禁言
+  /// [seconds] 被禁言的时间s，设置为0则为解除禁言
   Future<dynamic> changeGroupMemberMute({
     required String groupID,
     required String userID,
@@ -392,7 +391,6 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Set group user nickname
   /// 设置群成员昵称
   /// [groupID] 群ID
   /// [userID] 群成员的用户ID
@@ -412,7 +410,6 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Search group
   /// 查询群
   /// [keywordList] 搜索关键词，目前仅支持一个关键词搜索，不能为空
   /// [isSearchGroupID] 是否以关键词搜索群ID(注：两个不可以同时为false)，为空默认false
@@ -437,11 +434,10 @@ class GroupManager {
           .then(
               (value) => Utils.toList(value, (map) => GroupInfo.fromJson(map)));
 
-  /// Set group user role
   /// 设置群成员权限
   /// [groupID] 群ID
   /// [userID] 群成员的用户ID
-  /// [roleLevel] 角色等级
+  /// [roleLevel] 角色等级，参考[GroupRoleLevel]
   Future<dynamic> setGroupMemberRoleLevel({
     required String groupID,
     required String userID,
@@ -457,8 +453,7 @@ class GroupManager {
             'operationID': Utils.checkOperationID(operationID),
           }));
 
-  /// Get the list of group members
-  /// 分页获取组成员列表
+  /// 根据加入时间分页获取组成员列表
   /// [groupID] 群ID
   /// [joinTimeBegin] 加入开始时间
   /// [joinTimeEnd] 加入结束时间

lib/src/manager/im_manager.dart

@@ -289,23 +289,13 @@ class IMManager {
     });
   }
 
-  /// Initialize SDK
-  ///
-  /// [platform]  platform number  [IMPlatform]
-  /// [apiAddr]   api server ip address
-  /// [wsAddr]    webSocket ip address
-  /// [dataDir]   data storage directory
-  /// [objectStorage] storage object: cos/minio
-  /// [logLevel] log level: 1-not print
-  ///
   /// 初始化SDK
-  ///
   /// [platform]  平台编号[IMPlatform]
   /// [apiAddr]   SDK api地址
   /// [wsAddr]    SDK websocket地址
   /// [dataDir]   SDK数据库存储目录
   /// [objectStorage] 存储对象 cos/minio
-  /// [logLevel] 日志 1-不打印
+  /// [logLevel] 日志 1不打印
   Future<dynamic> initSDK({
     required int platform,
     required String apiAddr,
@@ -338,10 +328,9 @@ class IMManager {
     return _channel.invokeMethod('unInitSDK', _buildParam({}));
   }
 
-  /// Login sdk
   /// 登录
-  /// [uid]用户id
-  /// [token]登录token，从业务服务器上获取
+  /// [uid] 用户id
+  /// [token] 登录token，从业务服务器上获取
   Future<UserInfo> login({
     required String uid,
     required String token,
@@ -362,7 +351,6 @@ class IMManager {
     return uInfo;
   }
 
-  /// Logout sdk
   /// 登出
   Future<dynamic> logout({String? operationID}) async {
     var value = await _channel.invokeMethod(
@@ -375,19 +363,16 @@ class IMManager {
     return value;
   }
 
-  ///
+  /// 获取登录状态
   Future<int?> getLoginStatus() =>
       _channel.invokeMethod<int>('getLoginStatus', _buildParam({}));
 
-  /// Current user id
   /// 获取当前登录用户id
   Future<String> getLoginUserID() async => uid;
 
-  /// Current user info
   /// 获取当前登录用户信息
   Future<UserInfo> getLoginUserInfo() async => uInfo;
 
-  /// wakeup
   /// 从后台回到前台立刻唤醒
   Future wakeUp({String? operationID}) => _channel.invokeMethod(
       'wakeUp',
@@ -395,7 +380,6 @@ class IMManager {
         'operationID': Utils.checkOperationID(operationID),
       }));
 
-  /// upload image to server
   /// 上传图片到服务器
   /// [path]图片路径
   /// [token] im token

lib/src/manager/im_message_manager.dart

@@ -10,7 +10,6 @@ class MessageManager {
 
   MessageManager(this._channel);
 
-  /// Set a message listener
   /// 消息监听
   Future setAdvancedMsgListener(OnAdvancedMsgListener listener) {
     this.msgListener = listener;
@@ -22,18 +21,16 @@ class MessageManager {
         }));
   }
 
-  /// Set up message sending progress monitoring
   /// 消息发送进度监听
   void setMsgSendProgressListener(OnMsgSendProgressListener listener) {
     msgSendProgressListener = listener;
   }
 
-  /// Send a message to user or to group
-  /// [userID] receiver's user ID
   /// 发送消息
-  /// [userID]接收消息的用户id
-  /// [groupID]接收消息的组id
-  /// [offlinePushInfo]离线消息显示内容
+  /// [message] 消息体
+  /// [userID] 接收消息的用户id
+  /// [groupID] 接收消息的组id
+  /// [offlinePushInfo] 离线消息显示内容
   Future<Message> sendMessage({
     required Message message,
     required OfflinePushInfo offlinePushInfo,
@@ -53,7 +50,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Find all history message
   /// 获取聊天记录(以startMsg为节点，以前的聊天记录)
   /// [userID] 接收消息的用户id
   /// [conversationID] 会话id，查询通知时可用
@@ -81,8 +77,8 @@ class MessageManager {
               }))
           .then((value) => Utils.toList(value, (map) => Message.fromJson(map)));
 
-  /// Revoke the sent information
   /// 撤回消息
+  /// [message] 被撤回的消息体
   Future revokeMessage({
     required Message message,
     String? operationID,
@@ -94,8 +90,8 @@ class MessageManager {
               "operationID": Utils.checkOperationID(operationID),
             })));
 
-  /// Delete message
   /// 删除本地消息
+  /// [message] 被删除的消息体
   Future deleteMessageFromLocalStorage({
     required Message message,
     String? operationID,
@@ -107,12 +103,10 @@ class MessageManager {
               "operationID": Utils.checkOperationID(operationID),
             })));
 
-  ///
-  // Future deleteMessages({required List<Message> msgList}) =>
-  //     _channel.invokeMethod('deleteMessages',
-  //         _buildParam({"msgList": msgList.map((e) => e.toJson()).toList()}));
-
   /// 插入单聊消息到本地
+  /// [receiverID] 接收者id
+  /// [senderID] 发送者id
+  /// [message] 消息体
   Future<Message> insertSingleMessageToLocalStorage({
     String? receiverID,
     String? senderID,
@@ -131,6 +125,9 @@ class MessageManager {
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
   /// 插入群聊消息到本地
+  /// [groupID] 群id
+  /// [senderID] 发送者id
+  /// [message] 消息体
   Future<Message> insertGroupMessageToLocalStorage({
     String? groupID,
     String? senderID,
@@ -148,8 +145,9 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Mark c2c message as read
-  /// 标记c2c消息已读
+  /// 标记c2c单条消息已读
+  /// [userID] 消息来源的userID
+  /// [messageIDList] 消息clientMsgID集合
   Future markC2CMessageAsRead({
     required String userID,
     required List<String> messageIDList,
@@ -163,8 +161,9 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Mark group message as read
   /// 标记群聊消息已读
+  /// [groupID] 群id
+  /// [messageIDList] 消息clientMsgID集合
   Future markGroupMessageAsRead({
     required String groupID,
     required List<String> messageIDList,
@@ -178,7 +177,6 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Typing
   /// 正在输入提示
   /// [msgTip] 自定义内容
   Future typingStatusUpdate({
@@ -194,7 +192,6 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Create text message
   /// 创建文本消息
   Future<Message> createTextMessage({
     required String text,
@@ -209,7 +206,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create @ message
   /// 创建@消息
   /// [text] 输入内容
   /// [atUserIDList] 被@到的userID集合
@@ -235,8 +231,8 @@ class MessageManager {
           )
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create picture message
   /// 创建图片消息
+  /// [imagePath] 路径
   Future<Message> createImageMessage({
     required String imagePath,
     String? operationID,
@@ -251,7 +247,6 @@ class MessageManager {
           )
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create picture message
   /// 创建图片消息
   /// [imagePath] 路径
   Future<Message> createImageMessageFromFullPath({
@@ -268,8 +263,9 @@ class MessageManager {
           )
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create sound message
   /// 创建语音消息
+  /// [soundPath] 路径
+  /// [duration] 时长s
   Future<Message> createSoundMessage({
     required String soundPath,
     required int duration,
@@ -286,7 +282,6 @@ class MessageManager {
           )
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create sound message
   /// 创建语音消息
   /// [soundPath] 路径
   /// [duration] 时长s
@@ -306,8 +301,11 @@ class MessageManager {
           )
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create video message
   /// 创建视频消息
+  /// [videoPath] 路径
+  /// [videoType] 视频mime类型
+  /// [duration] 时长s
+  /// [snapshotPath] 默认站位图路径
   Future<Message> createVideoMessage({
     required String videoPath,
     required String videoType,
@@ -327,7 +325,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create video message
   /// 创建视频消息
   /// [videoPath] 路径
   /// [videoType] 视频mime类型
@@ -352,8 +349,9 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create file message
   /// 创建文件消息
+  /// [filePath] 路径
+  /// [fileName] 文件名
   Future<Message> createFileMessage({
     required String filePath,
     required String fileName,
@@ -370,7 +368,6 @@ class MessageManager {
         .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
   }
 
-  /// Create file message
   /// 创建文件消息
   /// [filePath] 路径
   /// [fileName] 文件名
@@ -389,7 +386,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create merger message
   /// 创建合并消息
   /// [messageList] 被选中的消息
   /// [title] 摘要标题
@@ -411,7 +407,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create forward message
   /// 创建转发消息
   /// [message] 被转发的消息
   Future<Message> createForwardMessage({
@@ -428,7 +423,6 @@ class MessageManager {
         .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
   }
 
-  /// Create location message
   /// 创建位置消息
   /// [latitude] 纬度
   /// [longitude] 经度
@@ -450,8 +444,10 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create custom message
   /// 创建自定义消息
+  /// [data] 自定义数据
+  /// [extension] 自定义扩展内容
+  /// [description] 自定义描述内容
   Future<Message> createCustomMessage({
     required String data,
     required String extension,
@@ -469,7 +465,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create quote message
   /// 创建引用消息
   /// [text] 回复的内容
   /// [quoteMsg] 被回复的消息
@@ -488,8 +483,8 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create card message
   /// 创建卡片消息
+  /// [data] 自定义数据
   Future<Message> createCardMessage({
     required Map<String, dynamic> data,
     String? operationID,
@@ -503,9 +498,6 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Create custom emoji message
-  /// [index] The position of the emoji, such as the position emoji
-  /// [data] Other data, such as url expressions
   /// 创建自定义表情消息
   /// [index] 位置表情，根据index匹配
   /// [data] url表情，直接使用url显示
@@ -524,8 +516,8 @@ class MessageManager {
               }))
           .then((value) => Utils.toObj(value, (map) => Message.fromJson(map)));
 
-  /// Clear all c2c history message
   /// 清空单聊消息记录
+  /// [uid] 单聊对象id
   Future<dynamic> clearC2CHistoryMessage({
     required String uid,
     String? operationID,
@@ -537,8 +529,8 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Clear all group history
   /// 清空组消息记录
+  /// [gid] 组id
   Future<dynamic> clearGroupHistoryMessage({
     required String gid,
     String? operationID,
@@ -550,17 +542,16 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Search local message
   /// 搜索消息
   /// [conversationID] 根据会话查询，如果是全局搜索传null
-  /// [keywordList]搜索关键词列表，目前仅支持一个关键词搜索
-  /// [keywordListMatchType]关键词匹配模式，1代表与，2代表或，暂时未用
-  /// [senderUserIDList]指定消息发送的uid列表 暂时未用
-  /// [messageTypeList]消息类型列表
-  /// [searchTimePosition]搜索的起始时间点。默认为0即代表从现在开始搜索。UTC 时间戳，单位：秒
-  /// [searchTimePeriod]从起始时间点开始的过去时间范围，单位秒。默认为0即代表不限制时间范围，传24x60x60代表过去一天
-  /// [pageIndex]当前页数
-  /// [count]每页数量
+  /// [keywordList] 搜索关键词列表，目前仅支持一个关键词搜索
+  /// [keywordListMatchType] 关键词匹配模式，1代表与，2代表或，暂时未用
+  /// [senderUserIDList] 指定消息发送的uid列表 暂时未用
+  /// [messageTypeList] 消息类型列表
+  /// [searchTimePosition] 搜索的起始时间点。默认为0即代表从现在开始搜索。UTC 时间戳，单位：秒
+  /// [searchTimePeriod] 从起始时间点开始的过去时间范围，单位秒。默认为0即代表不限制时间范围，传24x60x60代表过去一天
+  /// [pageIndex] 当前页数
+  /// [count] 每页数量
   Future<SearchResult> searchLocalMessages({
     String? conversationID,
     List<String> keywordList = const [],
@@ -593,8 +584,8 @@ class MessageManager {
           .then((value) =>
               Utils.toObj(value, (map) => SearchResult.fromJson(map)));
 
-  /// Delete message from local and service
   /// 删除本地跟服务器的指定的消息
+  /// [message] 被删除的消息
   Future<dynamic> deleteMessageFromLocalAndSvr({
     required Message message,
     String? operationID,
@@ -606,7 +597,6 @@ class MessageManager {
               "operationID": Utils.checkOperationID(operationID),
             })));
 
-  /// Delete all message from local
   /// 删除本地所有聊天记录
   Future<dynamic> deleteAllMsgFromLocal({
     String? operationID,
@@ -617,7 +607,6 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Delete all message from service
   /// 删除本地跟服务器所有聊天记录
   Future<dynamic> deleteAllMsgFromLocalAndSvr({
     String? operationID,
@@ -628,7 +617,6 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Mark conversation message as read
   /// 标记消息已读
   /// [conversationID] 会话ID
   /// [messageIDList] 被标记的消息clientMsgID
@@ -645,8 +633,8 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Clear all c2c history message
   /// 删除本地跟服务器的单聊聊天记录
+  /// [uid] 聊天对象的userID
   Future<dynamic> clearC2CHistoryMessageFromLocalAndSvr({
     required String uid,
     String? operationID,
@@ -658,8 +646,8 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Clear all group history
   /// 删除本地跟服务器的群聊天记录
+  /// [gid] 组id
   Future<dynamic> clearGroupHistoryMessageFromLocalAndSvr({
     required String gid,
     String? operationID,
@@ -671,7 +659,6 @@ class MessageManager {
             "operationID": Utils.checkOperationID(operationID),
           }));
 
-  /// Find all history message
   /// 获取聊天记录(以startMsg为节点，新收到的聊天记录)，用在全局搜索定位某一条消息，然后此条消息后新增的消息
   /// [userID] 接收消息的用户id
   /// [conversationID] 会话id，查询通知时可用

lib/src/manager/im_organization_manager.dart

@@ -7,15 +7,16 @@ class OrganizationManager {
 
   OrganizationManager(this._channel);
 
-  /// Observe organization info changes
   /// 组织架构发生变化回调
   Future setOrganizationListener(OnOrganizationListener listener) {
     this.listener = listener;
     return _channel.invokeMethod('setOrganizationListener', _buildParam({}));
   }
 
-  /// Query sub department
-  /// 获取子部门列表
+  /// 获取子部门列表，返回当前部门下的一级子部门
+  /// [departmentID] 当前部门id
+  /// [offset] 开始下标
+  /// [count] 每页大小
   Future<List<DeptInfo>> getSubDept({
     required String departmentID,
     int offset = 0,
@@ -33,8 +34,10 @@ class OrganizationManager {
               }))
           .then((value) => Utils.toList(value, (v) => DeptInfo.fromJson(v)));
 
-  /// Get member under a department
-  /// 获取部门下的成员列表
+  /// 获取部门下的成员列表，返回当前部门下的一级成员
+  /// [departmentID] 当前部门id
+  /// [offset] 开始下标
+  /// [count] 每页大小
   Future<List<DeptMemberInfo>> getDeptMember({
     required String departmentID,
     int offset = 0,
@@ -53,8 +56,8 @@ class OrganizationManager {
           .then((value) =>
               Utils.toList(value, (v) => DeptMemberInfo.fromJson(v)));
 
-  /// Get member's department
   /// 获取成员所在的部门
+  /// [userID] 成员ID
   Future<List<UserInDept>> getUserInDept({
     required String userID,
     String? operationID,
@@ -68,8 +71,8 @@ class OrganizationManager {
               }))
           .then((value) => Utils.toList(value, (v) => UserInDept.fromJson(v)));
 
-  /// Get the sub-departments and employees under the department
   /// 获取部门下的子部门跟员工
+  /// [departmentID] 当前部门id
   Future<DeptMemberAndSubDept> getDeptMemberAndSubDept({
     required String departmentID,
     // int departmentOffset = 0,
@@ -92,8 +95,8 @@ class OrganizationManager {
           .then((value) =>
               Utils.toObj(value, (v) => DeptMemberAndSubDept.fromJson(v)));
 
-  /// Query department info
   /// 查询部门信息
+  /// [departmentID] 部门ID
   Future<DeptInfo> getDeptInfo({
     required String departmentID,
     String? operationID,
@@ -107,8 +110,17 @@ class OrganizationManager {
               }))
           .then((value) => Utils.toObj(value, (v) => DeptInfo.fromJson(v)));
 
-  /// Search
   /// 搜索组织人员
+  /// [keyWord] 关键字
+  /// [isSearchUserName] 是否匹配用户名
+  /// [isSearchEnglishName] 是否匹配英文名
+  /// [isSearchPosition]  是否匹配职位
+  /// [isSearchUserID]  是否匹配用户ID
+  /// [isSearchMobile]  是否匹配手机号
+  /// [isSearchEmail] 是否匹配邮箱号
+  /// [isSearchTelephone] 是否匹配电话号码
+  /// [offset]  开始下标
+  /// [count] 分页大小
   Future<OrganizationSearchResult> searchOrganization({
     required String keyWord,
     bool isSearchUserName = false,

lib/src/manager/im_signaling_manager.dart

@@ -15,6 +15,7 @@ class SignalingManager {
   }
 
   /// 邀请个人加入音视频
+  /// [info] 信令对象[SignalingInfo]
   Future<SignalingCertificate> signalingInvite({
     required SignalingInfo info,
     String? operationID,
@@ -30,6 +31,7 @@ class SignalingManager {
               Utils.toObj(value, (map) => SignalingCertificate.fromJson(map)));
 
   /// 邀请群里某些人加入音视频
+  /// [info] 信令对象[SignalingInfo]
   Future<SignalingCertificate> signalingInviteInGroup({
     required SignalingInfo info,
     String? operationID,
@@ -45,6 +47,7 @@ class SignalingManager {
               Utils.toObj(value, (map) => SignalingCertificate.fromJson(map)));
 
   /// 同意某人音视频邀请
+  /// [info] 信令对象[SignalingInfo]
   Future<SignalingCertificate> signalingAccept({
     required SignalingInfo info,
     String? operationID,
@@ -60,6 +63,7 @@ class SignalingManager {
               Utils.toObj(value, (map) => SignalingCertificate.fromJson(map)));
 
   /// 拒绝某人音视频邀请
+  /// [info] 信令对象[SignalingInfo]
   Future<dynamic> signalingReject({
     required SignalingInfo info,
     String? operationID,
@@ -72,6 +76,7 @@ class SignalingManager {
           }));
 
   /// 邀请者取消音视频通话
+  /// [info] 信令对象[SignalingInfo]
   Future<dynamic> signalingCancel({
     required SignalingInfo info,
     String? operationID,
@@ -84,6 +89,7 @@ class SignalingManager {
           }));
 
   /// 挂断
+  /// [info] 信令对象[SignalingInfo]
   Future<dynamic> signalingHungUp({
     required SignalingInfo info,
     String? operationID,

lib/src/manager/im_user_manager.dart

@@ -7,15 +7,14 @@ class UserManager {
 
   UserManager(this._channel);
 
-  /// Observe user info changes
   /// 用户资料改变监听
   Future setUserListener(OnUserListener listener) {
     this.listener = listener;
     return _channel.invokeMethod('setUserListener', _buildParam({}));
   }
 
-  /// Query user information
   /// 获取用户资料
+  /// [uidList] 用户ID列表
   Future<List<UserInfo>> getUsersInfo({
     required List<String> uidList,
     String? operationID,
@@ -29,7 +28,6 @@ class UserManager {
               }))
           .then((value) => Utils.toList(value, (v) => UserInfo.fromJson(v)));
 
-  /// Get the information of the currently logged in user
   /// 获取当前登录用户的信息
   Future<UserInfo> getSelfUserInfo({
     String? operationID,
@@ -42,8 +40,15 @@ class UserManager {
               }))
           .then((value) => Utils.toObj(value, (map) => UserInfo.fromJson(map)));
 
-  /// Modify current user info
   /// 修改当前登录用户资料
+  /// [nickname] 昵称
+  /// [faceURL] 头像
+  /// [gender] 性别
+  /// [appMangerLevel]
+  /// [phoneNumber] 手机号
+  /// [birth] 出生日期
+  /// [email] 邮箱
+  /// [ex] 扩展字段
   Future<String?> setSelfInfo({
     String? nickname,
     String? faceURL,

lib/src/manager/im_workmoments_manager.dart

@@ -7,13 +7,13 @@ class WorkMomentsManager {
 
   WorkMomentsManager(this._channel);
 
-  /// Observe work moments changes
+  /// 朋友圈信息发送变化通知
   Future setWorkMomentsListener(OnWorkMomentsListener listener) {
     this.listener = listener;
     return _channel.invokeMethod('setWorkMomentsListener', _buildParam({}));
   }
 
-  /// Get work moments unread count
+  /// 获取朋友圈未读消息总数
   Future<int> getWorkMomentsUnReadCount({
     String? operationID,
   }) =>
@@ -25,7 +25,9 @@ class WorkMomentsManager {
               }))
           .then((value) => Utils.toObj(value, (map) => map['unreadCount']));
 
-  /// Get work moments notification list
+  /// 获取通知列表
+  /// [offset] 开始下标
+  /// [count] 每页大小
   Future<List<WorkMomentsInfo>> getWorkMomentsNotification({
     required int offset,
     required int count,
@@ -42,7 +44,7 @@ class WorkMomentsManager {
           .then((value) =>
               Utils.toList(value, (map) => WorkMomentsInfo.fromJson(map)));
 
-  /// Clear work moments notification
+  /// 清除通知列表
   Future clearWorkMomentsNotification({
     String? operationID,
   }) =>