TUIConferenceListManager

The TUIConferenceListManager API is the conference list interface of the audio and video call component. Functions on this page only support the Conference room type.

TUIConferenceListManager

Function API
Description
schedule meeting
cancel scheduled meeting
update scheduled meeting information
retrieve scheduled meeting list
retrieve list of invited members for scheduled meeting
add member to invitation list
remove member from invitation list
on
off
Cancel TUIConferenceListManagerEvents event monitoring

TUIConferenceListManagerEvents

Event API
Description
meeting reservation callback
meeting about to start callback
meeting cancellation callback
Meeting Information Change Callback
attendee change callback
meeting status change callback

Type Definition

Type
Description
meeting information.
Meeting information modification content.

Enum Definition

Type
Description
the causes for meeting cancellation
meeting status.

Function API Description

scheduleConference

Schedule meeting.
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
await conferenceListManager.scheduleConference({
roomId: '12345', // Fill in your Room ID. Note that the Room ID must be a string type.
scheduleStartTime: 1720004257, // Fill in your meeting scheduled start time timestamp in seconds.
scheduleEndTime: 1720001317, // Fill in your meeting scheduled end time timestamp in seconds.
});
Parameter:
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Room ID, required, roomId length limit is 64 bytes, only supports the following ranges of character set:
uppercase and lowercase English letters (a-zA-Z)
Numbers (0-9)
space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~
scheduleStartTime
number
Required
-
Scheduled meeting start time (timestamp in seconds)
scheduleEndTime
number
Required
-
Scheduled meeting end time (timestamp in seconds)
scheduleAttendees
Array
optional
[]
List of User IDs for invited members in scheduled meeting
reminderSecondsBeforeStart
number
optional
0
Reminder time before meeting starts (in seconds)
roomName
string
optional
roomId
room name, default value is roomId, passed in value cannot be an empty string
roomType
TUIRoomType
optional
TUIRoomType.kConference
room type
isSeatEnabled
boolean
optional
false
Whether microphone position control is enabled
seatMode
TUISeatMode
optional
TUISeatMode.kFreeToTake
Microphone mode (takes effect after enabling microphone position control)
isMicrophoneDisableForAllUser
boolean
optional
false
Whether to enable mute all. Mute all is disabled by default.
isScreenShareDisableForAllUser
boolean
optional
false
Whether to prohibit screen sharing. Prohibit screen sharing is disabled by default (this property is supported since version 2.2.0).
isCameraDisableForAllUser
boolean
optional
false
Whether to enable camera disable for all. Camera disable for all is disabled by default.
isMessageDisableForAllUser
boolean
optional
false
Whether to allow members to send messages. Members are allowed to send messages by default.
maxSeatCount
number
optional
-
Maximum number of microphones
password
string
optional
''
Room password (supported since v2.5.0)
Returns:Promise<void>

cancelConference

cancel scheduled meeting
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
await conferenceListManager.cancelConference({
roomId: '12345', // Fill in the meeting ID you want to cancel, i.e. the room ID.
);
Parameters:
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Cancel the meeting ID, i.e. the room ID.
Returns:Promise<void>

updateConferenceInfo

update scheduled meeting information
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
await conferenceListManager.updateConferenceInfo({
roomId: '12345', // Fill in the meeting room ID to be updated.
roomName: 'myRoomName', // Fill in the meeting name after update.
scheduleStartTime: 1720004257, // Fill in your meeting scheduled start time timestamp after update in seconds.
scheduleEndTime: 1720001317, // Fill in your meeting scheduled end time timestamp after update in seconds.
);
Parameters:
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Cancel the meeting ID, i.e. the room ID.
roomName
string
optional
''
meeting name
scheduleStartTime
number
optional
-
Scheduled meeting start time (timestamp in seconds)
scheduleEndTime
number
optional
-
Scheduled meeting end time (timestamp in seconds)
Returns:Promise<void>

fetchScheduledConferenceList

retrieve scheduled meeting list.
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
const conferenceList = [];
let result;
let cursor = '';
let count = 20;
do {
result = await conferenceListManager.fetchScheduledConferenceList({ cursor, count });
conferenceList.push(...result.conferenceList);
cursor = result.cursor;
} while (cursor !== '')
Parameters:
Parameter
Type
Description
Default Value
Description
statusArray
optional
-
Meeting status array, default value is all status.
cursor
string
Required
-
Pagination index retrieval, leave blank for first pull. If the API call is successful and the cursor in the returned data is not null, it means pagination is required. Please use the returned cursor as parameter to call the API again until the cursor is null, indicating all data has been pulled.
count
number
Required
-
This time pull count.
Returns:Promise<Array<TUIConferenceInfo>>

fetchAttendeeList

Retrieve list of invited members for scheduled meeting
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
const attendeeList = [];
let result;
let cursor = '';
let totalCount = 0;
let roomId = '12345';
let count = 20;
do {
result = await conferenceListManager.fetchAttendeeList({ roomId, cursor, count });
attendeeList.push(...result.attendeeList);
cursor = result.cursor;
totalCount = result.totalCount;
} while (cursor !== '')
Parameters:
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Meeting ID, also known as room ID
cursor
string
Required
''
Pagination index retrieval, leave blank for first pull. If the API call is successful and the cursor in the returned data is not null, it means pagination is required. Please use the returned cursor as parameter to call the API again until the cursor is null, indicating all data has been pulled.
count
number
Required
-
This time pull count.
Returns:Promise<Array<TUIUserInfo>>

addAttendeesByAdmin

Add member to invitation list
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
await conferenceListManager.addAttendeesByAdmin({
roomId: '12345', // Fill in the meeting ID to add member, i.e. the room ID.
userIdList: ['123'], // Fill in the member ID array you want to invite.
});
Parameters:
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Meeting ID, also known as room Id
userIdList
Array<string>
Required
-
Member User ID list
Returns:Promise<void>

removeAttendeesByAdmin

Remove member from invitation list
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
await conferenceListManager.removeAttendeesByAdmin({
roomId: '12345', // Fill in the meeting ID to remove member, i.e. the room ID.
userIdList: ['123'], // Fill in the member ID array you want to remove.
});
Parameters:
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Meeting ID, also known as room Id
userIdList
Array<string>
Required
-
Member User ID list
Returns:Promise<void>

on

const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
const callback = ({ conferenceInfo }) => {
console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);
})
conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceScheduled, callback);
Parameter
Type
Required or Not
Default Value
Description
eventName
Yes
-
Event name.
func
(...args: any[]) => void
Yes
-
event handler

off

Cancel TUIConferenceListManagerEvents event monitoring.
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
const callback = ({ conferenceInfo }) => {
console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);
})
conferenceListManager.off(TUIConferenceListManagerEvents.onConferenceScheduled, callback);
Parameter
Type
Required or Not
Default Value
Description
eventName
Yes
-
Event name.
func
(...args: any[]) => void
Yes
-
event handler

Event API Details

onConferenceScheduled

meeting reservation callback
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceScheduled, ({ conferenceInfo }) => {
console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);
})
The parameters are listed in the table below:
Parameter
Type
Description
conferenceInfo
TUIConferenceInfo
meeting information

onConferenceWillStart

meeting about to start callback
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceWillStart, ({ conferenceInfo }) => {
console.log('conferenceListManager.onConferenceWillStart', conferenceInfo);
})
The parameters are listed in the table below:
Parameter
Type
Description
conferenceInfo
meeting information

onConferenceCancelled

meeting cancellation callback
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceCancelled, ({ roomId, reason, operateUser }) => {
console.log('conferenceListManager.onConferenceCancelled', roomId, reason, operateUser);
})
The parameters are listed in the table below:
Parameter
Type
Description
roomId
string
meeting ID (roomId)
reason
reason for meeting cancellation
operateUser
Cancel meeting Operator information

onConferenceInfoChanged

Meeting Information Change Callback
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceInfoChanged, ({ conferenceModifyInfo }) => {
console.log('conferenceListManager.onConferenceInfoChanged', conferenceModifyInfo);
})
The parameters are listed in the table below:
Parameter
Type
Description
conferenceModifyInfo
Meeting change information

onScheduleAttendeesChanged

attendee change callback
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
conferenceListManager.on(TUIConferenceListManagerEvents.onScheduleAttendeesChanged, ({ roomId, leftUsers, joinedUsers }) => {
console.log('conferenceListManager.onScheduleAttendeesChanged', roomId, leftUsers, joinedUsers);
})
The parameters are listed in the table below:
Parameter
Type
Description
roomId
string
meeting ID (roomId)
leftUsers
Remove from member list
joinedUsers
Add to member list

onConferenceStatusChanged

meeting status change callback
const roomEngine = new TUIRoomEngine();
const conferenceListManager = roomEngine.getConferenceListManager();
conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceStatusChanged, ({ roomId, status }) => {
console.log('conferenceListManager.onConferenceStatusChanged', roomId, status );
})
The parameters are listed in the table below:
Parameter
Type
Description
roomId
string
meeting ID (roomId)
status
meeting status

Type Definition Details

TUIConferenceInfo

Conference information structure.
Name
Type
Description
scheduleStartTime
number
scheduled meeting start time
scheduleEndTime
number
scheduled meeting end time
scheduleAttendees
string[]
attendee list
reminderSecondsBeforeStart
number
Reminder time before meeting starts (in seconds)
status
room status (read-only)
basicRoomInfo
room information

TUIConferenceModifyInfo

Meeting information modification struct.
Name
Type
Description
scheduleStartTime
number
scheduled meeting start time
scheduleEndTime
number
scheduled meeting end time
basicRoomInfo.roomId
string
room ID
basicRoomInfo.roomName
string
room name

Enum Definition Details

TUIConferenceCancelReason

Reason for meeting cancellation.
Name
Type
Description
kConferenceCancelReasonCancelledByAdmin
number
Room owner canceled
kConferenceCancelReasonRemovedFromAttendees
number
The current user was kicked out of the attendee list

TUIConferenceStatus

Meeting status.
Name
Type
Description
kConferenceStatusNone
number
unknown status
kConferenceStatusNotStarted
number
Meeting not started
kConferenceStatusRunning
number
meeting in progress