@tencentcloud/tuiroom-engine-electron 1.0.1 → 1.0.2

package/index.d.ts

@@ -33,25 +33,25 @@ declare class TUIRoomEngine {
      */
     private JSCallNativeFunctionPromise;
     /**
-       * 登录 TUIRoomEngine
-       *
-       * @param {object} options
-       * @param {number} options.sdkAppId sdkAppId <br>
-       * 在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 单击 **应用管理** > **创建应用** 创建新应用之后，即可在 **应用信息** 中获取 sdkAppId 信息。
-       * @param {string} options.userId 用户ID <br>
-       * 建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
-       * @param {string} options.userSig userSig 签名 <br>
-       * 计算 userSig 的方式请参考 [UserSig 相关](https://cloud.tencent.com/document/product/647/17275)。
-       * @returns {Promise<void>}
-       *
-       * @example
-       * // 登录 TUIRoomEngine
-       * await TUIRoomEngine.login({
-       *  sdkAppId: 0,   // 填写您申请的 sdkAppId
-       *  userId: '',    // 填写您业务对应的 userId
-       *  userSig: '',   // 填写服务器或本地计算的 userSig
-       * })
-       */
+     * 登录 TUIRoomEngine
+     *
+     * @param {object} options
+     * @param {number} options.sdkAppId sdkAppId <br>
+     * 在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 单击 **应用管理** > **创建应用** 创建新应用之后，即可在 **应用信息** 中获取 sdkAppId 信息。
+     * @param {string} options.userId 用户ID <br>
+     * 建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
+     * @param {string} options.userSig userSig 签名 <br>
+     * 计算 userSig 的方式请参考 [UserSig 相关](https://cloud.tencent.com/document/product/647/17275)。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // 登录 TUIRoomEngine
+     * await TUIRoomEngine.login({
+     *  sdkAppId: 0,   // 填写您申请的 sdkAppId
+     *  userId: '',    // 填写您业务对应的 userId
+     *  userSig: '',   // 填写服务器或本地计算的 userSig
+     * })
+     */
     static login(options: {
         sdkAppId: number;
         userId: string;
@@ -292,7 +292,7 @@ declare class TUIRoomEngine {
         seatIndex: number;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 离开麦位
      * @returns {Promise<void>}
@@ -353,7 +353,7 @@ declare class TUIRoomEngine {
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 关闭远端用户摄像头
      *
@@ -412,7 +412,7 @@ declare class TUIRoomEngine {
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 关闭远端用户麦克风
      *
@@ -489,7 +489,7 @@ declare class TUIRoomEngine {
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<number>;
+    }): Promise<string>;
     /**
      * 要求其他人下麦
      * @param {object} options 要求其他人下麦的参数
@@ -511,22 +511,22 @@ declare class TUIRoomEngine {
     /**
      * 取消已经发出的请求
      * @param {object} options 取消已经发出请求的参数
-     * @param {number} options.requestId 请求 Id
+     * @param {string} options.requestId 请求 Id
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.cancelRequest({
-     *  requestId: 0,    // 请使用实际 requestId
+     *  requestId: '',    // 请使用实际 requestId
      * });
      */
     cancelRequest(options: {
-        requestId: number;
+        requestId: string;
     }): Promise<void>;
     /**
      * 回复远端用户的请求
      * @param {object} options 回复远端用户的请求的参数
-     * @param {number} options.requestId 请求 Id
+     * @param {string} options.requestId 请求 Id
      * @param {boolean} options.agree 是否同意
      * @returns {Promise<void>}
      *
@@ -535,18 +535,18 @@ declare class TUIRoomEngine {
      *
      * // 同意远端的请求
      * await roomEngine.responseRemoteRequest({
-     *  requestId: 0,    // 请使用实际 requestId
+     *  requestId: '',    // 请使用实际 requestId
      *  agree: true,
      * });
      *
      * // 拒绝远端的请求
      * await roomEngine.responseRemoteRequest({
-     *  requestId: 0,    // 请使用实际 requestId
+     *  requestId: '',    // 请使用实际 requestId
      *  agree: false,
      * });
      */
     responseRemoteRequest(options: {
-        requestId: number;
+        requestId: string;
         agree: boolean;
     }): Promise<any>;
     /**