tuikit-atomicx-vue3 4.4.0 → 4.5.0

package/dist/states/RoomParticipantState/participantManager.d.ts

@@ -0,0 +1,311 @@
+import { DeviceType, RoomParticipant } from '../../types';
+
+export interface IParticipantManager {
+    getParticipantList(options: {
+        cursor?: string;
+    }): Promise<{
+        participantList: RoomParticipant[];
+        cursor: string;
+    }>;
+    transferOwner(options: {
+        userId: string;
+    }): Promise<void>;
+    setAdmin(options: {
+        userId: string;
+    }): Promise<void>;
+    revokeAdmin(options: {
+        userId: string;
+    }): Promise<void>;
+    kickParticipant(options: {
+        userId: string;
+    }): Promise<void>;
+    updateParticipantNameCard(options: {
+        userId: string;
+        nameCard: string;
+    }): Promise<void>;
+    updateParticipantMetaData(options: {
+        userId: string;
+        metaData: Record<string, string>;
+    }): Promise<void>;
+    closeParticipantDevice(options: {
+        userId: string;
+        deviceType: DeviceType;
+    }): Promise<void>;
+    muteParticipantMessage(options: {
+        userId: string;
+        mute: boolean;
+    }): Promise<void>;
+    disableAllDevices(options: {
+        deviceType: DeviceType;
+        disable: boolean;
+    }): Promise<void>;
+    disableAllMessages(options: {
+        disable: boolean;
+    }): Promise<void>;
+    requestToOpenDevice(options: {
+        device: DeviceType;
+        timeout?: number;
+    }): Promise<void>;
+    cancelOpenDeviceRequest(options: {
+        device: DeviceType;
+    }): Promise<void>;
+    approveOpenDeviceRequest(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+    rejectOpenDeviceRequest(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+    inviteToOpenDevice(options: {
+        device: DeviceType;
+        userId: string;
+        timeout?: number;
+    }): Promise<void>;
+    cancelOpenDeviceInvitation(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+    acceptOpenDeviceInvitation(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+    declineOpenDeviceInvitation(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+}
+/**
+ * 用户自定义信息类型
+ * @typedef {Object} CustomInfoForUser
+ * @property {string} userId - 用户ID
+ * @property {Record<string, string>} customInfo - 自定义信息键值对
+ */
+export type CustomInfoForUser = {
+    userId: string;
+    customInfo: Record<string, string>;
+};
+/**
+ * 参与者管理器类
+ * @class ParticipantManager
+ * @implements {IParticipantManager}
+ * @description 房间参与者管理器的具体实现，采用单例模式，负责管理房间内所有参与者的状态和操作
+ */
+export default class ParticipantManager implements IParticipantManager {
+    static instance: ParticipantManager;
+    /**
+     * 构造函数
+     * @memberof ParticipantManager
+     * @description 初始化参与者管理器，采用单例模式确保全局唯一实例，绑定事件处理器
+     * @example
+     * ```typescript
+     * // 获取参与者管理器实例
+     * const participantManager = new ParticipantManager();
+     * ```
+     */
+    constructor();
+    private getScheduledParticipantList;
+    private getCallingParticipantList;
+    private getPendingParticipantList;
+    private getUserListCursor;
+    getParticipantList(options: {
+        cursor?: string;
+    }): Promise<{
+        participantList: RoomParticipant[];
+        cursor: string;
+    }>;
+    /**
+     * 转移房间所有者权限
+     * @memberof ParticipantManager
+     * @description 将房间所有者权限转移给指定用户，只有当前房间所有者才能执行此操作
+     * @param {Object} options - 转移权限配置
+     * @param {string} options.userId - 目标用户ID，将成为新的房间所有者
+     * @returns {Promise<void>} 转移权限的Promise
+     * @throws {Error} 当用户无权限或目标用户不存在时抛出错误
+     * @example
+     * ```typescript
+     * const participantManager = new ParticipantManager();
+     *
+     * // 转移房间所有者权限
+     * try {
+     *   await participantManager.transferOwner({ userId: 'newOwner123' });
+     *   console.log('房间所有者权限转移成功');
+     * } catch (error) {
+     *   console.error('权限转移失败:', error);
+     * }
+     * ```
+     */
+    transferOwner(options: {
+        userId: string;
+    }): Promise<void>;
+    /**
+     * 设置用户为管理员
+     * @memberof ParticipantManager
+     * @description 将指定用户设置为房间管理员，赋予管理权限
+     * @param {Object} options - 设置管理员配置
+     * @param {string} options.userId - 目标用户ID
+     * @returns {Promise<void>} 设置管理员的Promise
+     * @throws {Error} 当用户无权限或目标用户不存在时抛出错误
+     * @example
+     * ```typescript
+     * const participantManager = new ParticipantManager();
+     *
+     * // 设置用户为管理员
+     * try {
+     *   await participantManager.setAdmin({ userId: 'user123' });
+     *   console.log('用户设置为管理员成功');
+     * } catch (error) {
+     *   console.error('设置管理员失败:', error);
+     * }
+     * ```
+     */
+    setAdmin(options: {
+        userId: string;
+    }): Promise<void>;
+    /**
+     * 撤销用户管理员权限
+     * @memberof ParticipantManager
+     * @description 撤销指定用户的管理员权限，将其降级为普通用户
+     * @param {Object} options - 撤销权限配置
+     * @param {string} options.userId - 目标用户ID
+     * @returns {Promise<void>} 撤销权限的Promise
+     * @throws {Error} 当用户无权限或目标用户不存在时抛出错误
+     * @example
+     * ```typescript
+     * const participantManager = new ParticipantManager();
+     *
+     * // 撤销用户管理员权限
+     * try {
+     *   await participantManager.revokeAdmin({ userId: 'user123' });
+     *   console.log('管理员权限撤销成功');
+     * } catch (error) {
+     *   console.error('撤销权限失败:', error);
+     * }
+     * ```
+     */
+    revokeAdmin(options: {
+        userId: string;
+    }): Promise<void>;
+    /**
+     * 踢出参与者
+     * @memberof ParticipantManager
+     * @description 将指定用户踢出房间，只有房间所有者或管理员才能执行此操作
+     * @param {Object} options - 踢出用户配置
+     * @param {string} options.userId - 要踢出的用户ID
+     * @returns {Promise<void>} 踢出用户的Promise
+     * @throws {Error} 当用户无权限或目标用户不存在时抛出错误
+     * @example
+     * ```typescript
+     * const participantManager = new ParticipantManager();
+     *
+     * // 踢出参与者
+     * try {
+     *   await participantManager.kickParticipant({ userId: 'user123' });
+     *   console.log('用户踢出成功');
+     * } catch (error) {
+     *   console.error('踢出用户失败:', error);
+     * }
+     * ```
+     */
+    kickParticipant(options: {
+        userId: string;
+    }): Promise<void>;
+    updateParticipantNameCard(options: {
+        userId: string;
+        nameCard: string;
+    }): Promise<void>;
+    updateParticipantMetaData(options: {
+        userId: string;
+        metaData: Record<string, string>;
+    }): Promise<void>;
+    closeParticipantDevice(options: {
+        userId: string;
+        deviceType: DeviceType;
+    }): Promise<void>;
+    muteParticipantMessage(options: {
+        userId: string;
+        mute: boolean;
+    }): Promise<void>;
+    disableAllDevices(options: {
+        deviceType: DeviceType;
+        disable: boolean;
+    }): Promise<void>;
+    disableAllMessages(options: {
+        disable: boolean;
+    }): Promise<void>;
+    private transformDeviceTypeToTUIMediaDevice;
+    requestToOpenDevice(options: {
+        device: DeviceType;
+        timeout?: number;
+    }): Promise<void>;
+    cancelOpenDeviceRequest(options: {
+        device: DeviceType;
+    }): Promise<void>;
+    approveOpenDeviceRequest(options: {
+        userId: string;
+        device: DeviceType;
+    }): Promise<void>;
+    rejectOpenDeviceRequest(options: {
+        userId: string;
+        device: DeviceType;
+    }): Promise<void>;
+    inviteToOpenDevice(options: {
+        userId: string;
+        device: DeviceType;
+        timeout?: number;
+    }): Promise<void>;
+    cancelOpenDeviceInvitation(options: {
+        userId: string;
+        device: DeviceType;
+    }): Promise<void>;
+    acceptOpenDeviceInvitation(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+    declineOpenDeviceInvitation(options: {
+        device: DeviceType;
+        userId: string;
+    }): Promise<void>;
+    private onRequestReceived;
+    /**
+     * 处理请求取消事件
+     * @memberof ParticipantManager
+     * @description 处理请求被取消的事件，从映射表中移除对应的请求ID
+     * @param {Object} eventInfo - 事件信息
+     * @param {TUIRequest} eventInfo.request - 被取消的请求对象
+     * @private
+     * @example
+     * ```typescript
+     * // 此方法由事件系统自动调用，无需手动调用
+     * // 当请求被取消时，会自动清理请求ID
+     * ```
+     */
+    private onRequestCancelled;
+    /**
+     * 处理请求已处理事件
+     * @memberof ParticipantManager
+     * @description 处理请求已被处理的事件，从映射表中移除对应的请求ID
+     * @param {Object} eventInfo - 事件信息
+     * @param {TUIRequest} eventInfo.request - 已处理的请求对象
+     * @param {string} eventInfo.userInfo - 用户信息
+     * @private
+     * @example
+     * ```typescript
+     * // 此方法由事件系统自动调用，无需手动调用
+     * // 当请求被处理完成时，会自动清理请求ID
+     * ```
+     */
+    private onRequestProcessed;
+    /**
+     * 绑定房间引擎事件
+     * @memberof ParticipantManager
+     * @description 绑定TUIRoomEngine的相关事件监听器，用于处理请求相关的事件
+     * @private
+     * @example
+     * ```typescript
+     * // 此方法在构造函数中自动调用，无需手动调用
+     * // 绑定请求接收、取消、处理等事件的监听器
+     * ```
+     */
+    private bindRoomEngineEvents;
+}