@rongcloud/engine 5.2.1-alpha.3 → 5.2.1-enterprise-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.2.1-alpha.3
- * CommitId - 39f5d0951d0770155a526688840b2a91e1f0786f
- * Tue Mar 08 2022 17:46:21 GMT+0800 (China Standard Time)
+ * RCEngine - v5.2.1-enterprise-alpha.1
+ * CommitId - 2db8186f9f3c4b502828f95f4f67dac6c8097869
+ * Wed Mar 30 2022 16:45:53 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -365,7 +365,7 @@ declare class QueryWriter extends RetryableWriter {
 }
 
 /**
- *  聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
+ * 输入状态类型
 */
 declare enum OperateStatus {
     typing = 0
@@ -394,11 +394,14 @@ interface IChrmKVEntry {
     userId?: string;
     type?: number;
     isDeleted?: boolean;
+    version?: number;
 }
 interface IChrmKVEntries {
     entries: {
         key: string;
         value?: string;
+        timestamp?: number;
+        version?: number;
     }[];
     notificationExtra?: string;
     isOverwrite?: boolean;
@@ -742,7 +745,7 @@ interface IReceivedMessage {
      */
     isInterrupt?: boolean;
     /**
-     * 拉取历史消息时表示该消息是否修改过
+     * 拉取历史消息时表示该消息是否修改过（仅超级群有效）
      */
     isModifyMessage?: boolean;
 }
@@ -1158,6 +1161,11 @@ declare enum ErrorCode {
      * 聊天室Key不存在
      */
     CHATROOM_KEY_NOT_EXIST = 23427,
+    /*!
+     聊天室设置 KV 失败，出现在两人或者多端同时操作一个 kv。
+     如果出现该错误，为避免和其他端同时操作，请延时一定时间再试
+    */
+    CHATROOM_KV_SET_ERROR = 23431,
     /**
      * 敏感词屏蔽
      */
@@ -2987,6 +2995,17 @@ interface IEndRoomPKOptions {
     keys: string[];
 }
 
+interface IRTCRoomBindOption {
+    /**
+     * 聊天室 ID
+     */
+    chatRoomId: string;
+    /**
+     * RTC房间 ID
+     */
+    rtcRoomId: string;
+}
+
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
  */
@@ -3405,16 +3424,27 @@ interface IEngine {
      */
     setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
     /**
-     * 通过关键字搜索会话
+     * 通过关键字与 channelId 搜索所有会话
      */
     searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
     /**
-     * 按内容搜索会话内的消息
+     * 通过关键字搜索所有会话
+     */
+    searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
+    /**
+     * 按内容搜索指定会话内的消息
      */
     searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
         messages: IReceivedMessage[];
         count: number;
     }>;
+    /**
+     * 按内容搜索指定会话（不区分 channelId）的消息
+     */
+    searchMessageByContentWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
     /**
      * 获取会话下所有未读的 @ 消息
      */
@@ -3496,6 +3526,7 @@ interface IEngine {
     cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
     responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
     endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
+    bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<ErrorCode>;
 }
 
 interface IExpansionMsgContent {
@@ -3696,6 +3727,10 @@ declare class DataCodec {
      * 格式化 RTC 用户加入房间后通知拉取的数据（房间内主播全量列表、房间全量资源）
      */
     private _formatRTCRoomKVList;
+    /**
+     * 拉取聊天室 kv 存储时的最新时间戳
+     */
+    private _formatChrmKVVersion;
     /**
      * 格式化观众加房间后返回数据
      */
@@ -3944,6 +3979,10 @@ declare class DataCodec {
      * 结束连麦 PK
      */
     encodeEndRoomPK(options: IEndRoomPKOptions): any;
+    /**
+     * 设置聊天室关联的rtc房间
+    */
+    encodebindRTCRoomForChatroom(options: IRTCRoomBindOption): any;
 }
 
 interface IDataChannelWatcher {
@@ -4812,10 +4851,15 @@ declare class APIContext {
         status: string;
     }>>;
     searchConversationByContent(keyword: string, customMessageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
+    searchConversationByContentWithAllChannel(keyword: string, customMessageTypes?: string[], conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
     searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId?: string): Promise<IAsyncRes<{
         messages: IReceivedMessage[];
         count: number;
     }>>;
+    searchMessageByContentWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number): Promise<IAsyncRes<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>>;
     getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId?: string): IReceivedMessage[];
     clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
     /**
@@ -4896,6 +4940,10 @@ declare class APIContext {
      * 结束连麦 PK
      */
     endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * SDK设置聊天室关联的rtc房间
+     */
+    bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<ErrorCode>;
 }
 
 declare class PluginContext {
@@ -5663,6 +5711,10 @@ declare abstract class AEngine implements IEngine {
      * 通过关键字搜索会话
     */
     abstract searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
+    /**
+     * 通过关键字搜索所有会话
+     */
+    abstract searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
     /**
      * 按内容搜索会话内的消息
     */
@@ -5670,6 +5722,13 @@ declare abstract class AEngine implements IEngine {
         messages: IReceivedMessage[];
         count: number;
     }>;
+    /**
+     * 按内容搜索指定会话（不区分 channelId）的消息
+     */
+    abstract searchMessageByContentWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
     /**
      * 获取会话下所有未读的 @ 消息
     */
@@ -5762,6 +5821,7 @@ declare abstract class AEngine implements IEngine {
     abstract cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
     abstract responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
     abstract endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
+    abstract bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<ErrorCode>;
 }
 
 declare class AppStorage {
@@ -6234,4 +6294,4 @@ declare enum CONNECTION_TYPE {
  */
 declare const version: string;
 
-export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, 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, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, 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, IUltraModifyMsgOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };
+export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, 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, 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, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };