@rongcloud/engine 5.9.2 → 5.9.3

package/index.d.ts

@@ -617,10 +617,6 @@ interface ILogData {
      * 日志标签，如 `L-INIT-O`
      */
     tag: string;
-    /**
-     * logger 实例 Id，用于确定日志由谁埋点，如 `RCEngien` 为 engine 包埋点日志
-     */
-    loggerId: string;
     /**
      * 日志生成时间
      */
@@ -645,6 +641,10 @@ interface ILogData {
      * 事务跟踪 ID
      */
     traceId?: string;
+    /**
+     * logger 实例 Id，用于确定日志由谁埋点，如 `RCEngien` 为 engine 包埋点日志
+     */
+    loggerId?: string;
 }
 
 /**
@@ -2327,7 +2327,8 @@ declare enum LogTagId {
     L_CLOUD_SET_CACHE_O = "L-cloud_set_cache-O",
     L_CLOUD_GET_CACHE_O = "L-cloud_get_cache-O",
     L_CLOUD_MSG_NTF_O = "L-cloud_msg_ntf-O",
-    L_CLOUD_SET_AREA_CODE_O = "L-cloud_set_area_code-O"
+    L_CLOUD_SET_AREA_CODE_O = "L-cloud_set_area_code-O",
+    L_CLOUD_SET_MRTR_O = "L-cloud_set_mrtr-O"
 }
 
 /** 统计数据标签 */
@@ -2341,7 +2342,10 @@ declare enum StatisticsTag {
     IM_NETWORK_CHANGE = "IM-stats_network_change-S",
     /** 云控配置埋点 */
     L_CLOUD_INFO_FETCH_T = "L-cloud_info_fetch-T",
-    L_CLOUD_INFO_FETCH_R = "L-cloud_info_fetch-R"
+    L_CLOUD_INFO_FETCH_R = "L-cloud_info_fetch-R",
+    /** 消息延时率埋点  */
+    IM_MSG_SEND = "IM-msg_send-S",
+    IM_MSG_RECEIVE = "IM-msg_receive-S"
 }
 
 /**
@@ -2877,6 +2881,29 @@ interface ISyncReadStatusData extends IConversationOption {
      */
     timestamp: number;
 }
+/**
+ * 消息的接收状态详情
+ * 该字段只适用 Electron 平台，只有 isRetrieved 只对 web 平台有效
+ * @since 5.9.3
+ */
+interface IReceivedStatusInfo {
+    /**
+     *  是否已读取的状态
+     */
+    isRead?: boolean;
+    /**
+     * 是否已被收听的状态
+     */
+    isListened?: boolean;
+    /**
+     * 文件是否已经下载的状态
+     */
+    isDownload?: boolean;
+    /**
+     * 是否已被收取过的状态
+     */
+    isRetrieved?: boolean;
+}
 /**
  * 从服务端接收到的消息数据
  * @category Interface
@@ -2971,8 +2998,15 @@ interface IReceivedMessage {
     } | null;
     /**
      * 消息接收状态
+     * 只能表示单一状态，推荐使用 receivedStatusInfo 来判断接收消息状态
+     * @deprecated
     */
     receivedStatus: number;
+    /**
+     * 消息接收状态详情
+     * 推荐使用, receivedStatusInfo 值更详细，能同时表示多个接收状态
+     */
+    receivedStatusInfo: IReceivedStatusInfo;
     /**
      * 消息本地 ID, web 端由 lib 内生成， PC 端由协议栈数据库生成自增ID
     */
