tencent cloud

文档反馈

Android&iOS&Flutter

最后更新时间:2024-08-09 14:23:54

    功能介绍

    TUIRoomKit 现已支持预定房间的新特性,用户可以预定一个房间并安排日程中的会议。当会议时间到来时,用户只需一键即可开启会议沟通。本文将详细介绍该特性的相关功能,并说明如何在 TUIRoomKit 组件中使用这一特性。
    
    
    

    准备条件

    在使用 TUIRoomKit 提供的预定房间特性之前,您需要完成 TUIRoomKit 组件接入的相关配置及登录,详情可参见 快速接入
    注意:
    预定房间特性需使用 TUIRoomKit v2.5.0 及以上版本。

    如何预定房间

    使用预定房间功能时,您需要拉起 TUIRoomKit 中提供的预定房间页面:
    Android
    iOS
    Flutter
    根据您的业务,只需在对应的 Activity 中调用如下代码即可预定一个房间。
    java
    kotlin
    Intent intent = new Intent(this, ScheduleConferenceActivity.class); startActivity(intent);
    val intent = Intent(this, ScheduleConferenceActivity::class.java)
    startActivity(intent)
    class YourViewController: UIViewContrller {
    // memberSelectFactory参数用于创建您的用户选择页,详细使用请参考“邀请进入房间”
    func jumpToScheduleViewController {
    let scheduleViewController =
    ScheduleConferenceViewController(memberSelectFactory: nil)
    navigationController?.pushViewController(scheduleViewController, animated: true)
    }
    }
    根据您的业务,在您需要时自行导航至 ScheduleRoomPage 预定房间界面。
    import 'package:tencent_conference_uikit/tencent_conference_uikit.dart
    
    Navigator.push(
    context,
    MaterialPageRoute(
    builder: (context) => ScheduleRoomPage(),
    ),
    );
    在预定房间页面中,填写并选择好所预定房间的相关信息后,单击预定房间,即可完成房间的预定。

    查看已预定的房间

    TUIRoomKit 中提供了房间列表的 UI 组件。通过将房间列表组件自行布局到自己的页面上,您便可以完成对当前用户所有已预定房间的查看与操作:
    Android
    iOS
    Flutter
    1. 根据您的业务,在您的布局中添加会议列表的布局:
    <!-- 以您的父布局是ConstraintLayout为例,添加如下代码 -->
    <FrameLayout android:id="@+id/tuiroomkit_fl_conference_list_container" android:layout_width="match_parent" android:layout_height="match_parent" app:layout_constraintStart_toStartOf="parent" app:layout_constraintEnd_toEndOf="parent" app:layout_constraintTop_toTopOf="parent" app:layout_constraintBottom_toBottomOf="parent"/>
    2. 在对应的 Activity 中添加如下代码,拉起会议列表:
    java
    kotlin
    ConferenceListFragment fragment = new ConferenceListFragment(); FragmentTransaction transaction = this.getSupportFragmentManager().beginTransaction(); transaction.add(R.id.tuiroomkit_fl_conference_list_container, fragment); transaction.commitAllowingStateLoss();
    val fragment = ConferenceListFragment()
    val transaction = supportFragmentManager.beginTransaction()
    transaction.add(R.id.tuiroomkit_fl_conference_list_container, fragment)
    transaction.commitAllowingStateLoss()
    class YourViewController: UIView {
    // ConferenceListView初始化时需要两个参数:
    // @param viewController,会议列表页被添加到的viewcontroller
    // @param memberSelectFactory,创建您的用户选择页,详细使用请参考“邀请进入房间”
    func showConferenceList {
    let listView = ConferenceListView(viewController: self, memberSelectFactory: nil)
    view.addSubview(listView)
    }
    }
    import 'package:flutter/material.dart';
    import 'package:tencent_conference_uikit/tencent_conference_uikit.dart';
    
    // 在您自己的页面中,添加ConferenceListWidget
    class YourPage extends StatelessWidget {
    const YourPage({Key? key}) : super(key: key);
    @override
    Widget build(BuildContext context) {
    return Scaffold(
    appBar: AppBar(title: const Text("Your Page")),
    body: Column(
    children: [
    ...YourWidgets(), // 您其他的widget,这里仅作示例。
    const ConferenceListWidget(), // 会议列表组件
    ],
    ),
    );
    }
    }

    预定房间控制

    预定房间

    在预定房间页面中,用户可根据自己的需求设置房间信息,其中可设置内容包含:房间名称房间类型开始时间房间时长时区参与成员成员管理(全体静音、全体禁画)等。邀请参与成员的功能详细介绍参见 邀请进入房间

    
    
    

    查看详情

    在房间列表中,用户可点房间以查看对应预定房间的详细信息。
    
    
    

    修改房间信息

    房间拥有者可以对已预定的房间信息进行修改,修改完毕单击保存即可将当前预定房间的信息调整为修改后的房间信息。
    其中邀请参与成员的功能详细介绍参见 邀请进入房间
    
    
    

    邀请进入房间

    用户可在预定房间界面或修改房间界面,通过单击参与成员弹出成员选择界面,您可以在这里邀请或删除参与的成员。邀请并完成房间的预定或修改后,对方的会议列表中便会出现您所预定的会议
    
    
    
    默认情况下,邀请成员用户列表为空。如您需要使用此功能,您需要通过如下方式,根据您的业务需求导入需要邀请的成员:
    Android
    iOS
    Flutter
    Android TUIRoomKit 的邀请成员列表的成员信息来自于 Chat好友关系 ,需要使用 Chat 完成好友关系的添加,并接入 tuicontact 成员列表组件。
    1. 完成以下步骤快速接入 TUIContact :
    在 Github 中克隆/下载代码,然后拷贝 Android 目录下的 tuicontact 子目录到您当前工程中的 app 同级目录中,如下图:
    
    
    
    工程根目录下找到setting.gradle(或settings.gradle.kts)文件,并在其中增加如下代码,它的作用是将 tuicontact 组件导入到您当前的项目中。
    settings.gradle
    setting.gradle.kts
    include ':tuicontact'
    include (":tuicontact")
    在 app 目录下找到build.gradle(或build.gradle.kts)文件,并在其中增加如下代码,它的作用是声明当前app对新加入的 tuicontact 组件的依赖。
    build.gradle
    build.gradle.kts
    implementation project(':tuicontact')
    implementation(project(":tuicontact"))
    2. 添加好友
    您可以在登录后通过以下代码添加好友,添加后的好友便会出现在邀请成员界面供您选择。如果您希望正式上线并使用 Chat 好友关系,请参见 Chat 好友管理文档添加好友 RestAPI
    // 添加好友
    V2TIMFriendAddApplication application = new V2TIMFriendAddApplication("邀请成员的userId");
    application.setAddType(V2TIMFriendInfo.V2TIM_FRIEND_TYPE_BOTH);
    V2TIMManager.getFriendshipManager().addFriend(application, new V2TIMValueCallback<V2TIMFriendOperationResult>() {
    @Override
    public void onSuccess(V2TIMFriendOperationResult v2TIMFriendOperationResult) {
    // 添加好友请求成功
    }
    
    @Override
    public void onError(int code, String desc) {
    // 添加好友失败
    }
    });

    如何体验邀请成员的功能

    首先参见 跑通 Demo,完成 demo 跑通。在 demo 工程的members.json文件中已经预先配置了一些用于测试的用户信息,可以选取两个账号,分别在两个手机用我们配置的 userId 登录,然后在预定会议或者编辑会议时选择另一个用户,这样另一个用户的预定列表中就会出现刚才预定的会议。
    
    
    

    代码实现成员列表页

    考虑到邀请成员页的用户列表数据的复杂性,我们设计了允许您自定义成员选择界面的方案,接下来将指导您如何集成自己的成员选择页(当然您也可以直接使用我们在 demo 中提供的 UI,这个将在后面介绍)。
    1. 准备好您的好友选择页 viewController,实现SelectMemberControllerProtocol协议。
    // 示例代码
    class SelectMemberViewController: UIViewController, SelectMemberControllerProtocol {
    weak var delegate: MemberSelectionDelegate?
    var selectedUsers: [User]
    func didSelectFinished() {
    // 在完成选择的方法中通过delegate把选择的成员回调给RoomKit
    delegate?.onMemberSelected(self, invitees: selectedMembers)
    }
    }
    2. 初始化ScheduleConferenceViewControllerConferenceListView时传入一个 closure,在 closure 中返回您在上一步中创建的SelectMemberViewController
    // 示例代码
    class YourViewController: UIViewContrller {
    func jumpToScheduleViewController {
    let scheduleViewController = ScheduleConferenceViewController { selectedList in
    return SelectMemberViewController(selectedUsers: selectedList)
    }
    navigationController?.pushViewController(scheduleViewController, animated: true)
    }
    }
    3. 通过以上两步就可以展示您自己的成员选择页了,同时我们在 demo 中提供了上面图片示例的页面代码,您可以直接把以下几个文件拷贝您的工程中,就可以直接获得我们的示例页面。
    
    
    
    SelectMembersViewModelloadMembers方法中您可以加载自己的成员列表数据(也可以直接获取 Chat 关系链数据)。
    当您需要使用邀请成员进入房间的功能时,我们提供了以下两种方案供您添加需要邀请的成员:

    方案一:使用json配置用户信息

    您可以参考我们的 example工程,在example/assets目录下,members.json中存储了邀请所需要的用户信息。使用步骤如下:
    1. 在您项目的assets目录下,新增members.json文件,列出所有您所需要的用户信息,文件格式与上文提到的members.json相同。
    2. 在您项目的pubspec.yaml中,完成以下配置:
    assets:
    - assets/members.json
    完成以上配置后,您便可以在邀请成员界面中选择您在members.json中所列出的成员。

    方案二:使用 Chat 好友信息

    当您没有配置上文所描述的members.json时,邀请好友界面会默认拉取您的 Chat 好友信息。当您需要邀请其他成员进入房间前,您可以根据您的业务侧需求,自行添加想要邀请的成员为好友。
    前提条件:登录 Chat SDK,登录操作与 登录弹幕聊天 操作相同。如您已完成其登录或已使用 会中聊天,可忽略此步骤。
    添加好友的代码如下:
    import 'package:tencent_cloud_chat_sdk/manager/v2_tim_manager.dart';
    
    // Flutter TUIRoomKit中,已有对tencent_cloud_chat_sdk的依赖,您无需另行配置
    // 将代码中的userID替换为您需要添加的用户的UserID即可完成好友的添加
    V2TIMManager().getFriendshipManager().addFriend(
    userID: 'userID', addType: FriendTypeEnum.V2TIM_FRIEND_TYPE_BOTH);
    完成好友的添加后,您便可以选择在每次预定时完成对所添加用户的邀请。
    如您需要更多相关的好友操作,请参见 好友管理。如您需要使用 Rest API 批量添加好友,请参见 添加好友 RestAPI

    注意事项

    预定房间成功后,即可获取房间号和预定信息。
    若同时预定不同日期/时间的房间,分次选择时间提交即可。
    预定房间开始时间不能早于当前时间,但没有提前天数的限制。
    预定的房间到达结束时间后,若房间没有被解散且房间内没有用户,该房间将从预定结束时间起保留6小时,在此期间您仍可以随时进入该房间。

    交流与反馈

    如果有任何需要或者反馈,您可以联系:info_rtc@tencent.com。
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持