Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIConferenceListManager @ TUIKitEngine
Function: 会议列表相关接口
TUIConferenceListManager
TUIConferenceListManager
函数列表 | 描述 |
会议预定回调 | |
会议即将开始回调 | |
会议取消回调 | |
会议信息变更回调 | |
参会人员变更回调 | |
会议状态变更回调 | |
添加事件回调 | |
移除事件回调 | |
预定会议 | |
取消预定会议 | |
更新预定会议信息 | |
获取预定会议列表 | |
获取预定会议邀请成员列表 | |
添加成员至邀请列表 | |
从邀请列表移除成员 |
结构体类型
函数列表 | 描述 |
会议信息 |
枚举类型
枚举类型 | 描述 |
会议状态 | |
会议取消原因 | |
预定会议信息修改标记位 |
onConferenceScheduled
会议预定回调
OnConferenceScheduled onConferenceScheduled = (TUIConferenceInfo conferenceInfo) {};
参数 | 描述 |
conferenceInfo | 会议信息 |
onConferenceWillStart
会议即将开始回调
OnConferenceWillStart onConferenceWillStart = (TUIConferenceInfo conferenceInfo) {};
参数 | 描述 |
conferenceInfo | 会议信息。 |
onConferenceCancelled
会议取消回调
OnConferenceCancelled onConferenceCancelled = (String roomId, TUIConferenceCancelReason reason, TUIUserInfo operateUser) {};
参数 | 描述 |
operateUser | 取消会议操作者信息。 |
reason | 会议取消原因。 |
roomId | 会议Id,即房间roomId。 |
onConferenceInfoChanged
会议信息变更回调
OnConferenceInfoChanged onConferenceInfoChanged = (TUIConferenceInfo conferenceInfo, List<TUIConferenceModifyFlag> modifyFlagList) {};
参数 | 描述 |
conferenceInfo | 会议信息。 |
modifyFlagList | 会议信息变更标志位。 |
onScheduleAttendeesChanged 参会人员变更回调
OnScheduleAttendeesChanged onScheduleAttendeesChanged = (String roomId, List<TUIUserInfo> leftUsers, List<TUIUserInfo> joinedUsers) {};
参数 | 描述 |
joinedUsers | 新加入成员列表。 |
leftUsers | 离开成员列表。 |
roomId | 会议Id,即房间roomId。 |
onConferenceStatusChanged
会议状态变更回调
OnConferenceStatusChanged onConferenceStatusChanged = (String roomId, TUIConferenceStatus status) {};
参数 | 描述 |
roomId | 会议Id,即房间roomId。 |
status |
addObserver
添加事件回调
void addObserver(TUIConferenceListManagerObserver observer);
参数 | 描述 |
observer | 监听的实例。 |
removeObserver
移除事件回调
void removeObserver(TUIConferenceListManagerObserver observer);
参数 | 描述 |
observer | 监听的实例。 |
scheduleConference
预定会议
Future<TUIActionCallback> scheduleConference(TUIConferenceInfo conferenceInfo);
参数 | 描述 |
conferenceInfo | 预定会议信息。 |
cancelConference
取消预定会议
Future<TUIActionCallback> cancelConference(String roomId);
参数 | 描述 |
roomId | 要取消会议的会议Id,即房间roomId。 |
updateConferenceInfo
更新预定会议信息
Future<TUIActionCallback> updateConferenceInfo(String roomId, {String? roomName,int? scheduleStartTime,int? scheduleEndTime,});
参数 | 描述 |
roomId | 房间Id。 |
roomName | 房间名称。 |
scheduleStartTime | 预定开始时间。 |
scheduleEndTime | 预定结束时间。 |
fetchScheduledConferenceList
获取预定会议列表
Future<TUIValueCallBack<TUIScheduledConferenceListResult>> fetchScheduledConferenceList(List<TUIConferenceStatus> status, String cursor, int count);
参数 | 描述 |
count | 本次拉取数量。 |
cursor | 分页获取索引,第一次拉取填 "",回调成功 如果callback返回的数据中 cursor 不为"",表示需要分页,请以返回的cursor作为参数再次调用接口拉取,直至返回的cursor为"",表示数据已经全部拉取。 |
status | 会议状态。 |
fetchAttendeeList
获取预定会议邀请成员列表
Future<TUIValueCallBack<TUIScheduledAttendeesResult>> fetchAttendeeList(String roomId, String cursor, int count);
参数 | 描述 |
count | 本次拉取数量。 |
cursor | 分页获取索引,第一次拉取填 "",回调成功 如果callback返回的数据中 cursor 不为"",表示需要分页,请以返回的cursor作为参数再次调用接口拉取,直至返回的cursor为"",表示数据已经全部拉取。 |
roomId | 预定会议会议Id,即房间roomId。 |
addAttendeesByAdmin
添加成员至邀请列表
Future<TUIActionCallback> addAttendeesByAdmin(String roomId, List<String> userIdList);
参数 | 描述 |
roomId | 预定会议Id,即房间roomId。 |
userIdList | 成员userId列表。 |
removeAttendeesByAdmin
从邀请列表移除成员
Future<TUIActionCallback> removeAttendeesByAdmin(String roomId, List<String> userIdList);
参数 | 描述 |
roomId | 预定会议Id,即房间roomId。 |
userIdList | 成员userId列表。 |
TUIConferenceStatus
TUIConferenceStatus
会议状态
枚举 | 取值 | 描述 |
none | 0 | 未知状态 |
notStarted | 1 | 会议未开始 |
running | 2 | 会议进行中(当前时间 - 预约开始时间 < 1 分钟时,会议状态从未开始转到进行中) |
TUIConferenceCancelReason
TUIConferenceCancelReason
会议取消原因
枚举 | 取值 | 描述 |
cancelledByAdmin | 0 | 房主取消 |
removedFromAttendees | 1 | 当前用户被移出参会人员列表 |
TUIConferenceModifyFlag
TUIConferenceModifyFlag
预定会议信息修改标记位
枚举 | 取值 | 描述 |
none | 0x00 | 未定义 |
roomName | 0x01 | 会议名称 |
scheduleStartTime | 0x010000 | 预定开始时间,不填写则默认为当前时间 |
scheduleEndTime | 0x020000 | 预定结束时间,不填写,则默认为预定开始时间后 1 小时(即默认的会议时长为 1 小时),会议最小持续时间不能小于 5 分钟,最长时间不能超过 24 小时 |
TUIConferenceInfo
TUIConferenceInfo
会议信息
枚举类型 | 描述 |
basicRoomInfo | 会议基础信息 |
reminderSecondsBeforeStart | 会议开始前提醒时间(秒) |
scheduleAttendees | |
scheduleEndTime | 预定会议结束时间 |
scheduleStartTime | 预定会议开始时间 |
status | 房间状态(只读) |