@rongcloud/engine 5.9.9 → 5.10.2

package/index.d.ts

@@ -57,9 +57,21 @@ declare enum ConversationType {
  * @category Interface
  */
 interface IConversationTag {
+    /**
+     * 标签 ID
+     */
     tagId: string;
+    /**
+     * 标签名称
+     */
     tagName?: string;
+    /**
+     * 创建时间
+     */
     createdTime?: number;
+    /**
+     * 是否置顶
+     */
     isTop?: boolean;
 }
 /**
@@ -67,7 +79,13 @@ interface IConversationTag {
  * @category Interface
  */
 interface ITagParam {
+    /**
+     * 标签 ID
+     */
     tagId: string;
+    /**
+     * 标签名称
+     */
     tagName: string;
 }
 /**
@@ -88,9 +106,21 @@ interface ILocalTagStatus {
  * @category Interface
  */
 interface ITagInfo {
+    /**
+     * 标签 ID
+     */
     tagId: string;
+    /**
+     * 标签名称
+     */
     tagName: string;
+    /**
+     * 会话数量
+     */
     conversationCount: number;
+    /**
+     * 创建时间
+     */
     createdTime?: number;
 }
 /**
@@ -107,7 +137,13 @@ declare enum TagChangeType {
  * @category Enum
 */
 declare enum ChatroomEntryType {
+    /**
+     * 更新
+     */
     UPDATE = 1,
+    /**
+     * 删除
+     */
     DELETE = 2
 }
 
@@ -364,6 +400,10 @@ interface IChatroomNotifyBan {
      */
     extra: string;
 }
+/**
+ * 聊天室重新加入信息
+ * @category Type
+ */
 declare type IChatroomRejoinedInfo = IChatroomRejoinedFailed | IChatroomRejoinedSuccessed;
 /**
  * 聊天室信息
@@ -518,6 +558,7 @@ interface IChatroomEntries {
 /**
  * 聊天室加入成功返回值
  * @5.8.3
+ * @category Interface
  */
 interface IChatroomJoinResponse {
     /**
@@ -547,7 +588,8 @@ interface IChatroomJoinResponse {
 }
 
 /**
- * LogLevel 等级定义，与大数据服务器日志等级保持一致
+ * 日志打印等级定义
+ * @category Enum
  */
 declare enum LogL {
     /**
@@ -556,9 +598,6 @@ declare enum LogL {
     STATISTICS = -2,
     /**
      * 未明确使用场景，暂未使用，控制台不打印
-     * TODO:
-     * 暂未明确使用场景，实时日志系统上报？
-     * 需要明确下为什么会有 -1，以及与 -2 的区别，并在注释中补充
      */
     RECORD = -1,
     /**
@@ -584,6 +623,7 @@ declare enum LogL {
 }
 /**
  * 有效的日志等级声明
+ * @category Type
  */
 declare type EnableLogL = LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR;
 
@@ -664,7 +704,6 @@ declare abstract class BasicLogger implements ILogger {
     setOutputLevel(level?: EnableLogL): void;
     /**
      * 由子类继承实现日志入库
-     * @override
      */
     protected abstract flush(data: ILogData): void;
     private _log;
@@ -741,6 +780,7 @@ declare enum MessageBlockType {
 }
 /**
  * 消息被拦截源触发类型
+ * @category Enum
  */
 declare enum MessageBlockSourceType {
     /** 原始消息 */
@@ -768,6 +808,7 @@ declare enum MessageDirection {
 
 /**
  * 输入状态类型
+ * @category Enum
 */
 declare enum OperateStatus {
     typing = 0
@@ -1027,6 +1068,66 @@ declare enum ErrorCode {
      * @deprecated
      */
     INTERNALERRROR = 24015,
+    /**
+     * 24360
+     * 没有设置该用户托管属性的权限
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_KEY_NOT_ALLOW_SDK_SET = 24360,
+    /**
+     * 24361
+     * 用户托管基本属性的key列表中没有此key
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_KEY_NOT_EXIST = 24361,
+    /**
+     * 24362
+     * 用户托管扩展属性的 key 列表中没有此 key
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_EXT_KEY_NOT_EXIST = 24362,
+    /**
+     * 24363
+     * 超过了可以设置的用户托管扩展属性的最大上限
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_EXT_KV_COUNT_EXCEED_LIMIT = 24363,
+    /**
+     * 24364
+     * 用户托管基本属性或扩展属性的Value，字符超过最大上限
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_VALUE_LENGTH_EXCEED_LIMIT = 24364,
+    /**
+     * 24365
+     * 批量查询用户托管资料的数量超过了可以查询的上限 100 个
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_QUERY_COUNT_EXCEED_LIMIT = 24365,
+    /**
+     * 24366
+     * 没有此用户
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_USER_NOT_EXIST = 24366,
+    /**
+     * 24367
+     * 用户托管此属性Value只能是数字
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_VALUE_CAN_ONLY_BE_NUMBERS = 24367,
+    /**
+     * 24368
+     * 用户托管此属性 Value 值超过设置取值范围
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_VALUE_EXCEED_RANGE = 24368,
+    /**
+     * 24369
+     * 未开启用户信息托管功能
+     * @since 5.9.10
+     */
+    RC_USER_PROFILE_SERVICE_UNAVAILABLE = 24369,
     /**
      * 24401
      * 超级群功能未开通
@@ -1751,6 +1852,12 @@ declare enum ErrorCode {
      * 开发者调用接口传入的 mediaUrl 地址为空
      */
     INVALID_PARAMETER_MEDIA_URL = 34235,
+    /**
+     * 34236
+     * 开发者调用接口传入的 uniqueId 为空或者""
+     * @since 5.9.10
+     */
+    INVALID_PARAMETER_UNIQUE_ID = 34236,
     /**
      * 34238
      * 非法的代理配置，RongIMProxy 为空或者非法
@@ -1983,6 +2090,18 @@ declare enum ErrorCode {
      * @since 5.9.8
      */
     ADDON_NOT_EXIST = 34311,
+    /**
+     * 34312
+     * 参数 userProfile 非法
+     * @since 5.9.10
+     */
+    INVALID_PARAMETER_USER_PROFILE = 34312,
+    /**
+     * 34313
+     * 参数 userProfileVisibility 非法
+     * @since 5.9.10
+     */
+    INVALID_PARAMETER_USER_PROFILE_VISIBILITY = 34313,
     /**
      * 35001
      * 群组信息异常
@@ -2252,7 +2371,8 @@ declare enum ErrorCode {
 
 /**
  * 连接状态
- * @deprecated 请使用 `RCConnectionStatus` 替代此枚举声明
+ * @deprecated 已废弃，请使用 {@link RCConnectionStatus} 替代此枚举声明
+ * @category Enum
  */
 declare enum ConnectionStatus {
     /**
@@ -2511,7 +2631,7 @@ declare enum MessageType {
 }
 
 /**
- * @deprecated 已废弃，请使用 NotificationLevel
+ * @deprecated 已废弃，请使用 {@link NotificationLevel}
  * @category Enum
  */
 declare enum NotificationStatus {
@@ -2584,6 +2704,7 @@ interface IMetionedData {
 /**
  * 上传方法
  * @category Enum
+ * @hidden
  */
 declare enum UploadMethod {
     /**
@@ -2610,7 +2731,7 @@ declare enum UploadMethod {
 
 /**
  * @deprecated
- * 日志级别
+ * 日志级别，已废弃
  * @category Enum
  */
 declare enum LogLevel {
@@ -2806,6 +2927,13 @@ declare enum LogTagId {
     L_PULL_SUBSCRIBED_USER_RELATION_R = "L-pull_subscribed_user_relation-R",
     L_PULL_SUBSCRIBED_USER_STATUS_T = "L-pull_subscribed_user_status-T",
     L_PULL_SUBSCRIBED_USER_STATUS_R = "L-pull_subscribed_user_status-R",
+    L_OWN_USER_PROFILE_CHANGED_S = "L-own_user_profile_changed-S",
+    L_QUERY_SUBSCRIBE_DATA_T = "L-query_subscribe_data-T",
+    L_QUERY_SUBSCRIBE_DATA_R = "L-query_subscribe_data-R",
+    L_PULL_USER_PROFILE_T = "L-pull_user_profile-T",
+    L_PULL_USER_PROFILE_R = "L-pull_user_profile-R",
+    L_PULL_OWN_PROFILE_T = "L-pull_own_profile-T",
+    L_PULL_OWN_PROFILE_R = "L-pull_own_profile-R",
     L_PARSE_JSON_E = "L-parse_json-E"
 }
 
@@ -2873,6 +3001,11 @@ declare enum EConnectProtocol {
     HTTPS = 12
 }
 
+/**
+ * iOS 时效性通知等级
+ * @since 5.9.0 版本开始支持
+ * @category Enum
+ */
 declare enum InterruptionLevel {
     PASSIVE = "passive",
     ACTIVE = "active",
@@ -2887,7 +3020,13 @@ declare enum InterruptionLevel {
  * @category Enum
  */
 declare enum PushImportanceHonor {
+    /**
+     * 服务与通讯类消息
+     */
     NORMAL = "NORMAL",
+    /**
+     * 资讯营销类消息
+     */
     LOW = "LOW"
 }
 
@@ -2902,13 +3041,36 @@ declare enum StoreKeys {
     REALTIME_LOG_TIMESTAMP = "rc-realtime-log-timestamp"
 }
 
+/**
+ * 超级群频道类型
+ * @category Enum
+ */
 declare enum UltraGroupChannelType {
+    /**
+     * 超级群公有频道
+     */
     PUBLIC = 0,
+    /**
+     * 超级群私有频道
+     */
     PRIVATE = 1
 }
+/**
+ * 超级群频道类型变更通知
+ * @category Enum
+ */
 declare enum UltraGroupChannelChangeType {
+    /**
+     *  超级群公有频道变成了私有频道
+     */
     PUBLIC_TO_PRIVATE = 2,
+    /**
+     * 超级群私有频道变成了公有频道
+     */
     PRIVATE_TO_PUBLIC = 3,
+    /**
+     * 超级群频道变成了私有频道，但是当前用户不再该私有频道中
+     */
     PUBLIC_TO_PRIVATE_USER_NOT_IN = 6
 }
 /** PB 结构 MsgChange 属性 changeType 对应枚举值 */
@@ -2988,6 +3150,7 @@ declare enum ConnectReason {
 /**
  * 用户在线状态
  * @since 5.9.8
+ * @category Enum
  */
 declare enum OnlineStatus {
     /**
@@ -3004,6 +3167,7 @@ declare enum OnlineStatus {
 /**
  * 平台信息
  * @since 5.9.8
+ * @category Enum
  */
 declare enum PlatformInfo {
     /**
@@ -3034,16 +3198,23 @@ declare enum PlatformInfo {
 /**
  * 订阅类型
  * @since 5.9.8
+ * @category Enum
  */
 declare enum SubscribeType {
     /**
      * 在线状态订阅
      */
-    ONLINE_STATUS = 1
+    ONLINE_STATUS = 1,
+    /**
+     * 用户信息订阅
+     * @since 5.10.1
+     */
+    USER_PROFILE = 2
 }
 /**
  * 订阅操作类型
  * @since 5.9.8
+ * @category Enum
  */
 declare enum SubscribeOperationType {
     /**
@@ -3055,6 +3226,15 @@ declare enum SubscribeOperationType {
      */
     UNSUBSCRIBE = 1
 }
+/**
+* 用户权限
+* @since 5.10.1
+* */
+declare enum UserProfileVisibility {
+    NOT_SET = 0,
+    INVISIBLE = 1,
+    EVERYONE = 2
+}
 
 /**
  * 音视频模式
@@ -3159,7 +3339,7 @@ interface IGooglePushConfig {
      */
     collapseKey?: string;
     /**
-     *
+     * 图片 URL
      */
     imageUrl?: string;
     /**
@@ -3337,9 +3517,20 @@ interface IReadReceiptResponseInfo {
  * @category Interface
  */
 interface IMessageReader {
+    /**
+     * 已读时间
+     */
     readTime: number;
+    /**
+     *  用户 ID
+     */
     userId: string;
 }
+/**
+ * 已读回执响应数据结构V4
+ * @category Interface
+ * @hidden
+ */
 interface IMessageReadReceiptV4Response {
     list: IMessageReader[];
     readCount: number;
@@ -3453,6 +3644,7 @@ interface ISyncReadStatusData extends IConversationOption {
  * 消息的接收状态详情
  * 该字段只适用 Electron 平台，只有 isRetrieved 只对 web 平台有效
  * @since 5.9.3
+ * @category Interface
  */
 interface IReceivedStatusInfo {
     /**
@@ -3533,12 +3725,12 @@ interface IReceivedMessage {
     receivedTime: number;
     /**
      * 是否存储
-     * @default true
+     * @defaultValue true
      */
     isPersited: boolean;
     /**
      * 是否计数
-     * @default true
+     * @defaultValue true
      */
     isCounted: boolean;
     /**
@@ -3618,7 +3810,13 @@ interface IReceivedMessage {
  * @category Interface
  */
 interface IFirstUnreadMessageInfo {
+    /**
+     * 消息 UID
+     */
     messageUId: string;
+    /**
+     * 消息发送时间
+     */
     sentTime: number;
 }
 /**
@@ -3647,24 +3845,78 @@ interface IUserProfile {
      */
     portrait?: string;
 }
+/**
+ * 操作明细信息
+ * @category Interface
+ */
 interface IOperateInfo {
+    /**
+     * 操作目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId?: string;
+    /**
+     * 用户 ID
+     */
     userId: string;
+    /**
+     * 操作类型
+     */
     operationType: OperateStatus;
+    /**
+     * 服务端收到用户操作的上行时间
+     */
     operationTime?: number;
 }
+/**
+ * 操作汇总
+ * @category Interface
+ */
 interface IOperateSummary {
+    /**
+     * 操作目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId?: string;
+    /**
+     * 数量
+     */
     count: number;
+    /**
+     * 操作类型
+     */
     operationType: OperateStatus;
 }
+/**
+ * 操作状态通知
+ * @category Interface
+ */
 interface IOperateStatusNotify {
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 存在明细
+     */
     hasInfo: boolean;
+    /**
+     * 存在汇总
+     */
     hasSummary: boolean;
+    /**
+     * 明细
+     */
     info: IOperateInfo[];
+    /**
+     * 汇总
+     */
     summary: IOperateSummary[];
 }
 interface IRecallMsgOptions {
@@ -3865,24 +4117,76 @@ interface IInsertMsgOptions {
     channelId: string;
     directedUserIds?: string[];
 }
+/**
+ * 插入消息结构
+ * @category Interface
+ */
 interface IInsertMessage {
+    /**
+     * 会话类型
+     */
     conversationType: number;
+    /**
+     * 会话 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
+    /**
+     * 消息方向
+     */
     messageDirection: number;
+    /**
+     * 消息类型
+     */
     messageType: string;
+    /**
+     * 消息内容
+     */
     content: any;
+    /**
+     * 消息 ID
+     */
     messageUId: string;
+    /**
+     * 发送者 ID
+     */
     senderUserId: string;
+    /**
+     * 发送状态
+     */
     sentStatus?: number;
+    /**
+     * 发送时间
+     */
     sentTime?: number;
+    /**
+     * 是否存储
+     */
     disableNotification?: boolean;
+    /**
+     * 是否计数
+     */
     canIncludeExpansion?: boolean;
+    /**
+     * 消息扩展
+     */
     expansion?: {
         [key: string]: any;
     } | null;
+    /**
+     * 接收状态
+     */
     receivedStatus?: number;
+    /**
+     * 接收状态详情
+     */
     receivedStatusInfo?: IReceivedStatusInfo;
+    /**
+     * 定向用户列表
+     */
     directedUserIds?: string[];
     /**
      * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
@@ -3896,6 +4200,9 @@ interface IInsertMessage {
      * 来源
      */
     source?: string;
+    /**
+     * 是否 @ 消息
+     */
     isMentioned?: boolean;
 }
 interface ISendExMsgOptions {
@@ -3993,19 +4300,44 @@ interface IUltraMsgQueryOptions {
  * @category Interface
  */
 interface IBlockedMessageInfo {
+    /**
+     * 拦截消息 UID
+     */
     blockedMessageUId: string;
+    /**
+     * 会话类型
+     */
     conversationType: number;
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
+    /**
+     * 消息被拦截类型
+     */
     blockType: MessageBlockType;
+    /**
+     * 应用服务器发送敏感词拦截消息中 content 里的 extra 字段，类型由用户定义
+     */
     extra: any;
+    /**
+     * 消息被拦截源触发类型
+     */
     sourceType?: MessageBlockSourceType;
+    /**
+     * 原消息内容
+     */
     sourceContent?: {
         [key: string]: any;
     };
 }
 /**
  * 超级群获取指定会话未读 @ 消息列表参数
+ * @category Interface
 */
 interface IUltraGroupUnreadMentionedOption {
     /**
@@ -4027,6 +4359,7 @@ interface IUltraGroupUnreadMentionedOption {
 }
 /**
  * 超级群获取指定会话 @ 未读消息列表结果
+ * @category Interface
 */
 interface IUltraUnreadMsg {
     /**
@@ -4046,16 +4379,27 @@ interface IUltraUnreadMsg {
      */
     messageType: string;
 }
+/**
+ * 被 @ 的用户信息
+ * @category Interface
+ */
 interface MentionedInfoBody {
+    /**
+     * @ 类型
+     */
     type: MentionedType;
     /**
      * 被 @ 的用户 Id 列表，仅在 `type` 为 `2` 时有效
      */
     userIdList?: string[];
+    /**
+     * 携带扩展信息，例如 `有人@你`
+     */
     mentionedContent?: string;
 }
 /**
  * 被合并的消息数据结构
+ * @category Interface
  */
 interface ICombinedMessage {
     /**
@@ -4081,6 +4425,8 @@ interface ICombinedMessage {
 }
 /**
  * v2 版本合并转发消息 content 结构
+ * @category Interface
+ * @hidden
  */
 interface ICombineV2MessageContent {
     /**
@@ -4116,41 +4462,81 @@ interface ICombineV2MessageContent {
  * @category Interface
  */
 interface IClearMessageOption {
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 频道 ID
+     */
     channelId?: string;
+    /**
+     * 时间
+     */
     timestamp?: number;
 }
 
+/**
+ * 会话变更更新项
+ * @category Interface
+ */
 interface IUpdateItem {
+    /**
+     * 置顶变更
+     */
     isTop?: {
         time: number;
         val: boolean;
     };
+    /**
+     * 免打扰状态变更（低版本）
+     */
     notificationStatus?: {
         time: number;
         val: NotificationStatus;
     };
+    /**
+     * 免打扰状态变更
+     */
     notificationLevel?: {
         time: number;
         val: NotificationLevel;
     };
+    /**
+     * 存在 @ 信息
+     */
     hasMentioned?: {
         time: number;
         val: boolean;
     };
+    /**
+     * @ 信息
+     */
     mentionedInfo?: {
         time: number;
         val: MentionedInfoBody;
     };
+    /**
+     * 未读数变更
+     */
     unreadMessageCount?: {
         time: number;
         val: number;
     };
+    /**
+     * 标签变更
+     */
     tags?: {
         time: number;
         val: IConversationTag;
     };
+    /**
+     * 会话最后一条消息变更
+     */
     latestMessage?: {
         time: number;
         val: IReceivedMessage;
@@ -4199,6 +4585,9 @@ interface IReceivedConversation {
      * 2. 未开启免打扰
      */
     notificationStatus: NotificationStatus;
+    /**
+     * 会话免打扰状态
+     */
     notificationLevel?: NotificationLevel;
     /**
      * 会话是否已置顶
@@ -4238,7 +4627,14 @@ interface IReceivedConversation {
 interface IReceivedConversationByTag extends IReceivedConversation {
     isTopInTag: boolean;
 }
-interface IUltraGroupConversation extends IReceivedConversation {
+/**
+ * 超级群会话数据结构
+ * @category Interface
+ */
+interface IUltraGroupConversation extends IReceivedConversation {
+    /**
+     * 超级群频道类型，只有 ConversationType 为超级群时该字段有效
+     */
     channelType?: UltraGroupChannelType;
     /**
      * 第一条未读消息
@@ -4257,18 +4653,43 @@ interface ISetConversationStatusOptions {
     channelId?: string;
     isUpdateTime?: boolean;
 }
+/**
+ * 会话更新信息
+ * @category Interface
+ */
 interface IUpdatedConversation {
+    /**
+     * 更新项
+     */
     updatedItems: {
         [key: string]: {
             time: number;
             val: any;
         };
     };
+    /**
+     * 会话类型
+     */
     conversationType: number;
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 会话最后一条消息
+     */
     latestMessage?: IReceivedMessage;
+    /**
+     * 会话未读数
+     */
     unreadMessageCount?: number;
+    /**
+     * 是否有 @ 消息
+     */
     hasMentioned?: boolean;
+    /**
+     * @ 信息详情
+     */
     mentionedInfo?: {
         /**
          * `@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人`
@@ -4279,14 +4700,29 @@ interface IUpdatedConversation {
          */
         userIdList: string[];
     };
+    /**
+     * 未读消息时间
+     */
     lastUnreadTime?: number;
+    /**
+     * 免打扰状态
+     */
     notificationStatus?: number;
+    /**
+     * 免打扰状态
+     */
     notificationLevel?: number;
+    /**
+     * 是否置顶
+     */
     isTop?: boolean;
     /**
-     * 会话标识
+     * 频道 ID
     */
     channelId?: string;
+    /**
+     * 会话标签
+     */
     tags?: IUpdatedConversation[];
     versionTime?: number;
     /**
@@ -4301,18 +4737,35 @@ interface IUpdatedConversation {
     unreadMentionedMeCount?: number;
 }
 /**
+ * 会话基础信息
  * @category Interface
  */
 interface IBaseConversationInfo {
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
 }
 /**
+ * 会话标签变更通知内容
  * @category Interface
  */
 interface IConversationState extends IBaseConversationInfo {
+    /**
+     * 消息未读数
+     */
     unreadCount: number;
+    /**
+     * @ 消息未读数
+     */
     unreadMentionedCount: number;
 }
 /**
@@ -4320,57 +4773,141 @@ interface IConversationState extends IBaseConversationInfo {
  * @category Interface
  */
 interface IUltraGroupOption {
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId?: string;
 }
 /**
+ * 获取超级群列表传参
  * @category Interface
  */
 interface IGetUltraGroupListOption {
+    /**
+     * 目标 ID
+     */
     targetId?: string;
+    /**
+     * 超级群频道类型
+     */
     channelType?: UltraGroupChannelType;
 }
 /**
  * 超级群频道变更通知内容
+ * @category Interface
  */
 interface IUltraChannelChangeInfo {
+    /**
+   * 目标 ID
+   */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
+    /**
+     * 超级群频道类型
+     */
     channelType: UltraGroupChannelType;
+    /**
+     * 超级群频道类型变更通知
+     */
     changeType: UltraGroupChannelChangeType;
 }
 /**
  * 超级群私有频道用户被踢出白名单通知内容
+ * @category Interface
  */
 interface IUltraChannelUserKickedInfo {
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
+    /**
+     * 超级群频道类型
+     */
     channelType: UltraGroupChannelType;
+    /**
+     * 用户 ID
+     */
     userId: string;
 }
 /**
  * 超级群频道被删除通知内容
+ * @category Interface
  */
 interface IUltraChannelDeleteInfo {
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
+    /**
+     * 超级群频道类型
+     */
     channelType: UltraGroupChannelType;
+    /**
+     * 删除时间
+     */
     deleteTime: number;
 }
 /**
  * 获取超级群获取指定会话未读 @ 消息列表
+ * @category Interface
 */
 interface IUltraUnreadConversation {
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId?: string;
 }
+/**
+ * 超级群频道变更通知内容
+ * @category Interface
+ */
 interface IUltraGroupUnreadInfo {
+    /**
+     * 会话类型
+     */
     type: ConversationType;
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
+    /**
+     * 未读消息数
+     */
     unreadMessageCount: number;
+    /**
+     * @ 消息数
+     */
     mentionedCount: number;
+    /**
+     * @ 我的消息数
+     */
     mentionedMeCount: number;
+    /**
+     * 免打扰级别
+     */
     notificationLevel: NotificationLevel;
 }
 
@@ -4481,6 +5018,8 @@ interface IUploadAuth {
 }
 /**
  * 下载鉴权信息
+ * @category Interface
+ * @hidden
  */
 interface IDownloadAuth {
     /**
@@ -4536,6 +5075,7 @@ interface IRTCUserData {
 }
 
 /**
+ * 异步任务结果结构
  * @category Interface
  */
 interface IAsyncRes<T = void> {
@@ -4556,6 +5096,7 @@ interface IAsyncRes<T = void> {
  * 异步任务结果定义
  * @description
  * 通过 `Promise.resolve` 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常
+ * @category Type
  */
 declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
 interface IConnectResult {
@@ -4571,6 +5112,7 @@ interface IConnectResult {
 
 /**
  * 代理信息
+ * @hidden
  */
 interface IProxy {
     socksHost: string;
@@ -4587,7 +5129,7 @@ declare enum HttpMethod {
 interface IRequest {
     url: string;
     /**
-     * @default `HttpMethod.GET`
+     * @defaultValue `HttpMethod.GET`
      */
     method?: HttpMethod | 'GET' | 'POST' | 'PUT';
     /**
@@ -4630,6 +5172,10 @@ interface IStorage {
     removeItem(key: string): void;
     clear(): void;
 }
+/**
+ * http 请求返回数据结构
+ * @category Interface
+ */
 interface IResponse {
     status: number;
     data?: string;
@@ -5054,9 +5600,15 @@ interface INaviInfo {
     /**
      * #用户订阅驱动配置，位标记！！：
      * 第一位：是否开启在线状态订阅功能
-     * 第二位（预留）：是否开启用户信息托管订阅功能
+     * 第二位：是否开启用户信息托管订阅功能
      */
     subDriven?: number;
+    /**
+     * 用户托管功能开关
+     * 0: 关闭（默认）
+     # 1: 开启
+     */
+    userProfile?: number;
 }
 
 declare type Content = string | number | boolean | null;
@@ -5186,7 +5738,6 @@ declare abstract class BasicStatistic {
     constructor(_appkey: string, _id: string, _type: Type);
     /**
      * 由子类继承实现日志入库
-     * @override
      */
     protected abstract flush(data: IStatisticData): void;
     private _writer;
@@ -5276,7 +5827,7 @@ declare abstract class BasicStatisticReporter {
     private _sendLogs2Realtime;
     /**
      * 实时日志上报
-     * @override IndexDBReporter 重载此方法，增加同设备多页面多端时进程竞争检测
+     * IndexDBReporter 重载此方法，增加同设备多页面多端时进程竞争检测
      */
     protected realtimeReport(uri: string, level: StatisticL, itv: number): Promise<void>;
     protected abstract compressStatistics(logs: IStatisticData[]): Promise<{
@@ -5321,7 +5872,7 @@ declare class IndexDBStatisticReporter extends BasicStatisticReporter {
     statisticLog: BasicStatistic);
     protected send(req: IRequest): Promise<IResponse>;
     /**
-     * @override 重写实现
+     * 实时日志上报启动
      */
     checkStart(navi: INaviInfo): Promise<void>;
     protected compressStatistics(logs: IStatisticData[]): Promise<{
@@ -5346,6 +5897,10 @@ declare class IndexDBStatisticReporter extends BasicStatisticReporter {
     protected realtimeReport(url: string, level: StatisticL, itv: number): Promise<void>;
 }
 
+/**
+ * 区域码枚举
+ * @category Enum
+ */
 declare enum AreaCode {
     /**
      * 默认值，北京数据中心
@@ -5626,6 +6181,7 @@ interface IProcessInfo {
 
 /**
  * 连接状态定义枚举值
+ * @category Enum
  */
 declare enum RCConnectionStatus {
     /**
@@ -5806,55 +6362,288 @@ declare abstract class AConnectionMgr {
      */
     private _failedCount;
     /**
-     * 允许连续 PING 超时次数，超出指定次数后会主动关闭 socket 并重新连接
+     * 允许连续 PING 超时次数，超出指定次数后会主动关闭 socket 并重新连接
+     */
+    private readonly ALLOW_FAILED_TIMES;
+    /**
+     * 启动心跳计时器
+     */
+    private checkAlive;
+    /**
+     * 关闭连接
+     * @param inReconnect
+     */
+    protected abstract close(inReconnect: boolean, closeDB?: boolean): void;
+    /**
+     * 完成一次 ping 过程，并返回响应状态码
+     * @param timeout 超时时间
+     */
+    protected abstract sendPing(timeout: number): Promise<ErrorCode>;
+    /**
+     * 业务层主动断开连接时调用
+     */
+    disconnect(closeDB?: boolean): Promise<void>;
+    /**
+     * 清理重连计时器
+     */
+    private stopReconnectTimer;
+    private _getProtocol;
+    /**
+     * 获取 CMP 列表
+     */
+    protected getCmpList(navi: INaviInfo, isTcp?: boolean): IServerAddressData[];
+    /**
+     * 修改 CMP 权重
+     */
+    protected updateCmpWeight(cmpUrl: string, isRise: boolean, isQuick?: boolean): void;
+    private clearCmpWeightCache;
+}
+
+/**
+ * 查询错误码是否为服务下发的 disconnect 通知 status 所转换
+ * @param code
+ * @description 排除重定向 31006，因 disconnect 和 connAck 都包含元素可被转换为 31006
+ */
+declare const isDisconnectCode: (code: ErrorCode) => boolean;
+/**
+ * 查询错误码是否为服务下发的 connAck status 所转换
+ * @param code
+ * @description 排除重定向 31006，因 disconnect 和 connAck 都包含元素可被转换为 31006
+ */
+declare const isConnnectAckCode: (code: ErrorCode) => boolean;
+
+/**
+* 用户信息
+* @since 5.10.1
+* */
+interface IUserProfileInfo {
+    /**
+     * 用户Id
+     * @description 不可修改
+     */
+    userId?: string;
+    /**
+     * 昵称
+     */
+    name?: string;
+    /**
+     * 头像地址
+     */
+    portraitUri?: string;
+    /**
+     * 用户应用号
+     * @description 不可修改
+     */
+    uniqueId?: string;
+    /**
+     * Email
+     */
+    email?: string;
+    /**
+     * 生日
+     */
+    birthday?: string;
+    /**
+     * 性别
+     */
+    gender?: number;
+    /**
+     * 所在地
+     */
+    location?: string;
+    /**
+     * 角色
+     */
+    role?: number;
+    /**
+     * 级别
+     */
+    level?: number;
+    /**
+     * 用户扩展信息
+     */
+    extraProfile?: {
+        [key: string]: string;
+    };
+}
+interface IServerProfileInfo {
+    key: string;
+    value: string;
+}
+interface IUserProfileServerData {
+    version: number;
+    userId: string;
+    userProfile: IServerProfileInfo[];
+    userExtProfile: IServerProfileInfo[];
+}
+
+/**
+ * 订阅关系信息
+ * @since 5.9.8
+ * @category Interface
+ */
+interface ISubscribeRelationInfo {
+    /**
+     * 用户 ID
+     */
+    userId: string;
+    /**
+     * 订阅类型
+     */
+    subscribeType: SubscribeType;
+    /**
+     * 订阅时间
+     */
+    subscribeTime: number;
+    /**
+     * 订阅有效期，单位为秒
+     */
+    expiry: number;
+    /**
+     * 订阅状态
+     */
+    operationType: SubscribeOperationType;
+}
+/**
+ * 订阅用户状态信息
+ * @category Interface
+ * @since 5.9.8
+ */
+interface ISubscribeUserStatusInfo {
+    /**
+     * 用户 ID
+     */
+    userId: string;
+    /**
+     * 订阅类型
+     */
+    subscribeType: SubscribeType;
+    /**
+     * 订阅时间
+     */
+    subscribeTime: number;
+    /**
+     * 订阅有效期，单位为秒
+     */
+    expiry: number;
+    /**
+     * 订阅在线状态详情
+     */
+    details?: ISubscribeStatusDetail[];
+    /**
+    * 用户信息
+    * @since 5.10.1
+    */
+    userProfile?: IUserProfileInfo;
+}
+/**
+ * 在线状态信息
+ * @category Interface
+ * @since 5.9.8
+ */
+interface ISubscribeStatusDetail {
+    /**
+     * 状态变更时间
      */
-    private readonly ALLOW_FAILED_TIMES;
+    changeTime: number;
     /**
-     * 启动心跳计时器
+     * 状态值
      */
-    private checkAlive;
+    eventValue: number;
     /**
-     * 关闭连接
-     * @param inReconnect
+     * 平台
      */
-    protected abstract close(inReconnect: boolean, closeDB?: boolean): void;
+    platform: PlatformInfo;
+}
+/**
+ * 订阅关系服务端数据
+ */
+interface ISubscribeRelationServerData {
+    subUsers: {
+        subUserId: string;
+    }[];
+    subType: SubscribeType;
+    subTime: number;
+    expiry: number;
+    opType: SubscribeOperationType;
+}
+/**
+ * 订阅用户状态服务端数据
+ */
+interface ISubscribeUserStatusServerData {
     /**
-     * 完成一次 ping 过程，并返回响应状态码
-     * @param timeout 超时时间
+     * 服务端废弃字段
      */
-    protected abstract sendPing(timeout: number): Promise<ErrorCode>;
+    statusStr: string;
+    subUserId: string;
+    data: ISubData[];
+    subType: SubscribeType;
+}
+interface ISubData {
+    platformInfo: PlatformInfo;
+    value: OnlineStatus;
+    versionTime: number;
+}
+declare type SubscribeDataType = {
+    [SubscribeType.ONLINE_STATUS]: ISubscribeUserLocalOnlineData;
+    [SubscribeType.USER_PROFILE]: ISubscribeUserLocalProfileData;
+};
+interface ISubscribeLocalStore {
+    [SubscribeType.ONLINE_STATUS]: {
+        [userId: string]: SubscribeDataType[SubscribeType.ONLINE_STATUS];
+    };
+    [SubscribeType.USER_PROFILE]: {
+        [userId: string]: SubscribeDataType[SubscribeType.USER_PROFILE];
+    };
+}
+interface ISubscribeUserLocalBaseData {
     /**
-     * 业务层主动断开连接时调用
-     */
-    disconnect(closeDB?: boolean): Promise<void>;
+    * 订阅时间
+    */
+    subscribeTime: number;
     /**
-     * 清理重连计时器
-     */
-    private stopReconnectTimer;
-    private _getProtocol;
+    * 订阅有效期，单位为秒
+    */
+    expiry: number;
     /**
-     * 获取 CMP 列表
-     */
-    protected getCmpList(navi: INaviInfo, isTcp?: boolean): IServerAddressData[];
+    * 用户 ID
+    */
+    userId: string;
     /**
-     * 修改 CMP 权重
+     * 订阅类型
      */
-    protected updateCmpWeight(cmpUrl: string, isRise: boolean, isQuick?: boolean): void;
-    private clearCmpWeightCache;
+    subscribeType: SubscribeType;
 }
-
 /**
- * 查询错误码是否为服务下发的 disconnect 通知 status 所转换
- * @param code
- * @description 排除重定向 31006，因 disconnect 和 connAck 都包含元素可被转换为 31006
+ * 本地缓存的在线状态数据结构
  */
-declare const isDisconnectCode: (code: ErrorCode) => boolean;
+interface ISubscribeUserLocalOnlineData extends ISubscribeUserLocalBaseData {
+    /**
+    * 订阅在线状态
+    */
+    statusMap: {
+        -readonly [key in PlatformInfo]?: {
+            changeTime: number;
+            eventValue: number;
+        };
+    };
+}
 /**
- * 查询错误码是否为服务下发的 connAck status 所转换
- * @param code
- * @description 排除重定向 31006，因 disconnect 和 connAck 都包含元素可被转换为 31006
+ * 本地缓存的用户信息数据结构
  */
-declare const isConnnectAckCode: (code: ErrorCode) => boolean;
+interface ISubscribeUserLocalProfileData extends ISubscribeUserLocalBaseData {
+    /**
+    * 订阅用户信息
+    */
+    profile?: {
+        info: IUserProfileInfo;
+        version: number;
+    };
+    /**
+     * 是否已订阅(加此字段的原因是要缓存未订阅的数据)
+     */
+    isSubscribed: boolean;
+}
 
 /**
  * 进程内缓存数据
@@ -6418,6 +7207,30 @@ interface IEngine {
      * 测试代理
      */
     testProxy(proxy: IProxy, testHost: string): Promise<IResponse>;
+    /**
+     * 订阅用户状态事件
+     */
+    subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<IAsyncRes<string[]>>;
+    /**
+     *  取消订阅用户状态事件
+     */
+    unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<IAsyncRes<void>>;
+    /**
+     *  获取已订阅列表
+     */
+    getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
+    /**
+     *  获取指定用户的在线状态
+     */
+    getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
+    updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncRes<{
+        errorKey: string;
+    }>>;
+    getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProfileInfo[]>>;
+    getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
+    updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
+    getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
+    searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
     rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
         code: ErrorCode;
@@ -6496,10 +7309,25 @@ interface IUpdatedExpansion {
  * @category Interface
  */
 interface IDeletedExpansion {
+    /**
+     * 删除扩展 key 列表
+     */
     deletedKeys: string[];
+    /**
+     * 消息 UID
+     */
     messageUId: string;
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 频道 ID
+     */
     channelId: string;
 }
 /**
@@ -6507,7 +7335,13 @@ interface IDeletedExpansion {
  * @category Interface
  */
 interface IExpansionListenerData {
+    /**
+     * 更新扩展
+     */
     updatedExpansion?: IUpdatedExpansion;
+    /**
+     * 删除扩展
+     */
     deletedExpansion?: IDeletedExpansion;
 }
 /**
@@ -6525,10 +7359,20 @@ interface IIsValidExpansion {
 
 /**
  * typing信息
+ * @category Interface
  */
 interface ITypingUser {
+    /**
+     * 用户 ID
+     */
     userId: string;
+    /**
+     * 时间戳
+     */
     timestamp: number;
+    /**
+     * 消息类型
+     */
     messageType: string;
 }
 /**
@@ -6539,11 +7383,24 @@ interface ITypingInfo {
 }
 /**
  * typing通知消息接口
+ * @category Interface
  */
 interface ITypingMessage {
+    /**
+     * 目标 ID
+     */
     targetId: string;
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 频道 ID
+     */
     channelId?: string;
+    /**
+     * typing信息列表
+     */
     list: Array<ITypingUser>;
 }
 
@@ -6697,24 +7554,60 @@ interface IGroupMessageDeliverStatus {
 
 /**
 * 用户组变更数据
+* @category Interface
 */
 interface IUserGroupChangeData {
+    /**
+     * 会话标识
+     */
     conversation: IConversationIdentifier;
+    /**
+     * 用户组 ID 列表
+     */
     userGroupIds: string[];
 }
 /**
 * 频道和用户组关系变更数据
+* @category Interface
 */
 interface IChannelAndUserGroupChangeData {
+    /**
+     * 会话信息
+     */
     conversation: IConversationOption;
+    /**
+     * 超级群频道类型
+     */
     channelType: UltraGroupChannelType;
+    /**
+     * ID 列表
+     */
     userGroupIds: string[];
 }
+/**
+ * 超级群用户组状态数据
+ * @category Interface
+ */
 interface IUserGroupStatusInfo {
+    /**
+     * 用户组解散
+     */
     userGroupDisband?: IUserGroupChangeData[];
+    /**
+     * 用户被加入用户组
+     */
     userAdded?: IUserGroupChangeData[];
+    /**
+     * 用户被从用户组中移除
+     */
     userRemoved?: IUserGroupChangeData[];
+    /**
+     * 用户组绑定频道
+     */
     userGroupBindChannel?: IChannelAndUserGroupChangeData[];
+    /**
+     * 用户组解绑频道
+     */
     userGroupUnBindChannel?: IChannelAndUserGroupChangeData[];
 }
 
@@ -6805,94 +7698,27 @@ interface INaviContextInfo {
     reason: ConnectReason;
 }
 
-/**
- * 订阅关系信息
- * @since 5.9.8
- */
-interface ISubscribeRelationInfo {
-    /**
-     * 用户 ID
-     */
-    userId: string;
-    /**
-     * 订阅类型
-     */
-    subscribeType: SubscribeType;
-    /**
-     * 订阅时间
-     */
-    subscribeTime: number;
-    /**
-     * 订阅有效期，单位为秒
-     */
-    expiry: number;
-    /**
-     * 订阅状态
-     */
-    operationType: SubscribeOperationType;
-}
-/**
- * 订阅用户状态信息
- * @since 5.9.8
- */
-interface ISubscribeUserStatusInfo {
-    /**
-     * 用户 ID
-     */
-    userId: string;
-    /**
-     * 订阅类型
-     */
-    subscribeType: SubscribeType;
-    /**
-     * 订阅时间
-     */
-    subscribeTime: number;
-    /**
-     * 订阅有效期，单位为秒
-     */
-    expiry: number;
-    /**
-     * 订阅状态详情
-     */
-    details?: ISubscribeStatusDetail[];
-}
-/**
- * 在线状态信息
- * @since 5.9.8
- */
-interface ISubscribeStatusDetail {
-    /**
-     * 状态变更时间
-     */
-    changeTime: number;
-    /**
-     * 状态值
-     */
-    eventValue: number;
-    /**
-     * 平台
-     */
-    platform: PlatformInfo;
-}
-
 /**
  * 定义已废弃，请使用 `IRemoveChatroomEntries` 替换
  * @deprecated
+ * @category Type
  */
 declare type IRemoveChatRoomEntries = IRemoveChatroomEntries;
 /**
  * 定义已废弃，请使用 `IChatroomEntry` 替换
+ * @category Type
  * @deprecated
  */
 declare type IChatRoomEntry = IChatroomEntry;
 /**
  * 定义已废弃，请使用 `IChatroomEntries` 替换
+ * @category Type
  * @deprecated
  */
 declare type IChatRoomEntries = IChatroomEntries;
 /**
  * 定义已废弃，请使用 `IRemoveChatroomEntry` 替换
+ * @category Type
  * @deprecated
  */
 declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
@@ -6960,7 +7786,7 @@ declare abstract class BasicReporter {
     private _sendLogs2Realtime;
     /**
      * 实时日志上报
-     * @override IndexDBReporter 重载此方法，增加同设备多页面多端时进程竞争检测
+     * IndexDBReporter 重载此方法，增加同设备多页面多端时进程竞争检测
      */
     protected realtimeReport(uri: string, level: LogL, itv: number): Promise<void>;
     protected abstract compressLogs(logs: ILogData[]): Promise<{
@@ -7002,7 +7828,7 @@ declare class IndexDBReporter extends BasicReporter {
     clientReportLevel?: EnableLogL | undefined);
     protected send(req: IRequest): Promise<IResponse>;
     /**
-     * @override 重写实现
+     * 实时日志上报启动
      */
     checkStart(navi: INaviInfo): Promise<void>;
     protected compressLogs(logs: ILogData[]): Promise<{
@@ -7052,7 +7878,13 @@ declare const transcsv: (log: ILogData) => string;
  * @category Interface
  */
 interface IConversationIdentifier {
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 会话 Id
+     */
     targetId: string;
 }
 /**
@@ -7060,8 +7892,17 @@ interface IConversationIdentifier {
  * @category Interface
  */
 interface IConversationOption {
+    /**
+     * 会话类型
+     */
     conversationType: ConversationType;
+    /**
+     * 会话 Id
+     */
     targetId: string;
+    /**
+     * 频道 Id 字符串类型，不能包含 _ , 长度不能超过 20
+     */
     channelId?: string;
 }
 interface IServerRTCRoomEntry {
@@ -7226,7 +8067,8 @@ interface IWatcher {
     syncReadStatus?: (data: ISyncReadStatusData) => void;
     subscribedUserStatusChange?: (data: ISubscribeUserStatusInfo[]) => void;
     subscribedRelationChange?: (data: ISubscribeRelationInfo[]) => void;
-    syncSubscribedUserStatusFinished?: () => void;
+    syncSubscribedUserStatusFinished?: (subscribeType: SubscribeType) => void;
+    ownUserProfileChanged?: (userProfile: IUserProfileInfo) => void;
 }
 interface IAPIContextOption {
     /**
@@ -7541,6 +8383,7 @@ declare class APIContext {
     private _subscribedUserStatusChange;
     private _subscribedRelationChange;
     private _syncSubscribedUserStatusFinished;
+    private _ownUserProfileChanged;
     /**
      * rtc 数据变更通知 pluginContext
      */
@@ -7653,6 +8496,10 @@ declare class APIContext {
     sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
     /**
      * 获取群组消息已读列表
+     * 已读回执目前 3 个版本 有 naviInfo.grpRRVer字段区分。
+     * 0：为目前有公有先支持版本，调用 sendReadReceiptResponseV2
+     * 1. 为 v2 版本，仅供 beem 使用目前公有云已废弃
+     * 3. 为 v4 版本，目前仅海外 IMkit 使用
      * @param targetId
      * @param messageUIds
      */
@@ -8135,6 +8982,15 @@ declare class APIContext {
      *  获取指定用户的在线状态
      */
     getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
+    private _isEnableUserProfile;
+    updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncRes<{
+        errorKey: string;
+    }>>;
+    getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProfileInfo[]>>;
+    getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
+    updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
+    getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
+    searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
     /**
      * 删除所有会话
     */
@@ -8236,6 +9092,7 @@ declare class APIContext {
     }>>;
     searchMessageByContentAndMessageType(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, messageTypes: string[], channelId?: string): IPromiseResult<{
         messages: IReceivedMessage[];
+        count: number;
     }>;
     searchMessagesByUser(conversationType: ConversationType, targetId: string, userId: string, timestamp: number, count?: number, channelId?: string): Promise<IAsyncRes<{
         messages: IReceivedMessage[];
@@ -8664,7 +9521,8 @@ interface IEngineWatcher extends IConnectionListener {
     syncReadStatus: (data: ISyncReadStatusData) => void;
     subscribedUserStatusChange?: (data: ISubscribeUserStatusInfo[]) => void;
     subscribedRelationChange?: (data: ISubscribeRelationInfo[]) => void;
-    syncSubscribedUserStatusFinished?: () => void;
+    syncSubscribedUserStatusFinished?: (subscribeType: SubscribeType) => void;
+    ownUserProfileChanged?: (data: IUserProfileInfo) => void;
 }
 /**
  * 引擎定义
@@ -9330,6 +10188,7 @@ declare abstract class AEngine {
     }>;
     abstract searchMessageByContentAndMessageType(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, messageTypes: string[], channelId?: string): IPromiseResult<{
         messages: IReceivedMessage[];
+        count: number;
     }>;
     /**
      * 按用户ID搜索会话内的消息
@@ -9522,6 +10381,14 @@ declare abstract class AEngine {
      *  获取指定用户的在线状态
      */
     abstract getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
+    abstract updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncRes<{
+        errorKey: string;
+    }>>;
+    abstract getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProfileInfo[]>>;
+    abstract getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
+    abstract updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
+    abstract getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
+    abstract searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
     /**
      * 获取本地指定时间戳前后 N 条消息方法
      * @param conversation
@@ -9671,6 +10538,9 @@ interface IErrorCodeKey {
     afterCount: number;
     conversationList: number;
     conversationTypeNotSupport: number;
+    profile: number;
+    userProfileVisibility: number;
+    uniqueId: number;
 }
 
 declare const ErrorCodeMap: IErrorCodeKey;
@@ -9837,6 +10707,10 @@ declare const appendUrl: (url: string, query?: {
     [key: string]: string | number | null;
 } | undefined) => string;
 
+/**
+ * 事件监听器
+ * @category Type
+ */
 declare type IEventListener = (...args: any[]) => void;
 declare class EventEmitter {
     private readonly _map;
@@ -10126,6 +11000,11 @@ declare function fixUrlProtocol(url: string, protocol?: EConnectProtocol): strin
  */
 declare function getMessageUIdHash(messageUId?: string): number;
 declare const getMinionURL: (naviInfo: INaviInfo, logger: BasicLogger) => string;
+declare function updateMentionedInfo(content: any, mentionedUserIdList: string[] | undefined, mentionedType: 1 | 2 | undefined): {
+    userIdList: any;
+    type: any;
+    mentionedContent: any;
+};
 
 declare function httpRequest(options: IRequest): SuspendablePromise<IResponse>;
 
@@ -10176,6 +11055,10 @@ declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusI
  * 补齐订阅平台状态
  */
 declare const completeSubscriptionPlatformStatus: (status: ISubscribeStatusDetail[]) => ISubscribeStatusDetail[];
+/**
+ * 将收到的用户信息转换为本地数据结构
+ */
+declare const transformUserProfiles: (userId: string, userProfiles: IServerProfileInfo[], userExtProfiles: IServerProfileInfo[]) => IUserProfileInfo;
 
 /**
  * Navi 缓存数据有效时长，单位毫秒
@@ -10227,6 +11110,10 @@ declare const MAX_MESSAGE_EXPANSION_KEY_LENGTH = 32;
 declare const MAX_MESSAGE_EXPANSION_VAL_LENGTH: number;
 declare const STATIC_CONFIG_KEY = "cd4936151214ce45dc1d12673a59d94c";
 declare const STATIC_CONFIG_IV = "51ad078e5eb17a91";
+/**
+ * RC:chrmKVNotiMsg 消息中携带的附加信息
+ */
+declare const MAX_CHATROOM_NOTIFICATION_EXTRA_LENGTH: number;
 declare const SEND_MESSAGE_TYPE_OPTION: {
     [key: string]: {
         isCounted: boolean;
@@ -10266,6 +11153,14 @@ declare const RC_DEFAULT_USER = "rongcloudsystem";
  * 已读回执缓存时间
  */
 declare const READ_RECEIPT_CATCH_TIME: number;
+/**
+ * 订阅用户资料的有效时间
+ */
+declare const SUBSCRIBE_USER_PROFILE_VALID_TIME: number;
+/**
+ * 非订阅用户资料的有效时间
+ */
+declare const NON_SUBSCRIBE_USER_PROFILE_VALID_TIME: number;
 /**
  * localStorage 中的 key 值
  */
@@ -10519,4 +11414,4 @@ declare type AbsCodec<T> = Codec<T>;
  */
 declare const version: string;
 
-export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BaseCloudController, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, ErrorCodeMap, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICloudController, ICombineV2MessageContent, ICombinedMessage, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IFirstUnreadMessageInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IMRTRConfig, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerAddressData, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUploadTask, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, InterruptionLevel, InvokerType, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OnlineStatus, OperateStatus, PlatformInfo, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, READ_RECEIPT_CATCH_TIME, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, SubscribeOperationType, SubscribeType, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, VERSION, ValidatorManage, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, completeSubscriptionPlatformStatus, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getMinionURL, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversation, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, isValidTargetId, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, unInitStatisticDB, urlCenter, usingCppEngine, validate, validators, version };
+export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BaseCloudController, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, ErrorCodeMap, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICloudController, ICombineV2MessageContent, ICombinedMessage, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IFirstUnreadMessageInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IMRTRConfig, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerAddressData, IServerConversationStatus, IServerProfileInfo, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ISubData, ISubscribeLocalStore, ISubscribeRelationInfo, ISubscribeRelationServerData, ISubscribeStatusDetail, ISubscribeUserLocalBaseData, ISubscribeUserLocalOnlineData, ISubscribeUserLocalProfileData, ISubscribeUserStatusInfo, ISubscribeUserStatusServerData, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUploadTask, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserProfileServerData, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, InterruptionLevel, InvokerType, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_CHATROOM_NOTIFICATION_EXTRA_LENGTH, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NON_SUBSCRIBE_USER_PROFILE_VALID_TIME, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OnlineStatus, OperateStatus, PlatformInfo, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, READ_RECEIPT_CATCH_TIME, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SUBSCRIBE_USER_PROFILE_VALID_TIME, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, SubscribeDataType, SubscribeOperationType, SubscribeType, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, UserProfileVisibility, VERSION, ValidatorManage, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, completeSubscriptionPlatformStatus, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getMinionURL, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversation, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, isValidTargetId, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, transformUserProfiles, unInitStatisticDB, updateMentionedInfo, urlCenter, usingCppEngine, validate, validators, version };