@rongcloud/engine 5.5.0 → 5.5.1

package/index.d.ts

@@ -931,7 +931,8 @@ declare enum ErrorCode {
     /**
      * 聊天室设置批量kv，一次不能超过10个
      */
-    CHATROOM_KV_STORE_OUT_LIMIT = 23429
+    CHATROOM_KV_STORE_OUT_LIMIT = 23429,
+    SEARCH_PROPS_LIMIT_ERROR = 35022
 }
 
 /**
@@ -1363,12 +1364,16 @@ declare enum LogTagId {
     L_SEND_MSG_R = "L-send_msg-R",
     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",
     A_DELETE_MESSAGES_S = "A-delete_messages-S",
     P_DELETE_MSG_S = "P-delete_msg-S",
     L_PULL_CONVERSATION_S = "L-pull_conversation-S",
@@ -1407,7 +1412,8 @@ declare enum LogTagId {
      * PB 数据编码错误
      */
     L_PB_ENCODE_E = "L-pb-encode-E",
-    L_PB_DECODE_E = "L-pb-decode-E"
+    L_PB_DECODE_E = "L-pb-decode-E",
+    L_NOTIFY_NAVI_CHANGE_E = "L-notify_navi_change-E"
 }
 
 /**
@@ -2114,8 +2120,9 @@ interface ISendMsgOptions {
     channelId?: string;
     /**
      * 客户端的消息标识
+     * 重发消息时用到，重发消息的消息 ID
      */
-    messageId?: string;
+    messageId?: number;
     /**
      * 超级群专有字段，是否断档，若断档需要客户判断是否拉取
      */
