このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
TUIConferenceListManager/

TUIConferenceListManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIConferenceListManager @ TUIKitEngine
Function: ConferenceList APIS.

TUIConferenceListManager

TUIConferenceListManager

FuncList
DESC
Callback for conference scheduled.
Callback for conference will start.
Callback for conference cancellation.
Callback for conference information change.
Callback for attendees change in the conference.
Callback for conference status change.
Add event callback.
Remove event callback.
Schedule a conference.
Cancel a scheduled conference.
Update scheduled conference information.
Fetch a list of scheduled conference.
Fetch a list of attendees invited to the scheduled conference.
Add attendees to the attendee list.
Remove attendees from the attendee list.

StructType

FuncList
DESC
Conference information

EnumType

EnumType
DESC
Conference status.
Conference cancel reason.
Scheduled conference information modify flag.

onConferenceScheduled

onConferenceScheduled
void onConferenceScheduled
(ConferenceInfo conferenceInfo)

Callback for conference scheduled.

Param
DESC
conferenceInfo
Conference information.

onConferenceWillStart

onConferenceWillStart
void onConferenceWillStart
(ConferenceInfo conferenceInfo)

Callback for conference will start.

Param
DESC
conferenceInfo
Conference information.

onConferenceCancelled

onConferenceCancelled
void onConferenceCancelled
(String roomId


TUIRoomDefine.UserInfo operateUser)

Callback for conference cancellation.

Param
DESC
operateUser
Information about the operator who cancelled the conference.
reason
The reason for the cancellation of the conference.
roomId
Conference ID, which is the room ID.

onConferenceInfoChanged

onConferenceInfoChanged
void onConferenceInfoChanged
(ConferenceInfo conferenceInfo

List<ConferenceModifyFlag> modifyFlagList)

Callback for conference information change.

Param
DESC
conferenceInfo
Conference information.
modifyFlag
Flag for conference information change.

onScheduleAttendeesChanged

onScheduleAttendeesChanged
void onScheduleAttendeesChanged
(String roomId

List<TUIRoomDefine.UserInfo> leftUsers

List<TUIRoomDefine.UserInfo> joinedUsers)

Callback for attendees change in the conference.

Param
DESC
joinedUsers
The list of attendees who have joined.
leftUsers
The list of attendees who have left.
roomId
Conference ID, which is the room ID.

onConferenceStatusChanged

onConferenceStatusChanged
void onConferenceStatusChanged
(String roomId

TUIConferenceListManager.ConferenceStatus status)

Callback for conference status change.

Param
DESC
roomId
Conference ID, which is the room ID.
status
Conference status, see TUIConferenceStatus.

addObserver

addObserver
void addObserver
(Observer observer)

Add event callback.

Param
DESC
observer
The instance being listened to.

removeObserver

removeObserver
void removeObserver
(Observer observer)

Remove event callback.

Param
DESC
observer
The instance being listened to.

scheduleConference

scheduleConference
void scheduleConference
(ConferenceInfo conferenceInfo

TUIRoomDefine.ActionCallback callback)

Schedule a conference.

Param
DESC
conferenceInfo
Information for conference.

cancelConference

cancelConference
void cancelConference
(String roomId

TUIRoomDefine.ActionCallback callback)

Cancel a scheduled conference.

Param
DESC
roomId
The conference ID, which is the room ID, to cancel the conference.

updateConferenceInfo

updateConferenceInfo
void updateConferenceInfo
(ConferenceInfo conferenceInfo

List<ConferenceModifyFlag> modifyFlagList

TUIRoomDefine.ActionCallback callback)

Update scheduled conference information.

Param
DESC
conferenceInfo
Information of scheduled conference.
modifyFlag
The flag used to update conference information.

fetchScheduledConferenceList

fetchScheduledConferenceList
void fetchScheduledConferenceList
(List<ConferenceStatus> status

String cursor

int count

FetchScheduledConferenceListCallback callback)

Fetch a list of scheduled conference.

Param
DESC
count
The number of conference to fetch this time.
cursor
Pagination index retrieval. For the first fetch, use an empty string. If the callback returns data with a non-empty cursor, it indicates that pagination is needed. Please call the interface again using the returned cursor as the parameter until the cursor returned is empty, indicating that all data has been fetched.
status
Conference status.

fetchAttendeeList

fetchAttendeeList
void fetchAttendeeList
(String roomId

String cursor

int count

FetchScheduledAttendeesCallback callback)

Fetch a list of attendees invited to the scheduled conference.

Param
DESC
count
The number of attendee to fetch this time.
cursor
Pagination index retrieval. For the first fetch, use an empty string. If the callback returns data with a non-empty cursor, it indicates that pagination is needed. Please call the interface again using the returned cursor as the parameter until the cursor returned is empty, indicating that all data has been fetched.
roomId
The conference ID, which is the room ID.

addAttendeesByAdmin

addAttendeesByAdmin
void addAttendeesByAdmin
(String roomId

List<String> userIdList

TUIRoomDefine.ActionCallback callback)

Add attendees to the attendee list.

Param
DESC
roomId
The conference ID, which is the room ID.
userIdList
List of attendee IDs.

removeAttendeesByAdmin

removeAttendeesByAdmin
void removeAttendeesByAdmin
(String roomId

List<String> userIdList

TUIRoomDefine.ActionCallback callback)

Remove attendees from the attendee list.

Param
DESC
roomId
The conference ID, which is the room ID.
userIdList
List of attendee IDs.

TUIConferenceStatus

TUIConferenceStatus

Conference status.

Enum
Value
DESC
NONE
0
None status.
NOT_STARTED
1
Not started status.
RUNNING
2
Running status(When the current time - schedule start time < 1 minute, the meeting status changes from not started to running).

TUIConferenceCancelReason

TUIConferenceCancelReason

Conference cancel reason.

Enum
Value
DESC
CANCELLED_BY_ADMIN
0
The conference has been cancelled by the admin.
REMOVED_FROM_ATTENDEES
1
The current user is removed from the attendee list.

TUIConferenceModifyFlag

TUIConferenceModifyFlag

Scheduled conference information modify flag.

Enum
Value
DESC
NONE
0x00
None
ROOM_NAME
0x01
Conference name
SCHEDULE_START_TIME
0x010000
Scheduled start time. The default is the current time.
SCHEDULE_END_TIME
0x020000
Scheduled end time.The default is one hour after the scheduled start time.The minimum duration of a conference cannot be less than 5 minutes and the maximum duration cannot exceed 24 hours.

TUIConferenceInfo

TUIConferenceInfo

Conference information

EnumType
DESC
basicRoomInfo
Conference basic information .
reminderSecondsBeforeStart
Reminder time before conference start (seconds).
scheduleAttendees
The list of attendees can be set when schedule a conference. Use the fetchAttendeeList interface if you need to fetch attendees.
scheduleEndTime
Conference schedule end time.
scheduleStartTime
Conference schedule start time.
status
Conference status (readonly).