@rongcloud/engine 4.6.0-beem.2 → 4.6.0-beem.5

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.6.0-beem.2
- * CommitId - 62a43aacff4328b710113ae921984d364c6f70c1
- * Tue Jan 25 2022 17:30:10 GMT+0800 (China Standard Time)
+ * RCEngine - v4.6.0-beem.5
+ * CommitId - be09ae60f45b2f2e97b0f7897216e2bbfbc6a1c5
+ * Thu May 12 2022 18:23:09 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -1204,7 +1204,19 @@ declare enum RTCMode {
     /**
      * 直播模式
      */
-    LIVE = 2
+    LIVE = 2,
+    /**
+    * sip呼叫
+    */
+    SIP = 4,
+    /**
+    * 呼叫模式.包括单呼和群呼
+    */
+    CALL = 5,
+    /**
+    * 会议
+    */
+    MEETING = 6
 }
 /**
  * 直播类型
@@ -2881,6 +2893,10 @@ declare enum MessageType {
      * 消息送达报告，仅单聊
      */
     DELIVERED = "RC:Delivered",
+    /**
+     * 消息送达状态报告，仅群聊
+     */
+    DELIVERED_MSG = "RC:DRMsg",
     CHATROOM_JOIN = "RC:ChrmJoinNtf",
     /**
      * 用户退出聊天室
@@ -3243,6 +3259,14 @@ interface IMessageDeliver {
     conversationType: ConversationType;
     targetId: string;
 }
+interface IGroupMessageDeliveredStatusInfo {
+    MessageUId: string;
+    deliveryCount: number;
+}
+interface IGroupMessageDeliverStatus {
+    totalCount: number;
+    list: IGroupMessageDeliveredStatusInfo[];
+}
 
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
@@ -3590,6 +3614,8 @@ interface IEngine {
      * 获取当前 userId
      */
     getCurrentUserId(): string;
+    getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
+    getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
      * 设置用户在线状态监听器
     */
@@ -3659,16 +3685,33 @@ 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): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
+    /**
+     * 按内容搜索时间范围内指定会话（不区分 channelId）的消息
+     */
+    searchMessageByContentInTimeRangeWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, startTime: number, endTime: number, offset: number, limit: number): IPromiseResult<{
+        messages: IReceivedMessage[];
+    }>;
     /**
      * 获取会话下所有未读的 @ 消息
     */
@@ -3799,6 +3842,7 @@ declare type ITagListener = () => void;
 declare type IConversationTagListener = () => void;
 declare type ItypingStateListener = (data: ITypingMessage[]) => void;
 declare type IMessageDeliveredListener = (data: IMessageDeliver[]) => void;
+declare type IGroupMessageDeliveredStatusListener = (data: IGroupMessageDeliverStatus) => void;
 declare type IMessageBlockedListener = (data: IBlockedMessageInfo) => void;
 interface ISendExMsgOptions {
     channelId: string;
@@ -3863,6 +3907,10 @@ interface IWatcher {
      * 单聊消息送达通知
      */
     messageDelivered?: IMessageDeliveredListener;
+    /**
+     * 群聊消息送达状态通知
+     */
+    groupMessageDeliveredStatus?: IGroupMessageDeliveredStatusListener;
     messageBlocked?: IMessageBlockedListener;
 }
 interface IPluginGenerator<API, InitOption> {
@@ -4019,6 +4067,7 @@ declare class APIContext {
     private _typingStatusListener;
     private _pullFinishedListener;
     private _messageDeliveredListerer;
+    private _groupMessageDeliveredStatusListerer;
     private _MessageBlockedListener;
     private _callInfoListener;
     /**
@@ -4462,10 +4511,18 @@ 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): Promise<IAsyncRes<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>>;
+    searchMessageByContentInTimeRangeWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, startTime: number, endTime: number, offset: number, limit: number): Promise<IAsyncRes<{
+        messages: IReceivedMessage[];
+    }>>;
     getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId?: string): IReceivedMessage[];
     clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
     /**
@@ -4488,6 +4545,8 @@ declare class APIContext {
         key: string;
         value: string;
     }>;
+    getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
+    getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
      * 加入房间
      * @param roomId
@@ -4684,6 +4743,7 @@ interface IEngineWatcher {
     onRTCDataChange: (data: IServerRTCRoomEntry[], roomId?: string) => void;
     pullFinished: () => void;
     messageDelivered: (data: IMessageDeliver[]) => void;
+    groupMessageDeliveredStatus: (data: IGroupMessageDeliverStatus) => void;
     callInfo: (data: string) => void;
 }
 /**
@@ -5073,6 +5133,8 @@ declare abstract class AEngine implements IEngine {
      * 获取当前 userId
      */
     abstract getCurrentUserId(): string;
+    abstract getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
+    abstract getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
      * 设置用户在线状态监听器
     */
@@ -5145,6 +5207,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[]>;
     /**
      * 按内容搜索会话内的消息
     */
@@ -5152,6 +5218,19 @@ declare abstract class AEngine implements IEngine {
         messages: IReceivedMessage[];
         count: number;
     }>;
+    /**
+     * 按内容搜索指定会话（不区分 channelId）的消息
+     */
+    abstract searchMessageByContentWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number): IPromiseResult<{
+        messages: IReceivedMessage[];
+        count: number;
+    }>;
+    /**
+     * 按内容搜索时间范围内指定会话（不区分 channelId）的消息
+     */
+    abstract searchMessageByContentInTimeRangeWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, startTime: number, endTime: number, offset: number, limit: number): IPromiseResult<{
+        messages: IReceivedMessage[];
+    }>;
     /**
      * 获取会话下所有未读的 @ 消息
     */
@@ -5695,4 +5774,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, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IDeliveredUser, IEngine, IEngineWatcher, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGroupMessageDeliverInfo, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageBlockedListener, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntriesOption, IRemoveChatRoomEntryOption, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, 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, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, 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, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IDeliveredUser, IEngine, IEngineWatcher, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusListener, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageBlockedListener, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntriesOption, IRemoveChatRoomEntryOption, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, 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, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };