@rongcloud/engine 4.4.8-enterprise.2 → 4.4.8-enterprise.4

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.4.8-enterprise.2
- * CommitId - bbd1ce6836028953773821c2b3b9ab8199bc732f
- * Thu Dec 30 2021 17:52:45 GMT+0800 (China Standard Time)
+ * RCEngine - v4.4.8-enterprise.4
+ * CommitId - f7183402bade5fc3cb01a275efb9d2dda56faa71
+ * Wed Sep 28 2022 09:39:45 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -1534,7 +1534,11 @@ declare enum ConnectionStatus {
     /**
      *  请求导航超时
      */
-    RESPONSE_NAVI_TIMEOUT = 204
+    RESPONSE_NAVI_TIMEOUT = 204,
+    /**
+     * Token 错误。
+     */
+    RC_CONN_USER_OR_PASSWD_ERROR = 31004
 }
 
 interface IAsyncRes<T = any> {
@@ -3252,14 +3256,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;
     /**
      * 获取当前缓存的导航数据
@@ -3838,8 +3850,9 @@ interface IEngine {
      * 建立连接
      * @param token
      * @param naviInfo
+     * @param reconnectKickEnable
      */
-    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
+    connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
     /**
      * 上报版本信息
      * @param version
@@ -4374,8 +4387,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