@rongcloud/engine 4.6.0-beem.1 → 4.6.0-beem.10

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.6.0-beem.1
- * CommitId - 4789dcdc52f61868235bcda3f31eff906bab3674
- * Wed Jan 05 2022 14:09:26 GMT+0800 (China Standard Time)
+ * RCEngine - v4.6.0-beem.10
+ * CommitId - 380698dd4b968e43299324a459a97dd44ba27b0b
+ * Mon Jun 06 2022 13:04:41 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -908,13 +908,17 @@ declare enum ErrorCode {
      */
     RC_CONN_USER_BLOCKED = 31009,
     /**
-     * Disconnect，由服务器返回，比如用户互踢。
+     * Disconnect，该用户其他设备登录，本端被踢下线；
      */
     RC_DISCONN_KICK = 31010,
     /**
-     * Disconnect，由服务器返回，比如用户互踢。
+     * Disconnect，连接被服务端主动关闭；
      */
     RC_DISCONN_EXCEPTION = 31011,
+    /**
+     * 开启禁止把已在线客户端踢下线开关后，该错误码标识已有同类型端在线，禁止链接；
+     */
+    RC_DISCONN_SAME_CLIENT_ON_LINE = 31023,
     /**
      * app 验证Token 验证不通过。所有内部超时，访问失败,返回给客户端sdk都是验证不通过，由服务端日志去看具体是那种失败。
      */
@@ -1204,7 +1208,19 @@ declare enum RTCMode {
     /**
      * 直播模式
      */
-    LIVE = 2
+    LIVE = 2,
+    /**
+    * sip呼叫
+    */
+    SIP = 4,
+    /**
+    * 呼叫模式.包括单呼和群呼
+    */
+    CALL = 5,
+    /**
+    * 会议
+    */
+    MEETING = 6
 }
 /**
  * 直播类型
@@ -1617,6 +1633,10 @@ declare enum ConnectionStatus {
      * appkey 不正确
      */
     APPKEY_IS_FAKE = 20,
+    /**
+    * 其他端登录，本端禁止连接和重连
+    */
+    FORBID_RECONNECT_BY_OTHER_SAME_CLIENT = 31023,
     /**
      * 互踢次数过多（`count > 5`），此时可能出现：在其它他设备登陆有 reconnect 逻辑
      */
@@ -2321,6 +2341,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
         value: string;
     }[];
     kvEntries: IServerRTCRoomEntry[];
+    offlineKickTime: number;
 }
 
 /**
@@ -2881,6 +2902,10 @@ declare enum MessageType {
      * 消息送达报告，仅单聊
      */
     DELIVERED = "RC:Delivered",
+    /**
+     * 消息送达状态报告，仅群聊
+     */
+    DELIVERED_MSG = "RC:DRMsg",
     CHATROOM_JOIN = "RC:ChrmJoinNtf",
     /**
      * 用户退出聊天室
@@ -3243,6 +3268,14 @@ interface IMessageDeliver {
     conversationType: ConversationType;
     targetId: string;
 }
+interface IGroupMessageDeliveredStatusInfo {
+    MessageUId: string;
+    deliveryCount: number;
+}
+interface IGroupMessageDeliverStatus {
+    totalCount: number;
+    list: IGroupMessageDeliveredStatusInfo[];
+}
 
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
@@ -3252,8 +3285,17 @@ interface IEngine {
      * 建立连接
      * @param token
      * @param naviInfo
+     * @param reconnectKickEnable
+     */
+    connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
+    /**
+     * 获取导航信息
+     * @param uris
+     * @param appkey
+     * @param token
+     * @param checkCA
      */
-    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
+    getNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
     /**
      * 上报版本信息
      * @param version
@@ -3589,6 +3631,8 @@ interface IEngine {
      * 获取当前 userId
      */
     getCurrentUserId(): string;
+    getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
+    getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
      * 设置用户在线状态监听器
     */
@@ -3658,16 +3702,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[];
+    }>;
     /**
      * 获取会话下所有未读的 @ 消息
     */
