@rongcloud/engine 4.6.0-beem.6 → 4.6.0-beem.9

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.6.0-beem.6
- * CommitId - 8d63e55a9dfc42a2704331082d4d1b7680a2d6ad
- * Sat May 14 2022 00:11:05 GMT+0800 (China Standard Time)
+ * RCEngine - v4.6.0-beem.9
+ * CommitId - a0cd2903ecedf8ef1d8c5477bc9039c063551176
+ * Fri Jun 03 2022 12:32:58 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都是验证不通过，由服务端日志去看具体是那种失败。
      */
@@ -1629,6 +1633,10 @@ declare enum ConnectionStatus {
      * appkey 不正确
      */
     APPKEY_IS_FAKE = 20,
+    /**
+    * 其他端登录，本端禁止连接和重连
+    */
+    FORBID_RECONNECT_BY_OTHER_SAME_CLIENT = 21,
     /**
      * 互踢次数过多（`count > 5`），此时可能出现：在其它他设备登陆有 reconnect 逻辑
      */
@@ -2333,6 +2341,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
         value: string;
     }[];
     kvEntries: IServerRTCRoomEntry[];
+    offlineKickTime: number;
 }
 
 /**
@@ -3279,6 +3288,14 @@ interface IEngine {
      * @param reconnectKickEnable
      */
     connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
+    /**
+     * 获取导航信息
+     * @param uris
+     * @param appkey
+     * @param token
+     * @param checkCA
+     */
+    getNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
     /**
      * 上报版本信息
      * @param version
@@ -4696,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 消息
@@ -4753,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 错误码
@@ -5774,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, 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 };
+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 };