@rongcloud/engine 5.7.0 → 5.7.2

package/index.d.ts

@@ -1391,7 +1391,8 @@ declare enum LogTagId {
     P_REGTYP_E = "P-regtype-E",
     L_GET_NAVI_T = "L-get_navi-T",
     L_GET_NAVI_R = "L-get_navi-R",
-    L_GET_NAVI_O = "L-get_navi-O",
+    L_REQUEST_T = "L-request-T",
+    L_REQUEST_R = "L-request-R",
     L_PARSE_NAVI_E = "L-parse_navi-E",
     L_ENV_S = "L-Env-S",
     L_GET_INDEX_NAVI_S = "L-get_index_navi-S",
@@ -1449,6 +1450,7 @@ declare enum LogTagId {
     L_UNKNOWN_TOPIC_E = "L_UNKNOWN_TOPIC_E",
     L_RECV_RMTP_O = "L_RECV_RMTP_O",
     L_RECV_RMTP_E = "L_RECV_RMTP_E",
+    L_RECV_S_NTF_O = "L-recv_s_ntf_O",
     /** 版本号上报 */
     L_VER_REPORT_T = "L-VER_REPORT-T",
     /** 版本号上报结果 */
@@ -1472,6 +1474,37 @@ declare enum ChatroomUserChangeType {
     JOIN = 1
 }
 
+/**
+ * 发送状态
+ * @category Enum
+ */
+declare enum SentStatus {
+    /**
+     * 发送中。
+     */
+    SENDING = 10,
+    /**
+     * 发送失败。
+     */
+    FAILED = 20,
+    /**
+     * 已发送。
+     */
+    SENT = 30,
+    /**
+     * 对方已接收。
+     */
+    RECEIVED = 40,
+    /**
+     * 对方已读。
+     */
+    READ = 50,
+    /**
+     * 对方已销毁。
+     */
+    DESTROYED = 60
+}
+
 declare enum StoreKeys {
     /**
      * Navi 数据缓存，暂未使用
@@ -1856,13 +1889,13 @@ interface IReceivedMessage {
     */
     receivedStatus: number;
     /**
-     * CPP 独有字段 消息本地 ID
+     * 消息本地 ID, web 端由 lib 内生成， PC 端由协议栈数据库生成自增ID
     */
     messageId?: number;
     /**
-     * CPP 独有字段 消息发送状态
+     * 消息发送状态， web 端由 lib 内根据消息状态设置值为 发送中、已发送和发送失败 ，PC 端由协议栈自动维护或用户自己设置
     */
-    sentStatus?: number;
+    sentStatus?: SentStatus;
     /**
      * 已读回执信息(导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined)
      */
@@ -2118,6 +2151,37 @@ interface IInsertMsgOptions {
     expansionMsg?: string;
     channelId: string;
 }
+interface IInsertMessage {
+    conversationType: number;
+    targetId: string;
+    channelId: string;
+    messageDirection: number;
+    messageType: string;
+    content: any;
+    messageUId: string;
+    senderUserId: string;
+    sentStatus?: number;
+    sentTime?: number;
+    disableNotification?: boolean;
+    canIncludeExpansion?: boolean;
+    expansion?: {
+        [key: string]: any;
+    } | null;
+    receivedStatus?: number;
+    /**
+     * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
+     */
+    isUnread?: boolean;
+    /**
+     * 消息搜索关键字
+     */
+    searchContent?: string;
+    /**
+     * 来源
+     */
+    source?: string;
+    isMentioned?: boolean;
+}
 interface ISendExMsgOptions {
     channelId: string;
     conversationType: ConversationType;
@@ -3558,7 +3622,7 @@ declare abstract class AConnectionMgr {
      * 关闭连接
      * @param inReconnect
      */
-    protected abstract close(inReconnect: boolean): void;
+    protected abstract close(inReconnect: boolean, closeDB?: boolean): void;
     /**
      * 完成一次 ping 过程，并返回响应状态码
      * @param timeout 超时时间
@@ -3567,7 +3631,7 @@ declare abstract class AConnectionMgr {
     /**
      * 业务层主动断开连接时调用
      */
-    disconnect(): Promise<void>;
+    disconnect(closeDB?: boolean): Promise<void>;
     /**
      * 清理重连计时器
      */
@@ -3787,7 +3851,7 @@ interface IEngine {
     /**
      * 断开连接
      */
-    disconnect(): void;
+    disconnect(closeDB?: boolean): void;
     /**
      * 拉取用户级配置数据
      */
@@ -4977,7 +5041,7 @@ declare class APIContext {
     getServerTime(): number;
     getDeviceId(): string;
     getCurrentUserId(): string;
-    getConnectionStatus(): ConnectionStatus;
+    getConnectionStatus(): RCConnectionStatus;
     get token(): string;
     refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
     /**
@@ -4994,7 +5058,7 @@ declare class APIContext {
         设置 reconnectKickEnable 为 true 时，SDK 重连的时候发现此时已有别的设备连接成功，不再强行踢出已有设备，而是踢出重连设备。
      */
     connect(token: string, reconnectKickEnable: boolean, traceId: string): Promise<IConnectResult>;
-    disconnect(): Promise<void>;
+    disconnect(closeDB?: boolean): Promise<void>;
     reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
     private _getTokenWithoutNavi;
     /**
@@ -5490,6 +5554,11 @@ declare class APIContext {
      * 向本地插入一条消息，不发送到服务器
     */
     insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): Promise<IAsyncRes<IReceivedMessage>>;
+    batchInsertMessage(messages: IInsertMessage[], checkDuplicate: boolean): Promise<IAsyncRes<boolean>>;
+    /**
+     * 获取会话所有消息数
+     */
+    getMessageCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
     /**
      * 删除本地消息
     */
@@ -5583,6 +5652,10 @@ declare class APIContext {
     getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
     clearData(): Promise<IAsyncRes<boolean>>;
     createLogger(id: string, type: LogType): BasicLogger;
+    /**
+     *  设置融云消息重排开关
+     */
+    setCheckDuplicateMessage(enableCheck: boolean): Promise<IAsyncRes<boolean>>;
     rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
         code: ErrorCode;
         buffer?: Uint8Array;
@@ -5735,7 +5808,7 @@ declare class PluginContext {
     /**
      * 获取当前连接状态
      */
-    getConnectionStatus(): ConnectionStatus;
+    getConnectionStatus(): RCConnectionStatus;
     getDeviceId(): string;
     /**
      * 发送消息
@@ -6257,8 +6330,9 @@ declare abstract class AEngine {
     abstract getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
     /**
      * 断开连接
+     * @param closeDB 是否关闭数据库，默认为 true，仅 Electron 平台有效
      */
-    abstract disconnect(): Promise<void>;
+    abstract disconnect(closeDB?: boolean): Promise<void>;
     /**
      * 拉取用户级配置数据
      */
@@ -6562,6 +6636,16 @@ declare abstract class AEngine {
      * 向本地插入一条消息，不发送到服务器
     */
     abstract insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
+    /**
+     * 向本地批量插入消息
+     * @param messages
+     * @param checkDuplicate
+     */
+    abstract batchInsertMessage(messages: IInsertMessage[], checkDuplicate: boolean): IPromiseResult<boolean>;
+    /**
+     * 查询会话消息数
+    */
+    abstract getMessageCount(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<number>;
     /**
      * 删除本地消息
     */
@@ -6716,6 +6800,10 @@ declare abstract class AEngine {
      * 获取应用主进程信息，仅限 Electron 平台可用
      */
     abstract getMainProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     *  设置融云消息重排开关
+     */
+    abstract setCheckDuplicateMessage(enableCheck: boolean): IPromiseResult<boolean>;
     /**
      * RTC 通用调用接口
      * 在非 Comet 协议下，入参 sourceData 应为 ArrayBuffer 数据，返回结果为 Uint8Array 数据
@@ -7317,12 +7405,17 @@ declare const CPP_PROTOCAL_MSGTYPE_OPTION: {
  * 状态消息(不存储，不计数，并且上线后不会拉取离线的状态消息)
  */
 declare const STATUS_MESSAGE: string[];
-declare const REAT_TIME_LOG_SIZE = 500;
+declare const REAT_TIME_LOG_SIZE: number;
 declare const DB_LOG_MAX_SIZE = 100000;
 declare const DB_LOG_FLUSH_FREQUENCY = 3000;
 declare const ONE_LOG_SIZE_MAX = 1000;
-/** 日志上报域名 */
-declare const LOG_REPORT_URI = "logcollection.ronghub.com";
+/** 日志上报默认策略 */
+declare const DEFAULT_LOG_POLICY: {
+    url: string;
+    level: number;
+    itv: number;
+    times: number;
+};
 /** SDK 版本号 */
 declare const VERSION: string;
 /**
@@ -7342,4 +7435,4 @@ declare type AbsCodec<T> = Codec<T>;
  */
 declare const version: string;
 
-export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AssertRules, BasicLogger, BasicNavi, BasicReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, Codec, CodecPBMaps, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EnableLogL, ErrorCode, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, 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, INaviCache, INaviInfo, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, 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, RCConnectionStatus, 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, VERSION, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, deInitLogDB, logger as engineLogger, forEach, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, initLogDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, transcsv, usingCppEngine, validate, version };
+export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AssertRules, BasicLogger, BasicNavi, BasicReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, Codec, CodecPBMaps, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DEFAULT_LOG_POLICY, DelayTimer, EnableLogL, ErrorCode, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, 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, INaviCache, INaviInfo, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, 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, 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, RCConnectionStatus, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, SentStatus, StoreKeys, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VERSION, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, deInitLogDB, logger as engineLogger, forEach, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, initLogDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, transcsv, usingCppEngine, validate, version };