From 7a68e13398d11897869b765ceae7a9b16ff57940 Mon Sep 17 00:00:00 2001 From: hrxiang Date: Mon, 27 Jun 2022 18:20:00 +0800 Subject: [PATCH] update --- README.zh-cn.md | 4 +++- lib/src/enum/group_at_type.dart | 2 +- lib/src/enum/im_platform.dart | 1 + lib/src/enum/listener_type.dart | 1 + lib/src/enum/message_type.dart | 3 +++ lib/src/listener/conversation_listener.dart | 14 +++++++------- lib/src/listener/msg_send_progress_listener.dart | 1 + lib/src/listener/organization_listener.dart | 1 + lib/src/listener/signaling_listener.dart | 1 + lib/src/listener/user_listener.dart | 3 ++- lib/src/listener/workmoments_listener.dart | 1 + lib/src/manager/im_manager.dart | 4 ++-- 12 files changed, 24 insertions(+), 12 deletions(-) diff --git a/README.zh-cn.md b/README.zh-cn.md index 8d1f793..6b80ffd 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -8,7 +8,7 @@ -## 方法名、参数、返回值说明 +## 类方法说明 #### IMManager（初始化管理） @@ -200,6 +200,8 @@ +## 方法名、参数、返回值说明 + - ##### initSDK（初始化SDK） ``` diff --git a/lib/src/enum/group_at_type.dart b/lib/src/enum/group_at_type.dart index 820a760..cafe970 100644 --- a/lib/src/enum/group_at_type.dart +++ b/lib/src/enum/group_at_type.dart @@ -1,6 +1,6 @@ /// 会话强提示内容 class GroupAtType { - /// 无提示 + /// 取消所有提示，即调用了resetConversationGroupAtType方法 static const atNormal = 0; /// @了我提示 diff --git a/lib/src/enum/im_platform.dart b/lib/src/enum/im_platform.dart index 1532d3b..27805ca 100644 --- a/lib/src/enum/im_platform.dart +++ b/lib/src/enum/im_platform.dart @@ -1,3 +1,4 @@ +/// 当前flutter平台仅支持Android/ios class IMPlatform { /// IOS static const ios = 1; diff --git a/lib/src/enum/listener_type.dart b/lib/src/enum/listener_type.dart index 67c3490..4592dfe 100644 --- a/lib/src/enum/listener_type.dart +++ b/lib/src/enum/listener_type.dart @@ -1,3 +1,4 @@ +/// callback类型 class ListenerType { static final simpleMsgListener = 'simpleMsgListener'; static final connectListener = 'connectListener'; diff --git a/lib/src/enum/message_type.dart b/lib/src/enum/message_type.dart index c9a1b40..c05dea8 100644 --- a/lib/src/enum/message_type.dart +++ b/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; /// 阅后即焚 diff --git a/lib/src/listener/conversation_listener.dart b/lib/src/listener/conversation_listener.dart index bb3a09f..713da74 100644 --- a/lib/src/listener/conversation_listener.dart +++ b/lib/src/listener/conversation_listener.dart @@ -18,7 +18,7 @@ class OnConversationListener { this.onSyncServerStart, }); - /// 会话发送改变 + /// 会话发生改变 void conversationChanged(List 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); - } } diff --git a/lib/src/listener/msg_send_progress_listener.dart b/lib/src/listener/msg_send_progress_listener.dart index 490d559..c38ddba 100644 --- a/lib/src/listener/msg_send_progress_listener.dart +++ b/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); } diff --git a/lib/src/listener/organization_listener.dart b/lib/src/listener/organization_listener.dart index 8c109c3..f91dd86 100644 --- a/lib/src/listener/organization_listener.dart +++ b/lib/src/listener/organization_listener.dart @@ -1,3 +1,4 @@ +/// 组织架构监听 class OnOrganizationListener { Function()? onOrganizationUpdated; diff --git a/lib/src/listener/signaling_listener.dart b/lib/src/listener/signaling_listener.dart index 67219c2..a2564ea 100644 --- a/lib/src/listener/signaling_listener.dart +++ b/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; diff --git a/lib/src/listener/user_listener.dart b/lib/src/listener/user_listener.dart index d6aac00..a6840fc 100644 --- a/lib/src/listener/user_listener.dart +++ b/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); } diff --git a/lib/src/listener/workmoments_listener.dart b/lib/src/listener/workmoments_listener.dart index 4f720b7..6f7dc9d 100644 --- a/lib/src/listener/workmoments_listener.dart +++ b/lib/src/listener/workmoments_listener.dart @@ -1,3 +1,4 @@ +/// 朋友圈监听 class OnWorkMomentsListener { Function()? onRecvNewNotification; diff --git a/lib/src/manager/im_manager.dart b/lib/src/manager/im_manager.dart index 3fe24fb..0e6a88f 100644 --- a/lib/src/manager/im_manager.dart +++ b/lib/src/manager/im_manager.dart @@ -323,7 +323,7 @@ class IMManager { )); } - @deprecated + /// 反初始化SDK Future unInitSDK() { return _channel.invokeMethod('unInitSDK', _buildParam({})); } @@ -381,7 +381,7 @@ class IMManager { })); /// 上传图片到服务器 - /// [path]图片路径 + /// [path] 图片路径 /// [token] im token /// [objectStorage] 存储对象 cos/minio Future uploadImage({