@@ -3798,6 +3859,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;
@@ -3862,6 +3924,10 @@ interface IWatcher {
      * 单聊消息送达通知
      */
     messageDelivered?: IMessageDeliveredListener;
+    /**
+     * 群聊消息送达状态通知
+     */
+    groupMessageDeliveredStatus?: IGroupMessageDeliveredStatusListener;
     messageBlocked?: IMessageBlockedListener;
 }
 interface IPluginGenerator<API, InitOption> {
@@ -4018,6 +4084,7 @@ declare class APIContext {
     private _typingStatusListener;
     private _pullFinishedListener;
     private _messageDeliveredListerer;
+    private _groupMessageDeliveredStatusListerer;
     private _MessageBlockedListener;
     private _callInfoListener;
     /**
@@ -4054,14 +4121,22 @@ declare class APIContext {
      * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
      * @param token
      * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
+     * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
+     *  同一个账号在一台新设备上登录的时候，会把这个账号在之前登录的设备上踢出。
+        由于 SDK 有断线重连功能，存在下面情况。
+        用户在 A 设备登录，A 设备网络不稳定，没有连接成功，SDK 启动重连机制。
+        用户此时又在 B 设备登录，B 设备连接成功。
+        A 设备网络稳定之后，用户在 A 设备连接成功，B 设备被踢出。
+        这个字段就是为这种情况加的。
+        设置 reconnectKickEnable 为 true 时，SDK 重连的时候发现此时已有别的设备连接成功，不再强行踢出已有设备，而是踢出重连设备。
      */
-    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
+    connect(token: string, refreshNavi?: boolean, reconnectKickEnable?: boolean): Promise<IConnectResult>;
     /**
      * 拉取实时配置 web 端需更新 voipCall 字段
      */
     private _pullUserSettings;
     disconnect(): Promise<void>;
-    reconnect(): Promise<IConnectResult>;
+    reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
     private _getTokenWithoutNavi;
     /**
      * 获取当前缓存的导航数据
@@ -4453,10 +4528,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>;
     /**
@@ -4479,6 +4562,8 @@ declare class APIContext {
         key: string;
         value: string;
     }>;
+    getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
+    getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
      * 加入房间
      * @param roomId
@@ -4628,34 +4713,6 @@ declare class RTCPluginContext extends PluginContext {
     rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
 }
 
-declare abstract class ANavi {
-    protected readonly _runtime: IRuntime;
-    protected readonly _options: IAPIContextOption;
-    protected readonly _apiVersion: string;
-    protected readonly _appkey: string;
-    protected _naviInfo: INaviInfo | null;
-    constructor(_runtime: IRuntime, _options: IAPIContextOption);
-    /**
-     * @param uris
-     * @param appkey
-     * @param token
-     */
-    protected abstract _reqNavi(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
-    /**
-     * 获取导航数据
-     * @param token
-     * @param dynamicUris token 携带的动态导航地址
-     * @param force 是否强制重新获取并清空缓存数据
-     */
-    getInfo(token: string, dynamicUris: string[], force: boolean, checkCA?: boolean): Promise<INaviInfo | null>;
-    protected setNaviInfo2Cache(token: string, naviInfo: INaviInfo): void;
-    getInfoFromCache(token: string): INaviInfo | null;
-    /**
-     * 清空导航数据：内存数据、缓存数据
-     */
-    private _clear;
-}
-
 interface IEngineWatcher {
     /**
      * @param message 消息
@@ -4675,6 +4732,7 @@ interface IEngineWatcher {
     onRTCDataChange: (data: IServerRTCRoomEntry[], roomId?: string) => void;
     pullFinished: () => void;
     messageDelivered: (data: IMessageDeliver[]) => void;
+    groupMessageDeliveredStatus: (data: IGroupMessageDeliverStatus) => void;
     callInfo: (data: string) => void;
 }
 /**
@@ -4684,23 +4742,38 @@ declare abstract class AEngine implements IEngine {
     readonly runtime: IRuntime;
     protected readonly _watcher: IEngineWatcher;
     protected readonly _options: IAPIContextOption;
-    /**
-     * 当前用户 Id
-     */
-    currentUserId: string;
     /**
      * 连接时间
     */
     abstract getConnectedTime(): number;
-    readonly navi: ANavi;
     protected readonly _appkey: string;
     protected readonly _apiVer: string;
+    protected readonly _apiVersion: string;
+    protected _naviInfo: INaviInfo | null;
     /**
      * 引擎初始化
      * @param _appkey
      */
     constructor(runtime: IRuntime, _watcher: IEngineWatcher, _options: IAPIContextOption);
-    protected abstract _createNavi(): ANavi;
+    /**
+     * @param uris
+     * @param appkey
+     * @param token
+     */
+    abstract getNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
+    /**
+     * 获取导航数据
+     * @param token
+     * @param dynamicUris token 携带的动态导航地址
+     * @param force 是否强制重新获取并清空缓存数据
+     */
+    getInfo(token: string, dynamicUris: string[], force: boolean, checkCA?: boolean): Promise<INaviInfo | null>;
+    protected setNaviInfo2Cache(token: string, naviInfo: INaviInfo): void;
+    getInfoFromCache(token: string): INaviInfo | null;
+    /**
+     * 清空导航数据：内存数据、缓存数据
+     */
+    private _clear;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
      * 对于未实现的方法，接口响应 Unsupport 错误码
@@ -4712,8 +4785,9 @@ declare abstract class AEngine implements IEngine {
      * 建立连接
      * @param token
      * @param naviInfo
+     * @param reconnectKickEnable
      */
-    abstract connect(token: string, naviInfo: INaviInfo): Promise<ErrorCode>;
+    abstract connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
     /**
      * 发送SDK版本
      * @param versionInfo
@@ -5063,6 +5137,8 @@ declare abstract class AEngine implements IEngine {
      * 获取当前 userId
      */
     abstract getCurrentUserId(): string;
+    abstract getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
+    abstract getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
      * 设置用户在线状态监听器
     */
@@ -5135,6 +5211,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[]>;
     /**
      * 按内容搜索会话内的消息
     */
@@ -5142,6 +5222,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[];
+    }>;
     /**
      * 获取会话下所有未读的 @ 消息
     */
@@ -5685,4 +5778,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, 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 };