@rongcloud/engine 5.6.1-beem-alpha.5 → 5.6.1

package/index.d.ts

@@ -403,23 +403,23 @@ declare class IndexDBLogger extends BasicLogger {
  */
 interface ILogDB {
     /**
-     * 获取实时日志上报的时间戳记录
+     * 获取实时日志上报的时间戳记录。
+     * 时间戳不以人为维度记录，避免换账户登录时，一次拉取巨量的历史日志。
      */
-    getTimestamp4RealtimeLog(userId: string): Promise<number>;
+    getTimestamp4RealtimeLog(): number;
     /**
      * 设置实时日志上报的时间戳记录
-     * @param userId 当前用户 ID
      * @param timestamp
      */
-    setTimestamp4RealtimeLog(userId: string, timestamp: number): Promise<void>;
+    setTimestamp4RealtimeLog(timestamp: number): void;
     /**
      * 根据时间戳和日志等级获取全量日志
      * @param startTime
      * @param endTime
      * @param level
-     * @param includeStatistics 是否包含质量统计日志
+     * @param realtimeReport 是否实时上报。实时上报时，需要取质量数据日志
      */
-    getLogs(startTime: number, endTime: number, level: LogL, includeStatistics: boolean): Promise<{
+    getLogs(startTime: number, endTime: number, level: LogL, realtimeReport: boolean): Promise<{
         logs: ILogData[];
         dbReady: boolean;
     }>;
@@ -1148,7 +1148,11 @@ declare enum ConnectionStatus {
     /**
      * 证书过期，SDK不会重连
      */
-    RC_LICENSE_EXPIRED = 31030
+    RC_LICENSE_EXPIRED = 31030,
+    /**
+     * Token 错误。
+     */
+    RC_CONN_USER_OR_PASSWD_ERROR = 31004
 }
 
 /**
@@ -1328,6 +1332,14 @@ declare enum MessageType {
      * 撤回消息
     */
     RECALL = "RC:RcCmd",
+    /**
+     * 撤回通知消息
+     *
+     * 融云定义了 ObjectName 为 `RC:RcNtf` 的撤回通知消息
+     *
+     * PC: recallMessage 会替换聊天记录中的原始消息为一条 objectName 为 `RC:RcNtf` 的撤回通知消息
+     */
+    RECALL_NOTIFICATION_MESSAGE = "RC:RcNtf",
     /**
      * 已读同步状态消息
     */
@@ -1515,7 +1527,6 @@ declare enum LogTagId {
     L_DESTROY_O = "L_DESTROY_O",
     A_CONNECT_T = "A-connect-T",
     A_CONNECT_R = "A-connect-R",
-    A_CONNECT_S = "A-connect-S",
     A_DISCONNECT_O = "A-disconnect-O",
     A_RECONNECT_T = "A-reconnect-T",
     A_RECONNECT_R = "A_RECONNECT_R",
@@ -1532,6 +1543,10 @@ declare enum LogTagId {
      * 用于保留迁移前的日志，后续删除
      */
     O = "L-original-O",
+    /**
+     * 测试日志，不入库，因此不需要关注 TAG，避免调试 TAG 膨胀
+     */
+    T = "L-TEST-O",
     /** 插件安装 */
     L_INSTALL_PLUGIN_T = "L-INSTALL_PLUGIN-T",
     /** 插件安装结果 */
@@ -1545,15 +1560,20 @@ declare enum LogTagId {
     L_PULL_MSG_T = "L-pull_msg-T",
     L_PULL_MSG_R = "L-pull_msg-R",
     L_PULL_MSG_O = "L-pull_msg-O",
-    A_PULL_MSG_O = "A-pull_msg-O",
     L_PULL_ULTRA_MSG_T = "L-pull_ultra_msg-T",
     L_PULL_ULTRA_MSG_R = "L-pull_ultra_msg-R",
     L_PULL_CHATROOM_KV_T = "L-pull_chatroom_kv-T",
     L_PULL_CHATROOM_KV_R = "L-pull_chatroom_kv-R",
     L_PULL_CHATROOM_MSG_T = "L-pull_chatroom_msg-T",
     L_PULL_CHATROOM_MSG_R = "L-pull_chatroom_msg-R",
-    L_RECEIVE_MSG_O = "L-receive_msg-O",
-    L_RECEIVE_SYNC_MSG_O = "L-receive_sync_msg-O",
+    /**
+     * 接收到多端同步消息
+     */
+    L_RECV_MULTI_SYNC_MSG_O = "L-recv_multi_sync_msg-O",
+    /**
+     * 接收到直发消息
+     */
+    L_RECV_S_MSG_O = "L-recv_s_msg-O",
     A_DELETE_MESSAGES_S = "A-delete_messages-S",
     P_DELETE_MSG_S = "P-delete_msg-S",
     L_PULL_CONVERSATION_S = "L-pull_conversation-S",
@@ -1585,9 +1605,12 @@ declare enum LogTagId {
     A_GET_HISTORY_MSG_R = "A-get_history_msg-R",
     L_GET_HISTORY_MSG_T = "L-get_history_msg-T",
     L_GET_HISTORY_MSG_R = "L-get_history_msg-R",
+    A_GET_PRIVATE_MESSAGE_DELIVER_TIME_E = "A-get_privage_message_deliver_time-E",
+    A_GET_GROUP_MESSAGE_DELIVER_LIST_E = "A-get_group_message_deliver_list-E",
     A_CALLBACK_O = "A-callback-O",
     A_CALLBACK_E = "A-callback-E",
     L_CALLBACK_E = "L-callback-E",
+    A_GET_TOP_CONVERSATION_LIST_E = "A-get_top_conversation_list-E",
     /**
      * PB 数据编码错误
      */
@@ -1616,7 +1639,12 @@ declare enum LogTagId {
     /** 版本号上报 */
     L_VER_REPORT_T = "L-VER_REPORT-T",
     /** 版本号上报结果 */
-    L_VER_REPORT_R = "L-VER_REPORT-R"
+    L_VER_REPORT_R = "L-VER_REPORT-R",
+    /** 跨进程阻塞调用 */
+    L_CALL_MAIN_SYNC_O = "L_CALL_MAIN_SYNC_O",
+    /** 未知的通知 */
+    L_UNSUPPORT_NTF_FROM_MAIN_E = "L_UNSUPPORT_NTF_FROM_MAIN_E",
+    A_SET_MSG_CONTENT_O = "A_SET_MSG_CONTENT_O"
 }
 
 /**
@@ -2419,6 +2447,13 @@ interface IUltraUnreadMsg {
     mentionedType?: number;
 }
 
+interface IMentionInfo {
+    type: MentionedType;
+    /**
+     * 被 @ 的用户 Id 列表，仅在 `type` 为 `2` 时有效
+     */
+    userIdList: string[];
+}
 /**
  * 从服务器拉取到的会话数据结构
  * @category Interface
@@ -2454,16 +2489,7 @@ interface IReceivedConversation {
     /**
      * 消息中的 @ 数据，仅在 `conversationType` 为 `ConversationType.GROUP` 时有效
      */
-    mentionedInfo?: {
-        /**
-         * `@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人`
-         */
-        type: 1 | 2;
-        /**
-         * 被 @ 的用户 Id 列表，仅在 `type` 为 `2` 时有效
-         */
-        userIdList: string[];
-    } | null;
+    mentionedInfo?: IMentionInfo | null;
     /**
      * 会话免打扰状态
      * @description
@@ -3866,7 +3892,7 @@ interface IEngine {
     /**
      * 获取消息
      */
-    getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
+    getMessage(messageId: number | string): IPromiseResult<IReceivedMessage>;
     /**
      * 设置消息内容
      */
@@ -3938,7 +3964,7 @@ interface IEngine {
     /**
      * 无差别获取本地置顶列表
      */
-    getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
      * 获取单个群聊会话 @ 消息未读数
      */
@@ -4189,24 +4215,44 @@ interface IEndRoomPKOptions {
 /**
  * 消息送达相关接口
  */
+/**
+ * 送达的用户信息
+ * @hidden
+ */
 interface IDeliveredUser {
     time: number;
     userId: string;
 }
+/**
+ * 获取群组消息送达的状态信息
+ * @hidden
+ */
 interface IGroupMessageDeliverInfo {
     totalCount: number;
     list: IDeliveredUser[];
 }
+/**
+ * 单聊消息送达通知数据
+ * @hidden
+ */
 interface IMessageDeliver {
     deliverTime: number;
     messageUId: string;
     objectName: string;
     targetId: string;
 }
+/**
+ * 群组消息送达通知数据信息
+ * @hidden
+ */
 interface IGroupMessageDeliveredStatusInfo {
     MessageUId: string;
     deliveryCount: number;
 }
+/**
+ * 群组消息送达通知数据
+ * @hidden
+ */
 interface IGroupMessageDeliverStatus {
     totalCount: number;
     list: IGroupMessageDeliveredStatusInfo[];
@@ -4387,7 +4433,7 @@ declare class IndexDBReporter extends BasicReporter {
  * 初始化 DB 模块，按 APPKEY 分库，后续需要将日志与业务数据库也分开
  * @param appkey
  * @param logger
- * @param expireTime 日志有效期，单位 `h`，默认为 `72h`
+ * @param expireTime 日志有效期，单位 `h`，默认为 `168h`
  */
 declare const initLogDB: (appkey: string, logger: ILogger, expireTime?: number) => void;
 /**
@@ -5095,7 +5141,7 @@ interface IAPIContextOption {
      */
     __reportLogLevel?: EnableLogL;
     /**
-     * IndexDB 数据库内的日志有效期，单位为小时，默认 IndexDB 内日志数据有效期 72 小时，有效值为 `24` - `168`
+     * IndexDB 数据库内的日志有效期，单位为小时，有效值为 `24` - `168`，默认 IndexDB 内日志数据有效期 168 小时
      */
     logExpireTime?: number;
 }
@@ -5701,7 +5747,7 @@ declare class APIContext {
     /**
      * 获取所有本地置顶列表
      */
-    getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
     getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
     /**
       * 获取所有群聊会话 @ 消息未读数
@@ -5836,7 +5882,7 @@ declare class APIContext {
     /**
      * 获取本地消息
     */
-    getMessage(messageId: number): Promise<IAsyncRes<IReceivedMessage>>;
+    getMessage(messageId: number | string): Promise<IAsyncRes<IReceivedMessage>>;
     /**
      * 设置消息内容
     */
@@ -6361,7 +6407,6 @@ declare abstract class AEngine implements IEngine {
      */
     registerRTCSignalingListener(listener: ((buffer: Uint8Array) => void) | undefined): void;
     abstract requestNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
-    abstract updateNaviInfo(naviInfo: INaviInfo): void;
     /**
      * 为非 engine 包创建 logger 工具实例
      */
@@ -6897,7 +6942,7 @@ declare abstract class AEngine implements IEngine {
     /**
      * 获取消息
     */
-    abstract getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
+    abstract getMessage(messageId: number | string): IPromiseResult<IReceivedMessage>;
     /**
      * 设置消息内容
     */
@@ -7002,7 +7047,7 @@ declare abstract class AEngine implements IEngine {
     /**
      * 无差别获取本地置顶列表
      */
-    abstract getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    abstract getTopConversationList(conversationTypes: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
      * 获取单个群聊会话 @ 消息未读数
      */
@@ -7647,4 +7692,4 @@ declare type AbsCodec<T> = Codec<T>;
  */
 declare const version: string;
 
-export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, BasicLogger, BasicReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, Codec, CodecPBMaps, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EnableLogL, ErrorCode, EventEmitter, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBigdataLogInit, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IInitBigDataOption, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogExtensions, ILogInfo, ILogInit, ILogger, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IOSInfo, IOperateStatusNotify, IPluginGenerator, IProcessInfo, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, RTCKeyMaps as InnerRTCKeyMaps, ItypingStateListener, KVString, LOG_REPORT_URI, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, StoreKeys, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, deInitLogDB, logger as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, initLogDB, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, transcsv, usingCppEngine, validate, version };
+export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, BasicLogger, BasicReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, Codec, CodecPBMaps, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EnableLogL, ErrorCode, EventEmitter, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBigdataLogInit, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IInitBigDataOption, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogExtensions, ILogInfo, ILogInit, ILogger, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IOSInfo, IOperateStatusNotify, IPluginGenerator, IProcessInfo, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, RTCKeyMaps as InnerRTCKeyMaps, ItypingStateListener, KVString, LOG_REPORT_URI, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, StoreKeys, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, deInitLogDB, logger as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, initLogDB, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, transcsv, usingCppEngine, validate, version };