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

package/index.d.ts

@@ -317,6 +317,27 @@ type TUIConferenceModifyInfo = {
         roomName?: string;
     };
 };
+declare enum TUIInvitationStatus {
+    kNone = 0,
+    kPending = 1,
+    kTimeout = 2,
+    kAccepted = 3,
+    kRejected = 4
+}
+declare enum TUIInvitationCode {
+    kSuccess = 0,
+    kAlreadyInInvitationList = 1,
+    kAlreadyInConference = 2
+}
+declare enum TUIInvitationRejectedReason {
+    kRejectToEnter = 0,
+    kInOtherConference = 1
+}
+type TUIInvitation = {
+    status: TUIInvitationStatus;
+    invitee: TUIUserInfo;
+    inviter: TUIUserInfo;
+};
 /**
  * **TUIRoomEngine 事件列表**<br>
  * @namespace TUIRoomEvents
@@ -907,6 +928,187 @@ declare enum TUIConferenceListManagerEvents {
      * })
      */
     onConferenceStatusChanged = "onConferenceStatusChanged"
+}
+/**
+ * @since v2.6.0
+ * **TUIConferenceInvitationManager 事件列表**<br>
+ * @namespace TUIConferenceInvitationManagerEvents
+ */
+declare enum TUIConferenceInvitationManagerEvents {
+    /**
+     * @description 收到会中邀请回调
+     * @default 'onReceiveInvitation'
+     * @event TUIConferenceInvitationManagerEvents#onReceiveInvitation
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     * @param {string} options.extensionInfo 自定义扩展信息
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onReceiveInvitation, ({ roomInfo, invitation, extensionInfo }) => {
+     *  console.log('conferenceInvitationManager.onReceiveInvitation', roomInfo, invitation, extensionInfo);
+     * })
+     */
+    onReceiveInvitation = "onReceiveInvitation",
+    /**
+     * @description 邀请在其他设备处理的回调
+     * @default 'onInvitationHandledByOtherDevice'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationHandledByOtherDevice
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {boolean} options.accepted 接受状态。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationHandledByOtherDevice, ({ roomInfo, accepted }) => {
+     *  console.log('conferenceInvitationManager.onInvitationHandledByOtherDevice', roomInfo, accepted);
+     * })
+     */
+    onInvitationHandledByOtherDevice = "onInvitationHandledByOtherDevice",
+    /**
+     * @description 会中邀请取消的回调
+     * @default 'onInvitationCancelled'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationCancelled
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationCancelled, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationCancelled', roomInfo, invitation);
+     * })
+     */
+    onInvitationCancelled = "onInvitationCancelled",
+    /**
+     * @description 会中邀请接受的回调
+     * @default 'onInvitationAccepted'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationAccepted
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAccepted, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationAccepted', roomInfo, invitation);
+     * })
+     */
+    onInvitationAccepted = "onInvitationAccepted",
+    /**
+     * @description 会中邀请拒绝的回调
+     * @default 'onInvitationRejected'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationRejected
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     * @param {TUIInvitationRejectedReason} options.reason 拒绝加入会议的原因。
+     *
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, ({ roomInfo, invitation, reason }) => {
+     *  console.log('conferenceInvitationManager.onInvitationRejected', roomInfo, invitation, reason);
+     * })
+     */
+    onInvitationRejected = "onInvitationRejected",
+    /**
+     * @description 会中邀请超时的回调
+     * @default 'onInvitationTimeout'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationTimeout
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationTimeout, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationTimeout', roomInfo, invitation);
+     * })
+     */
+    onInvitationTimeout = "onInvitationTimeout",
+    /**
+     * @description 会中邀请被管理员撤回的回调
+     * @default 'onInvitationRevokedByAdmin'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationRevokedByAdmin
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     * @param {TUIUserInfo} options.operateUser 撤回邀请的人的信息
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRevokedByAdmin, ({ roomInfo, invitation, userRole }) => {
+     *  console.log('conferenceInvitationManager.onInvitationRevokedByAdmin', roomInfo, invitation, operateUser);
+     * })
+     */
+    onInvitationRevokedByAdmin = "onInvitationRevokedByAdmin",
+    /**
+     * @description 新添加会中邀请的回调
+     * @default 'onInvitationAdded'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationAdded
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
+     * })
+     */
+    onInvitationAdded = "onInvitationAdded",
+    /**
+     * @description 会中邀请被移除的回调
+     * @default 'onInvitationRemoved'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationRemoved
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
+     * })
+     */
+    onInvitationRemoved = "onInvitationRemoved",
+    /**
+     * @description 会中邀请状态变更的回调
+     * @default 'onInvitationStatusChanged'
+     * @event TUIConferenceInvitationManagerEvents#onInvitationStatusChanged
+     * @param {object} options
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {TUIInvitation} options.invitation 邀请信息。
+     *
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
+     * })
+     */
+    onInvitationStatusChanged = "onInvitationStatusChanged"
 }
 
 declare class Logger {
@@ -1103,8 +1305,8 @@ declare class TUIConferenceListManager {
     constructor(options: {
         Module: any;
         logger: Logger;
+        roomEngineWASM: any;
     });
-    setConferenceListManagerWASM(conferenceListManager: any): void;
     /**
      * @private
      * 调用 TUIRoomEngineWASM 的异步方法
@@ -1315,7 +1517,7 @@ declare class TUIConferenceListManager {
      * conferenceListManager.on(event, func);
      */
     on(event: TUIConferenceListManagerEvents, func: (...args: any[]) => void): void;
-    private setObserver;
+    private observerFunction;
     private handleConferenceChangedEvent;
     /**
      * 取消监听  ConferenceListManager 的事件
@@ -1331,6 +1533,167 @@ declare class TUIConferenceListManager {
     off(event: string, func: (...args: any[]) => void): void;
 }
 
+/**
+ * 会中呼叫
+ * @class conferenceInvitationManager
+ */
+declare class TUIConferenceInvitationManager {
+    private conferenceInvitationManagerWASM;
+    private logger;
+    private static conferenceInvitationManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    /**
+     * @private
+     * 调用 TUIRoomEngineWASM 的异步方法
+     * @param funcName
+     * @param args
+     */
+    private JSCallNativeFunctionPromise;
+    /**
+     * 会中呼叫
+     * @param {object} options
+     * @param {string} options.roomId 房间 Id，必填, roomId 限制长度为64字节，且仅支持以下范围的字符集：<br>
+     * - 大小写英文字母（a-zA-Z）
+     * - 数字（0-9）
+     * - 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
+     * @param {string} options.userIdList 成员 userId 列表。
+     * @param {number} options.timeout 超时时间。若 timeout 设置为 0s ，则无超时时间
+     * @param {string} options.extensionInfo 自定义扩展信息
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * await conferenceInvitationManager.inviteUsers({
+     *  roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
+     *  userIdList: ['123'],  // 填入您要呼叫的成员 Id 数组。
+     *  timeout: 0,
+     * })
+     */
+    inviteUsers(options: {
+        roomId: string;
+        userIdList: string[];
+        timeout: number;
+        extensionInfo?: string;
+    }): Promise<void>;
+    /**
+     * 取消呼叫
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议的房间Id。
+     * @param {string} options.userIdList 成员 userId 列表。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * await conferenceInvitationManager.cancelInvitation({
+     *  roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
+     *  userIdList: ['123'],  // 填入您要取消呼叫的成员 Id 数组。
+     * })
+     */
+    cancelInvitation(options: {
+        roomId: string;
+        userIdList: string[];
+    }): Promise<void>;
+    /**
+     * 接受呼叫
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议的房间Id。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * await conferenceInvitationManager.accept({
+     *  roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
+     * })
+     */
+    accept(options: {
+        roomId: string;
+    }): Promise<void>;
+    /**
+     * 拒绝呼叫
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议的房间Id。
+     * @param {TUIInvitationRejectedReason}options.reason 拒绝邀请的原因
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * await conferenceInvitationManager.reject({
+     *  roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
+     *  reason: TUIInvitationRejectedReason.kRejectToEnter, // 主动拒绝进入会议
+     * })
+     */
+    reject(options: {
+        roomId: string;
+        reason: TUIInvitationRejectedReason;
+    }): Promise<void>;
+    /**
+     * 获取呼叫列表
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议的房间Id。
+     * @param {string} options.cursor 分页获取索引，第一次拉取填 ""，回调成功 如果 callback 返回的数据中 cursor 不为""，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的 cursor 为""，表示数据已经全部拉取。
+     * @param {string} options.count  本次拉取数量。
+     * @returns {Promise<Array<TUIInvitation>>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * const invitationList = [];
+     * let result;
+     * let cursor = '';
+     * let totalCount = 0;
+     * let roomId = '12345';
+     * let count = 20;
+     * do {
+     *  result = await conferenceInvitationManager.getInvitationList({ roomId, cursor, count });
+     *  attendeeList.push(...result.attendeeList);
+     *  cursor = result.cursor;
+     *  totalCount = result.totalCount;
+     * } while (cursor !== '')
+     */
+    getInvitationList(options: {
+        roomId: string;
+        cursor: string;
+        count: number;
+    }): Promise<Array<TUIInvitation>>;
+    /**
+     * 监听 conferenceInvitationManager 的事件
+     * @param event TUIConferenceListManagerEvents
+     * @param func function
+     * @returns {void}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.on(event, func);
+     */
+    on(event: TUIConferenceInvitationManagerEvents, func: (...args: any[]) => void): void;
+    private observerFunction;
+    /**
+     * 取消监听  ConferenceInvitationManager 的事件
+     * @param event TUIConferenceListManagerEvents
+     * @param func function
+     * @returns {void}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     * conferenceInvitationManager.off(event, func);
+     */
+    off(event: string, func: (...args: any[]) => void): void;
+}
+
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -1344,7 +1707,7 @@ declare class TUIRoomEngine {
     private deviceManager;
     private deviceManagerWASM;
     private conferenceListManager;
-    private conferenceListManagerWASM;
+    private conferenceInvitationManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -2533,7 +2896,7 @@ declare class TUIRoomEngine {
      * roomEngine.on(event, func);
      */
     on(event: TUIRoomEvents, func: (...args: any[]) => void): void;
-    private setObserver;
+    private observerFunction;
     private supportForDeprecatedEvents;
     /**
      * 取消监听 roomEngine 的事件
@@ -2710,6 +3073,17 @@ declare class TUIRoomEngine {
      * @returns {TUIConferenceListManager} conferenceListManager
      */
     getConferenceListManager(): TUIConferenceListManager;
+    /**
+     * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
+     * @since v2.6.0
+     *
+     * @example
+     * //获取会中邀请
+     * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
+     *
+     * @returns {TUIConferenceInvitationManager} conferenceInvitationManager
+     */
+    getConferenceInvitationManager(): TUIConferenceInvitationManager;
     /**
      * 获取 trtcCloud 实例
      * @returns {TRTCCloud} trtcCloud
@@ -2741,4 +3115,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, type TUIEnterRoomOptions, TUIErrorCode, TUIKickedOutOfRoomReason, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };