@tencentcloud/tuiroom-engine-electron 2.5.0 → 2.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -317,6 +317,27 @@ type TUIConferenceModifyInfo = {
317
317
  roomName?: string;
318
318
  };
319
319
  };
320
+ declare enum TUIInvitationStatus {
321
+ kNone = 0,
322
+ kPending = 1,
323
+ kTimeout = 2,
324
+ kAccepted = 3,
325
+ kRejected = 4
326
+ }
327
+ declare enum TUIInvitationCode {
328
+ kSuccess = 0,
329
+ kAlreadyInInvitationList = 1,
330
+ kAlreadyInConference = 2
331
+ }
332
+ declare enum TUIInvitationRejectedReason {
333
+ kRejectToEnter = 0,
334
+ kInOtherConference = 1
335
+ }
336
+ type TUIInvitation = {
337
+ status: TUIInvitationStatus;
338
+ invitee: TUIUserInfo;
339
+ inviter: TUIUserInfo;
340
+ };
320
341
  /**
321
342
  * **TUIRoomEngine 事件列表**<br>
322
343
  * @namespace TUIRoomEvents
@@ -460,18 +481,18 @@ declare enum TUIRoomEvents {
460
481
  */
461
482
  onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
462
483
  /**
463
- * @since v2.2.0
464
- * @description 房间内所有用户屏幕分享被禁用事件
465
- * @default 'onScreenShareForAllUserDisableChanged'
466
- * @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
467
- * @param {object} options
468
- * @param {boolean} options.isDisable 是否开启禁止屏幕分享
469
- * @example
470
- * const roomEngine = new TUIRoomEngine();
471
- * roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
472
- * console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
473
- * });
474
- */
484
+ * @since v2.2.0
485
+ * @description 房间内所有用户屏幕分享被禁用事件
486
+ * @default 'onScreenShareForAllUserDisableChanged'
487
+ * @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
488
+ * @param {object} options
489
+ * @param {boolean} options.isDisable 是否开启禁止屏幕分享
490
+ * @example
491
+ * const roomEngine = new TUIRoomEngine();
492
+ * roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
493
+ * console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
494
+ * });
495
+ */
475
496
  onScreenShareForAllUserDisableChanged = "onScreenShareForAllUserDisableChanged",
476
497
  /**
477
498
  * @description 所有成员发送消息权限改变事件
@@ -906,6 +927,185 @@ declare enum TUIConferenceListManagerEvents {
906
927
  * })
907
928
  */
908
929
  onConferenceStatusChanged = "onConferenceStatusChanged"
930
+ }
931
+ /**
932
+ * @since v2.6.0
933
+ * **TUIConferenceInvitationManager 事件列表**<br>
934
+ * @namespace TUIConferenceInvitationManagerEvents
935
+ */
936
+ declare enum TUIConferenceInvitationManagerEvents {
937
+ /**
938
+ * @description 收到会中邀请回调
939
+ * @default 'onReceiveInvitation'
940
+ * @event TUIConferenceInvitationManagerEvents#onReceiveInvitation
941
+ * @param {object} options
942
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
943
+ * @param {TUIInvitation} options.invitation 邀请信息。
944
+ * @param {string} options.extensionInfo 自定义扩展信息
945
+ *
946
+ *
947
+ * @example
948
+ * const roomEngine = new TUIRoomEngine();
949
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
950
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onReceiveInvitation, ({ roomInfo, invitation, extensionInfo }) => {
951
+ * console.log('conferenceInvitationManager.onReceiveInvitation', roomInfo, invitation, extensionInfo);
952
+ * })
953
+ */
954
+ onReceiveInvitation = "onReceiveInvitation",
955
+ /**
956
+ * @description 邀请在其他设备处理的回调
957
+ * @default 'onInvitationHandledByOtherDevice'
958
+ * @event TUIConferenceInvitationManagerEvents#onInvitationHandledByOtherDevice
959
+ * @param {object} options
960
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
961
+ * @param {boolean} options.accepted 接受状态。
962
+ *
963
+ *
964
+ * @example
965
+ * const roomEngine = new TUIRoomEngine();
966
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
967
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationHandledByOtherDevice, ({ roomInfo, accepted }) => {
968
+ * console.log('conferenceInvitationManager.onInvitationHandledByOtherDevice', roomInfo, accepted);
969
+ * })
970
+ */
971
+ onInvitationHandledByOtherDevice = "onInvitationHandledByOtherDevice",
972
+ /**
973
+ * @description 会中邀请取消的回调
974
+ * @default 'onInvitationCancelled'
975
+ * @event TUIConferenceInvitationManagerEvents#onInvitationCancelled
976
+ * @param {object} options
977
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
978
+ * @param {TUIInvitation} options.invitation 邀请信息。
979
+ *
980
+ *
981
+ * @example
982
+ * const roomEngine = new TUIRoomEngine();
983
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
984
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationCancelled, ({ roomInfo, invitation }) => {
985
+ * console.log('conferenceInvitationManager.onInvitationCancelled', roomInfo, invitation);
986
+ * })
987
+ */
988
+ onInvitationCancelled = "onInvitationCancelled",
989
+ /**
990
+ * @description 会中邀请接受的回调
991
+ * @default 'onInvitationAccepted'
992
+ * @event TUIConferenceInvitationManagerEvents#onInvitationAccepted
993
+ * @param {object} options
994
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
995
+ * @param {TUIInvitation} options.invitation 邀请信息。
996
+ *
997
+ *
998
+ * @example
999
+ * const roomEngine = new TUIRoomEngine();
1000
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1001
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAccepted, ({ roomInfo, invitation }) => {
1002
+ * console.log('conferenceInvitationManager.onInvitationAccepted', roomInfo, invitation);
1003
+ * })
1004
+ */
1005
+ onInvitationAccepted = "onInvitationAccepted",
1006
+ /**
1007
+ * @description 会中邀请拒绝的回调
1008
+ * @default 'onInvitationRejected'
1009
+ * @event TUIConferenceInvitationManagerEvents#onInvitationRejected
1010
+ * @param {object} options
1011
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
1012
+ * @param {TUIInvitation} options.invitation 邀请信息。
1013
+ *
1014
+ *
1015
+ * @example
1016
+ * const roomEngine = new TUIRoomEngine();
1017
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1018
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, ({ roomInfo, invitation }) => {
1019
+ * console.log('conferenceInvitationManager.onInvitationRejected', roomInfo, invitation);
1020
+ * })
1021
+ */
1022
+ onInvitationRejected = "onInvitationRejected",
1023
+ /**
1024
+ * @description 会中邀请超时的回调
1025
+ * @default 'onInvitationTimeout'
1026
+ * @event TUIConferenceInvitationManagerEvents#onInvitationTimeout
1027
+ * @param {object} options
1028
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
1029
+ * @param {TUIInvitation} options.invitation 邀请信息。
1030
+ *
1031
+ *
1032
+ * @example
1033
+ * const roomEngine = new TUIRoomEngine();
1034
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1035
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationTimeout, ({ roomInfo, invitation }) => {
1036
+ * console.log('conferenceInvitationManager.onInvitationTimeout', roomInfo, invitation);
1037
+ * })
1038
+ */
1039
+ onInvitationTimeout = "onInvitationTimeout",
1040
+ /**
1041
+ * @description 会中邀请被管理员撤回的回调
1042
+ * @default 'onInvitationRevokedByAdmin'
1043
+ * @event TUIConferenceInvitationManagerEvents#onInvitationRevokedByAdmin
1044
+ * @param {object} options
1045
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
1046
+ * @param {TUIInvitation} options.invitation 邀请信息。
1047
+ * @param {TUIUserInfo} options.operateUser 撤回邀请的人的信息
1048
+ *
1049
+ *
1050
+ * @example
1051
+ * const roomEngine = new TUIRoomEngine();
1052
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1053
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRevokedByAdmin, ({ roomInfo, invitation, userRole }) => {
1054
+ * console.log('conferenceInvitationManager.onInvitationRevokedByAdmin', roomInfo, invitation, operateUser);
1055
+ * })
1056
+ */
1057
+ onInvitationRevokedByAdmin = "onInvitationRevokedByAdmin",
1058
+ /**
1059
+ * @description 新添加会中邀请的回调
1060
+ * @default 'onInvitationAdded'
1061
+ * @event TUIConferenceInvitationManagerEvents#onInvitationAdded
1062
+ * @param {object} options
1063
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
1064
+ * @param {TUIInvitation} options.invitation 邀请信息。
1065
+ *
1066
+ *
1067
+ * @example
1068
+ * const roomEngine = new TUIRoomEngine();
1069
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1070
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomInfo, invitation }) => {
1071
+ * console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
1072
+ * })
1073
+ */
1074
+ onInvitationAdded = "onInvitationAdded",
1075
+ /**
1076
+ * @description 会中邀请被移除的回调
1077
+ * @default 'onInvitationRemoved'
1078
+ * @event TUIConferenceInvitationManagerEvents#onInvitationRemoved
1079
+ * @param {object} options
1080
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
1081
+ * @param {TUIInvitation} options.invitation 邀请信息。
1082
+ *
1083
+ *
1084
+ * @example
1085
+ * const roomEngine = new TUIRoomEngine();
1086
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1087
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomInfo, invitation }) => {
1088
+ * console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
1089
+ * })
1090
+ */
1091
+ onInvitationRemoved = "onInvitationRemoved",
1092
+ /**
1093
+ * @description 会中邀请状态变更的回调
1094
+ * @default 'onInvitationStatusChanged'
1095
+ * @event TUIConferenceInvitationManagerEvents#onInvitationStatusChanged
1096
+ * @param {object} options
1097
+ * @param {TUIRoomInfo} options.roomInfo 会议信息。
1098
+ * @param {TUIInvitation} options.invitation 邀请信息。
1099
+ *
1100
+ *
1101
+ * @example
1102
+ * const roomEngine = new TUIRoomEngine();
1103
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1104
+ * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomInfo, invitation }) => {
1105
+ * console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
1106
+ * })
1107
+ */
1108
+ onInvitationStatusChanged = "onInvitationStatusChanged"
909
1109
  }
910
1110
 
911
1111
  declare class Logger {
@@ -917,7 +1117,7 @@ declare class Logger {
917
1117
  sdkAppId: number;
918
1118
  seq: number;
919
1119
  });
920
- getLogMessage(params: any[]): string;
1120
+ getLogMessage(params: any[]): string | any[];
921
1121
  update(options: {
922
1122
  sdkAppId: number;
923
1123
  userId: string;
@@ -1102,8 +1302,8 @@ declare class TUIConferenceListManager {
1102
1302
  constructor(options: {
1103
1303
  Module: any;
1104
1304
  logger: Logger;
1305
+ roomEngineWASM: any;
1105
1306
  });
1106
- setConferenceListManagerWASM(conferenceListManager: any): void;
1107
1307
  /**
1108
1308
  * @private
1109
1309
  * 调用 TUIRoomEngineWASM 的异步方法
@@ -1187,8 +1387,8 @@ declare class TUIConferenceListManager {
1187
1387
  * @param {object} options
1188
1388
  * @param {string} options.roomId 会议的房间Id。
1189
1389
  * @param {string} options.roomName 会议的名称。
1190
- * @param {string} options.scheduleStartTime 预定会议的开始时间(计数单位为秒的时间戳)。
1191
- * @param {string} options.scheduleEndTime 预定会议的结束时间(计数单位为秒的时间戳)。
1390
+ * @param {number} options.scheduleStartTime 预定会议的开始时间(计数单位为秒的时间戳)。
1391
+ * @param {number} options.scheduleEndTime 预定会议的结束时间(计数单位为秒的时间戳)。
1192
1392
  * @returns {Promise<void>}
1193
1393
  *
1194
1394
  * @example
@@ -1211,9 +1411,9 @@ declare class TUIConferenceListManager {
1211
1411
  * 获取预定会议列表
1212
1412
  *
1213
1413
  * @param {object} options
1214
- * @param {object} options.statusArray 会议状态数组,默认值为拉取全部状态会议。
1414
+ * @param {Array<TUIConferenceStatus>} options.statusArray 会议状态数组,默认值为拉取全部状态会议。
1215
1415
  * @param {string} options.cursor 分页获取索引,第一次拉取填 '',回调成功 如果callback返回的数据中 cursor 不为 '',表示需要分页,请以返回的 cursor 作为参数再次调用接口拉取,直至返回的cursor为 '',表示数据已经全部拉取。
1216
- * @param {string} options.count 本次拉取数量。
1416
+ * @param {number} options.count 本次拉取数量。
1217
1417
  *
1218
1418
  * @example
1219
1419
  * const roomEngine = new TUIRoomEngine();
@@ -1239,7 +1439,7 @@ declare class TUIConferenceListManager {
1239
1439
  * @param {object} options
1240
1440
  * @param {string} options.roomId 会议 Id ,即房间 roomId 。
1241
1441
  * @param {string} options.cursor 分页获取索引,第一次拉取填 "",回调成功 如果 callback 返回的数据中 cursor 不为"",表示需要分页,请以返回的 cursor 作为参数再次调用接口拉取,直至返回的 cursor 为"",表示数据已经全部拉取。
1242
- * @param {string} options.count 本次拉取数量。
1442
+ * @param {number} options.count 本次拉取数量。
1243
1443
  *
1244
1444
  * @example
1245
1445
  * const roomEngine = new TUIRoomEngine();
@@ -1267,7 +1467,7 @@ declare class TUIConferenceListManager {
1267
1467
  *
1268
1468
  * @param {object} options
1269
1469
  * @param {string} options.roomId 会议 Id ,即房间 roomId 。
1270
- * @param {string} options.userIdList 成员 userId 列表。
1470
+ * @param {Array<string>} options.userIdList 成员 userId 列表。
1271
1471
  * @returns {Promise<void>}
1272
1472
  *
1273
1473
  * @example
@@ -1287,7 +1487,7 @@ declare class TUIConferenceListManager {
1287
1487
  *
1288
1488
  * @param {object} options
1289
1489
  * @param {string} options.roomId 会议 Id ,即房间 roomId 。
1290
- * @param {string} options.userIdList 成员 userId 列表。
1490
+ * @param {Array<string>} options.userIdList 成员 userId 列表。
1291
1491
  * @returns {Promise<void>}
1292
1492
  *
1293
1493
  * @example
@@ -1314,7 +1514,7 @@ declare class TUIConferenceListManager {
1314
1514
  * conferenceListManager.on(event, func);
1315
1515
  */
1316
1516
  on(event: TUIConferenceListManagerEvents, func: (...args: any[]) => void): void;
1317
- private setObserver;
1517
+ private observerFunction;
1318
1518
  private handleConferenceChangedEvent;
1319
1519
  /**
1320
1520
  * 取消监听 ConferenceListManager 的事件
@@ -1330,6 +1530,167 @@ declare class TUIConferenceListManager {
1330
1530
  off(event: string, func: (...args: any[]) => void): void;
1331
1531
  }
1332
1532
 
1533
+ /**
1534
+ * 会中呼叫
1535
+ * @class conferenceInvitationManager
1536
+ */
1537
+ declare class TUIConferenceInvitationManager {
1538
+ private conferenceInvitationManagerWASM;
1539
+ private logger;
1540
+ private static conferenceInvitationManager;
1541
+ constructor(options: {
1542
+ Module: any;
1543
+ logger: Logger;
1544
+ roomEngineWASM: any;
1545
+ });
1546
+ /**
1547
+ * @private
1548
+ * 调用 TUIRoomEngineWASM 的异步方法
1549
+ * @param funcName
1550
+ * @param args
1551
+ */
1552
+ private JSCallNativeFunctionPromise;
1553
+ /**
1554
+ * 会中呼叫
1555
+ * @param {object} options
1556
+ * @param {string} options.roomId 房间 Id,必填, roomId 限制长度为64字节,且仅支持以下范围的字符集:<br>
1557
+ * - 大小写英文字母(a-zA-Z)
1558
+ * - 数字(0-9)
1559
+ * - 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
1560
+ * @param {string} options.userIdList 成员 userId 列表。
1561
+ * @param {number} options.timeout 超时时间。若 timeout 设置为 0s ,则无超时时间
1562
+ * @param {string} options.extensionInfo 自定义扩展信息
1563
+ * @returns {Promise<void>}
1564
+ *
1565
+ * @example
1566
+ * const roomEngine = new TUIRoomEngine();
1567
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1568
+ * await conferenceInvitationManager.inviteUsers({
1569
+ * roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
1570
+ * userIdList: ['123'], // 填入您要呼叫的成员 Id 数组。
1571
+ * timeout: 0,
1572
+ * })
1573
+ */
1574
+ inviteUsers(options: {
1575
+ roomId: string;
1576
+ userIdList: string[];
1577
+ timeout: number;
1578
+ extensionInfo?: string;
1579
+ }): Promise<void>;
1580
+ /**
1581
+ * 取消呼叫
1582
+ *
1583
+ * @param {object} options
1584
+ * @param {string} options.roomId 会议的房间Id。
1585
+ * @param {string} options.userIdList 成员 userId 列表。
1586
+ * @returns {Promise<void>}
1587
+ *
1588
+ * @example
1589
+ * const roomEngine = new TUIRoomEngine();
1590
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1591
+ * await conferenceInvitationManager.cancelInvitation({
1592
+ * roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
1593
+ * userIdList: ['123'], // 填入您要取消呼叫的成员 Id 数组。
1594
+ * })
1595
+ */
1596
+ cancelInvitation(options: {
1597
+ roomId: string;
1598
+ userIdList: string[];
1599
+ }): Promise<void>;
1600
+ /**
1601
+ * 接受呼叫
1602
+ *
1603
+ * @param {object} options
1604
+ * @param {string} options.roomId 会议的房间Id。
1605
+ * @returns {Promise<void>}
1606
+ *
1607
+ * @example
1608
+ * const roomEngine = new TUIRoomEngine();
1609
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1610
+ * await conferenceInvitationManager.accept({
1611
+ * roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
1612
+ * })
1613
+ */
1614
+ accept(options: {
1615
+ roomId: string;
1616
+ }): Promise<void>;
1617
+ /**
1618
+ * 拒绝呼叫
1619
+ *
1620
+ * @param {object} options
1621
+ * @param {string} options.roomId 会议的房间Id。
1622
+ * @param {TUIInvitationRejectedReason}options.reason 拒绝邀请的原因
1623
+ * @returns {Promise<void>}
1624
+ *
1625
+ * @example
1626
+ * const roomEngine = new TUIRoomEngine();
1627
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1628
+ * await conferenceInvitationManager.reject({
1629
+ * roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
1630
+ * reason: TUIInvitationRejectedReason.kRejectToEnter, // 主动拒绝进入会议
1631
+ * })
1632
+ */
1633
+ reject(options: {
1634
+ roomId: string;
1635
+ reason: TUIInvitationRejectedReason;
1636
+ }): Promise<void>;
1637
+ /**
1638
+ * 获取呼叫列表
1639
+ *
1640
+ * @param {object} options
1641
+ * @param {string} options.roomId 会议的房间Id。
1642
+ * @param {string} options.cursor 分页获取索引,第一次拉取填 "",回调成功 如果 callback 返回的数据中 cursor 不为"",表示需要分页,请以返回的 cursor 作为参数再次调用接口拉取,直至返回的 cursor 为"",表示数据已经全部拉取。
1643
+ * @param {string} options.count 本次拉取数量。
1644
+ * @returns {Promise<Array<TUIInvitation>>}
1645
+ *
1646
+ * @example
1647
+ * const roomEngine = new TUIRoomEngine();
1648
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1649
+ * const invitationList = [];
1650
+ * let result;
1651
+ * let cursor = '';
1652
+ * let totalCount = 0;
1653
+ * let roomId = '12345';
1654
+ * let count = 20;
1655
+ * do {
1656
+ * result = await conferenceInvitationManager.getInvitationList({ roomId, cursor, count });
1657
+ * attendeeList.push(...result.attendeeList);
1658
+ * cursor = result.cursor;
1659
+ * totalCount = result.totalCount;
1660
+ * } while (cursor !== '')
1661
+ */
1662
+ getInvitationList(options: {
1663
+ roomId: string;
1664
+ cursor: string;
1665
+ count: number;
1666
+ }): Promise<Array<TUIInvitation>>;
1667
+ /**
1668
+ * 监听 conferenceInvitationManager 的事件
1669
+ * @param event TUIConferenceListManagerEvents
1670
+ * @param func function
1671
+ * @returns {void}
1672
+ *
1673
+ * @example
1674
+ * const roomEngine = new TUIRoomEngine();
1675
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1676
+ * conferenceInvitationManager.on(event, func);
1677
+ */
1678
+ on(event: TUIConferenceInvitationManagerEvents, func: (...args: any[]) => void): void;
1679
+ private observerFunction;
1680
+ /**
1681
+ * 取消监听 ConferenceInvitationManager 的事件
1682
+ * @param event TUIConferenceListManagerEvents
1683
+ * @param func function
1684
+ * @returns {void}
1685
+ *
1686
+ * @example
1687
+ * const roomEngine = new TUIRoomEngine();
1688
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
1689
+ * conferenceInvitationManager.off(event, func);
1690
+ */
1691
+ off(event: string, func: (...args: any[]) => void): void;
1692
+ }
1693
+
1333
1694
  /**
1334
1695
  * TUIRoomEngine 提供了音视频房间的能力
1335
1696
  *
@@ -1342,7 +1703,7 @@ declare class TUIRoomEngine {
1342
1703
  private trtcCloud;
1343
1704
  private deviceManager;
1344
1705
  private conferenceListManager;
1345
- private conferenceListManagerWASM;
1706
+ private conferenceInvitationManager;
1346
1707
  private static userId;
1347
1708
  private static sdkAppId;
1348
1709
  private static Module;
@@ -1537,14 +1898,21 @@ declare class TUIRoomEngine {
1537
1898
  exitRoom(): Promise<void>;
1538
1899
  /**
1539
1900
  * 获取房间信息
1901
+ * @param {object} options
1902
+ * @param {string} options.roomId 要获取信息的房间Id。
1903
+ * @param {TUIRoomType} options.roomType 要获取信息的房间类型。
1540
1904
  * @returns {Promise<TUIRoomInfo>} roomInfo
1541
- * 获取房间信息
1542
- *
1543
1905
  * @example
1544
1906
  * const roomEngine = new TUIRoomEngine();
1545
- * const roomInfo = await roomEngine.fetchRoomInfo();
1907
+ * const roomInfo = await roomEngine.fetchRoomInfo({
1908
+ * roomId: '12345',
1909
+ * roomType: TUIRoomType.kConference,
1910
+ * });
1546
1911
  */
1547
- fetchRoomInfo(): Promise<TUIRoomInfo>;
1912
+ fetchRoomInfo(options?: {
1913
+ roomId: string;
1914
+ roomType: TUIRoomType;
1915
+ }): Promise<TUIRoomInfo>;
1548
1916
  /**
1549
1917
  * 更新房间的名字(仅群主或者管理员可以调用)
1550
1918
  * @param {object} options
@@ -1580,7 +1948,7 @@ declare class TUIRoomEngine {
1580
1948
  *
1581
1949
  * @since v2.5.0
1582
1950
  * @param {object} options
1583
- * @param {string} options.password 房间密码
1951
+ * @param {string} options.password 房间密码,传入空字符串则代表关闭房间密码
1584
1952
  * @returns {Promise<void>}
1585
1953
  *
1586
1954
  * @example
@@ -2522,7 +2890,7 @@ declare class TUIRoomEngine {
2522
2890
  * roomEngine.on(event, func);
2523
2891
  */
2524
2892
  on(event: TUIRoomEvents, func: (...args: any[]) => void): void;
2525
- private setObserver;
2893
+ private observerFunction;
2526
2894
  private supportForDeprecatedEvents;
2527
2895
  /**
2528
2896
  * 取消监听 roomEngine 的事件
@@ -2685,6 +3053,17 @@ declare class TUIRoomEngine {
2685
3053
  * @returns {TUIConferenceListManager} conferenceListManager
2686
3054
  */
2687
3055
  getConferenceListManager(): TUIConferenceListManager;
3056
+ /**
3057
+ * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
3058
+ * @since v2.6.0
3059
+ *
3060
+ * @example
3061
+ * //获取会中邀请
3062
+ * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
3063
+ *
3064
+ * @returns {TUIConferenceInvitationManager} conferenceInvitationManager
3065
+ */
3066
+ getConferenceInvitationManager(): TUIConferenceInvitationManager;
2688
3067
  /**
2689
3068
  * 获取 trtcCloud 实例
2690
3069
  * @returns {TRTCCloud} trtcCloud
@@ -2716,4 +3095,4 @@ declare class TUIRoomEngine {
2716
3095
  private static handleSetFramework;
2717
3096
  }
2718
3097
 
2719
- 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 };
3098
+ 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 };