@@ -2640,6 +2647,10 @@ interface INaviInfo {
      * 防黑产开关, 1: 打开，0：关闭
      */
     openAnti?: number;
+    /**
+     * 鉴权认证
+     */
+    jwt?: string;
 }
 
 interface IChatroomEntryListenerData {
@@ -4568,6 +4579,10 @@ declare class APIContext {
      * rtc 数据变更通知 pluginContext
      */
     private _rtcDataChange;
+    /**
+     * 导航数据变更通知
+     */
+    private _naviDataChange;
     /**
      * 业务层事件监听器挂载点
      */
@@ -4621,6 +4636,11 @@ declare class APIContext {
      * 获取当前缓存的导航数据
      */
     getInfoFromCache(): INaviInfo | null;
+    /**
+     * 请求服务导航数据
+     */
+    reqNaviInfo(refreshNavi: boolean, traceId?: string): IPromiseResult<INaviInfo | null>;
+    private _registerMessageSearchPropsMapping;
     /**
      * 消息注册
      * @description 消息注册需在应用初始化完成前进行
@@ -4636,6 +4656,7 @@ declare class APIContext {
      * @param listener
      */
     registerRTCSignalingListener(listener?: (buffer: Uint8Array) => void): void;
+    checkSearchPropsMsg(messageType: string, msgContent: any): IAsyncRes;
     /**
      * 发送消息
      * @param conversationType
@@ -4737,6 +4758,13 @@ declare class APIContext {
      * @param includeMuted 包含已设置免打扰的会话
      */
     getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
+    /**
+     * 获取会话指定免打扰级别未读消息总数
+     * @param conversationTypes 会话类型
+     * @param levels 免打扰级别
+     * @param isMentioned 是否是 @ 消息未读数
+     */
+    getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<IAsyncRes<number>>;
     /**
      * 获取第一个未读消息
      */
@@ -4749,10 +4777,8 @@ declare class APIContext {
      * * 0: 未设置（向上查询群或者APP级别设置）//存量数据中0表示未设置
      * * 1: 群聊超级群仅@消息通知（现在通知）单聊代表全部消息通知
      * * 2: @ 指定用户通知
-     * * 3: @ 群用户组通知，通知用户组暂未实现，暂不暴露出去
      * * 4: @ 群全员通知
      * * 5: 消息通知被屏蔽，即不接收消息通知
-     * @desc 注意单聊的 level 只有 -1、0、1
      */
     setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel?: NotificationLevel, channelId?: string): Promise<ErrorCode>;
     setConversationStatus(conversationType: ConversationType, targetId: string, isTop?: boolean, notificationStatus?: 1 | 2, channelId?: string): Promise<ErrorCode>;
@@ -5010,13 +5036,13 @@ declare class APIContext {
      * @todo
      * @param targetId
      */
-    getUltraGroupUnreadMentionedCountByTargetId(targetId: string): Promise<IAsyncRes<number>>;
+    getUltraGroupUnreadMentionedCountByTargetId(targetId: string, levels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
     /**
      * 获取指定超级群所有频道未读数
      * @param targetId 超级群 Id
      * @returns 未读数
      */
-    getUltraGroupUnreadCountByTargetId(targetId: string): Promise<IAsyncRes<number>>;
+    getUltraGroupUnreadCountByTargetId(targetId: string, levels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
     /**
      * 超级群类型未读数
      * @param isMentioned 是否是 @ 消息，默认为 false
@@ -5234,6 +5260,10 @@ declare class APIContext {
 declare class PluginContext {
     protected readonly _context: APIContext;
     constructor(_context: APIContext);
+    /**
+     * 重新请求服务导航数据
+     */
+    refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
     /**
      * 获取 context
      */
@@ -5253,6 +5283,8 @@ declare class PluginContext {
      * 用户主动断开连接的事件通知
      */
     ondisconnect?(): void;
+    /** 导航数据变更通知 */
+    onnavidatachange?(naviInfo: INaviInfo): void;
     /**
      * 接收 IM 连接状态变更通知
      * @param status
@@ -5555,6 +5587,8 @@ interface IEngineWatcher {
      */
     onRTCDataChange: (data: IServerRTCRoomEntry[], roomId?: string) => void;
     pullFinished: () => void;
+    /** 导航数据变更 */
+    onNaviDataChange: (naviInfo: INaviInfo) => void;
 }
 /**
  * 引擎定义
@@ -5584,6 +5618,7 @@ 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;
     /**
      * 获取导航数据
      * @param token
@@ -5734,6 +5769,10 @@ declare abstract class AEngine implements IEngine {
      * @param includeMuted 包含已设置免打扰的会话
      */
     abstract getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
+    /**
+     * 获取会话指定免打扰级别的未读总数
+     */
+    abstract getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<IAsyncRes<number>>;
     /**
      * 获取指定会话未读数
      */
@@ -5995,13 +6034,13 @@ declare abstract class AEngine implements IEngine {
      * @todo
      * @param targetId
      */
-    abstract getUltraGroupUnreadMentionedCountByTargetId(targetId: string): Promise<IAsyncRes<number>>;
+    abstract getUltraGroupUnreadMentionedCountByTargetId(targetId: string, levels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
     /**
      * 获取指定超级群所有子频道未读数
      * @param targetId 超级群 Id
      * @returns 未读数
      */
-    abstract getUltraGroupUnreadCountByTargetId(targetId: string): IPromiseResult<number>;
+    abstract getUltraGroupUnreadCountByTargetId(targetId: string, levels?: NotificationLevel[]): IPromiseResult<number>;
     /**
      * 超级群类型未读数
      * @param isMentioned 是否是 @ 消息
@@ -6416,6 +6455,7 @@ declare const isHttpUrl: (value: any) => boolean;
 */
 declare const notEmptyObject: (val: Object) => boolean;
 declare const isValidConversationType: (conversation: number) => boolean;
+declare const isValidNotificationLevel: (level: number) => boolean;
 declare const isValidChannelId: (value: any) => boolean;
 /**
  * 判断是否是一个有效的文件类型
@@ -6430,7 +6470,6 @@ declare const isValidExpansion: (expansion: {
     [key: string]: string;
 } | undefined) => IIsValidExpansion;
 
-/** ******************************************新重构logger，按照Web新日志规范上报  ********************************** **/
 declare const sessionId: string;
 /**
  * logLevelTransformer
@@ -6511,8 +6550,6 @@ declare namespace base {
    */
 declare function reportLog(logLevel: LogLevel, tagId: string, content: string, logSource?: LogSource): void;
 
-/** ******************************************旧Logger类，fix兼容用，逐步废弃 ********************************** **/
-
 /**
  * @description 兼容旧版用法，建议用Logger静态方法
  *  1、不符合新版Web日志规范
@@ -6672,6 +6709,19 @@ declare const pushJSONToConfigs: (pushStr: string, pushId: string) => {
 };
 declare const isValidChrmEntryKey: (key: string) => Boolean;
 declare const isValidChrmEntryValue: (value: string) => Boolean;
+/**
+ * 端上生成 MessageId
+ * 规则与协议栈生成 clientUid 一致， 得到 64 位数字。
+ * 生成规则：
+ *  1st: 取时间戳低 32 位, （前边空一位）。
+ *  2nd: 偏移量 [0 -> 2047] 自增，超出从 0 开始, 占 11 位。
+ *  3rd: 随机数 [0 -> 2^20 - 1]， 占 20 位。
+ * 作用：
+ *  1. 用于消息发送前在消息列表中渲染，发送成功或失败后更新消息的 标识。
+ *  2. 消息滤重，参考文档：https://rongcloud.yuque.com/tbvylv/znhprz/zwlg5d
+ * 注意： 这里的 messageId 与 websocketChannel 中的 messageId 不是同一个。
+ */
+declare const getClientMessageId: () => number;
 
 /**
  * @todo 后期禁用此方法，容易滥用，且会丢失上下文的数据类型跟踪
@@ -6817,4 +6867,4 @@ declare const ONE_LOG_SIZE_MAX = 1000;
  */
 declare const version: string;
 
-export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, 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, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, randomNum, todo, usingCppEngine, validate, version };
+export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, 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, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, 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, randomNum, todo, usingCppEngine, validate, version };