@tencentcloud/tuiroom-engine-electron 2.2.0 → 2.2.2-alpha.0

package/index.d.ts

@@ -72,8 +72,7 @@ declare class TUIRoomEngine {
      * @param {object} options
      * @param {string} options.userName 用户名，必填
      * @param {string} options.avatarUrl 用户头像，必填
-     * @deprecated customInfo 字段自 v2.2.0 版本废弃
-     * @param {object=} options.customInfo 用户自定义资料
+     * @param {object=} options.customInfo 用户自定义资料, customInfo 字段自 v2.2.0 版本废弃
      * App 管理员可以通过 [即时通信 IM 控制台 > 用户自定义字段](https://console.cloud.tencent.com/im/user-data) 新增自定义资料字段
      * 用户自定义字段生效以后，用户可以调用 setSelfInfo 接口设置自定义资料
      * @returns {Promise<void>}
@@ -137,7 +136,7 @@ declare class TUIRoomEngine {
      * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
      * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）<br>
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
+     * roomType 为 TUIRoomType.kLive(直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
      *
      * @example
@@ -165,6 +164,7 @@ declare class TUIRoomEngine {
      * 进入房间接口
      * @param {object} options
      * @param {string} options.roomId 房间号，字符串类型
+     * @param {TUIRoomType} options.roomType 房间类型, 默认值为 TUIRoomType.kConference (自 v2.3.0 支持)
      * @returns {Promise<TUIRoomInfo>} roomInfo
      * 该接口返回当前房间信息
      *
@@ -172,10 +172,12 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * const roomDetailInfo = await roomEngine.enterRoom({
      *  roomId: '12345',
+     *  roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
      * });
      */
     enterRoom(options: {
         roomId: string;
+        roomType: TUIRoomType;
     }): Promise<TUIRoomInfo>;
     /**
      * 解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入
@@ -838,7 +840,7 @@ declare class TUIRoomEngine {
      * @param {object} options
      * @param {number} options.maxSeatCount 设置房间麦位最大值<br/>
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
+     * roomType 为 TUIRoomType.kLive(直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.createRoom({ roomId: '12345' });