@tencentcloud/tuiroom-engine-js 2.5.2-beat.1 → 2.6.2-beta.1

package/index.d.ts

@@ -1120,7 +1120,7 @@ declare class Logger {
         sdkAppId: number;
         seq: number;
     });
-    getLogMessage(params: any[]): string;
+    getLogMessage(params: any[]): string | any[];
     update(options: {
         sdkAppId: number;
         userId: string;
@@ -1390,8 +1390,8 @@ declare class TUIConferenceListManager {
      * @param {object} options
      * @param {string} options.roomId  会议的房间Id。
      * @param {string} options.roomName  会议的名称。
-     * @param {string} options.scheduleStartTime  预定会议的开始时间（计数单位为秒的时间戳）。
-     * @param {string} options.scheduleEndTime  预定会议的结束时间（计数单位为秒的时间戳）。
+     * @param {number} options.scheduleStartTime  预定会议的开始时间（计数单位为秒的时间戳）。
+     * @param {number} options.scheduleEndTime  预定会议的结束时间（计数单位为秒的时间戳）。
      * @returns {Promise<void>}
      *
      * @example
@@ -1414,9 +1414,9 @@ declare class TUIConferenceListManager {
      * 获取预定会议列表
      *
      * @param {object} options
-     * @param {object} options.statusArray 会议状态数组，默认值为拉取全部状态会议。
+     * @param {Array<TUIConferenceStatus>} options.statusArray 会议状态数组，默认值为拉取全部状态会议。
      * @param {string} options.cursor 分页获取索引，第一次拉取填 ''，回调成功 如果callback返回的数据中 cursor 不为 ''，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的cursor为 ''，表示数据已经全部拉取。
-     * @param {string} options.count  本次拉取数量。
+     * @param {number} options.count  本次拉取数量。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -1442,7 +1442,7 @@ declare class TUIConferenceListManager {
      * @param {object} options
      * @param {string} options.roomId  会议 Id ,即房间 roomId 。
      * @param {string} options.cursor 分页获取索引，第一次拉取填 ""，回调成功 如果 callback 返回的数据中 cursor 不为""，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的 cursor 为""，表示数据已经全部拉取。
-     * @param {string} options.count  本次拉取数量。
+     * @param {number} options.count  本次拉取数量。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -1470,7 +1470,7 @@ declare class TUIConferenceListManager {
      *
      * @param {object} options
      * @param {string} options.roomId  会议 Id ,即房间 roomId 。
-     * @param {string} options.userIdList 成员 userId 列表。
+     * @param {Array<string>} options.userIdList 成员 userId 列表。
      * @returns {Promise<void>}
      *
      * @example
@@ -1490,7 +1490,7 @@ declare class TUIConferenceListManager {
      *
      * @param {object} options
      * @param {string} options.roomId  会议 Id ,即房间 roomId 。
-     * @param {string} options.userIdList 成员 userId 列表。
+     * @param {Array<string>} options.userIdList 成员 userId 列表。
      * @returns {Promise<void>}
      *
      * @example
@@ -1902,14 +1902,21 @@ declare class TUIRoomEngine {
     exitRoom(): Promise<void>;
     /**
      * 获取房间信息
+     * @param {object} options
+     * @param {string} options.roomId 要获取信息的房间Id。
+     * @param {TUIRoomType} options.roomType 要获取信息的房间类型。
      * @returns {Promise<TUIRoomInfo>} roomInfo
-     * 获取房间信息
-     *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const roomInfo = await roomEngine.fetchRoomInfo();
+     * const roomInfo = await roomEngine.fetchRoomInfo({
+     *  roomId: '12345',
+     *  roomType: TUIRoomType.kConference,
+     * });
      */
-    fetchRoomInfo(): Promise<TUIRoomInfo>;
+    fetchRoomInfo(options?: {
+        roomId: string;
+        roomType: TUIRoomType;
+    }): Promise<TUIRoomInfo>;
     /**
      * 更新房间的名字（仅群主或者管理员可以调用）
      * @param {object} options
@@ -1945,7 +1952,7 @@ declare class TUIRoomEngine {
      *
      * @since v2.5.0
      * @param {object} options
-     * @param {string} options.password 房间密码
+     * @param {string} options.password 房间密码,传入空字符串则代表关闭房间密码
      * @returns {Promise<void>}
      *
      * @example