@@ -3238,6 +3272,7 @@ interface IInsertMsgOptions {
     content: any;
     messageDirection: number;
     readStatus?: number;
+    receivedStatusInfo?: IReceivedStatusInfo;
     sentStatus?: number;
     sentTime?: number;
     searchContent?: string;
@@ -3265,6 +3300,7 @@ interface IInsertMessage {
         [key: string]: any;
     } | null;
     receivedStatus?: number;
+    receivedStatusInfo?: IReceivedStatusInfo;
     /**
      * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
      */
@@ -6479,7 +6515,7 @@ interface IWatcher {
      * 群聊消息送达状态通知
     */
     groupMessageDeliveredStatus?: IGroupMessageDeliveredStatusListener;
-    readReceiptReceived?: (conversation: IConversationOption, messageUId: string, sentTime: number) => void;
+    readReceiptReceived?: (conversation: IConversationOption, message: string, sentTime: number, senderUserId: string) => void;
     messageReceiptRequest?: (conversation: IConversationOption, messageUId: string, senderUserId: string) => void;
     messageReceiptResponse?: (conversation: IConversationOption, receivedUserId: string, messageUIdList: string[]) => void;
     /**
@@ -7147,7 +7183,7 @@ declare class APIContext {
      * 方法已废弃，推荐使用 `getChatroomHistoryMessages` 替代
      * @deprecated
      */
-    getChatRoomHistoryMessages: (roomId: string, count?: number, order?: 0 | 1, timestamp?: number) => Promise<IAsyncRes<{
+    getChatRoomHistoryMessages: (roomId: string, count?: number | undefined, order?: 0 | 1 | undefined, timestamp?: number | undefined) => Promise<IAsyncRes<{
         list: IReceivedMessage[];
         hasMore: boolean;
     }>>;
@@ -9077,6 +9113,11 @@ declare const getbundleId: () => string;
  */
 declare const decryptCBC: (data: string, key: string, iv: string) => Promise<string>;
 declare function fixUrlProtocol(url: string, protocol?: EConnectProtocol): string;
+/**
+ * 根据消息id计算出哈希值，用作与云控返回的采样率做模运算(取余运算)
+ * @param messageUId
+ */
+declare function getMessageUIdHash(messageUId: string): number;
 
 declare function httpRequest(options: IRequest): SuspendablePromise<IResponse>;
 
@@ -9113,6 +9154,16 @@ declare const getBrowser: (runtime: IRuntime) => {
     version: any;
 };
 declare const clone: (target: any) => any;
+/**
+ * 将接收状态枚举值转换为接收转态详情
+ * @param status 状态枚举值
+ */
+declare const transformReceivedStatusInfo: (status: ReceivedStatus) => IReceivedStatusInfo;
+/**
+ * 将接收状态详情转换为接收转态枚举值
+ * @param status 状态枚举值
+ */
+declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusInfo) => number;
 
 /**
  * Navi 缓存数据有效时长，单位毫秒
@@ -9324,6 +9375,13 @@ interface IUploadTask {
      */
     userId?: string;
 }
+interface IMRTRConfig {
+    chatroom: number;
+    group: number;
+    private: number;
+    ultraGroup: number;
+    temporary: boolean;
+}
 interface ICloudController {
     /**
      * 云控配置
@@ -9341,6 +9399,12 @@ interface ICloudController {
      * 最后一次请求时间
      */
     lastRequestTime: number;
+    /**
+     * 消息采样率，用于采样率规则，后面的数值代表计算采样率的分母
+     * 1 代表 100%  0.1 代表 10%  0.001 代表 1%
+     * 0 代表不抽样
+     */
+    mrtr: IMRTRConfig;
     /**
      * 区域码
      */
@@ -9406,6 +9470,16 @@ declare abstract class BaseCloudController {
     private logCmdMsgTasks;
     protected dataHandle(data: ICloudController): void;
     request(uri: string, invoker: InvokerType, token?: string): Promise<number>;
+    /**
+     * 设置消息采样率
+     * @param data IMRTRConfig
+     */
+    protected abstract setMRTRConfig(data: IMRTRConfig): void;
+    /**
+     * 将服务端返回数据进行转换
+     * @param data
+     */
+    private _handleMrtrData;
 }
 
 /**
@@ -9420,4 +9494,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, 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, 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, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, 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, OperateStatus, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, 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, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, VERSION, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMimeKey, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, unInitStatisticDB, urlCenter, usingCppEngine, validate, 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, 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, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, 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, OperateStatus, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, 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, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, VERSION, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, unInitStatisticDB, urlCenter, usingCppEngine, validate, version };