快速开始

利用 ChatroomUIKit，你可以轻松实现聊天室内的用户交互。本文介绍如何实现在聊天室中发送消息。

推荐环境

• Android Studio Arctic Fox (2020.3.1) 或以上版本；
• Android API 级别 21 或以上；
• 使用 Kotlin 语言开发，1.5.21 或以上版本；
• JDK 1.8 或以上版本；
• Gradle 8.0 或以上版本；
• 已在环信控制台创建了有效的环信即时通讯 IM 开发者账号，并获取了 App Key。
• 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。

创建项目引入 ChatroomUIKit 模块

1. 在 Android Studio 中创建一个 Android 平台下的 App 或者打开自己现有项目。

2. 模块依赖。 方式一：（推荐）Gradle 远程依赖 ① 在 Project 工程根目录下的 settings.gradle.kts 文件内，添加 mavenCentral() 仓库：

pluginManagement {
   repositories {
      ...
      mavenCentral()
   }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        ...
        mavenCentral()
    }
}

② 在 app(module) 目录的 build.gradle.kts 文件中添加以下依赖。关于 ChatroomUIKit 的最新版本，详见 Maven 仓库。

dependencies {
    ...
    implementation ("io.hyphenate:ease-chatroomui-kit:1.1.0")
}

方式二：本地源码集成

从 GitHub 获取音视频 ChatroomUIKit，克隆到本地。按照以下步骤集成：

① 在 Project 工程根目录下的 settings.gradle.kts 文件中添加如下代码：

include(":ChatroomUIKit")
// "../UIKit_Chatroom_android" 要替换成你克隆的实际工程路径，后边要拼接 "/ChatroomUIKit"
project(":ChatroomUIKit").projectDir = File("../UIKit_Chatroom_android/ChatroomUIKit")

② 在 app(module) 目录的 build.gradle.kts 文件中添加如下代码：

dependencies {
    ...
    implementation(project(mapOf("path" to ":ChatroomUIKit")))
}

跑通项目

第一步 初始化 ChatroomUIKit

你可以在应用加载时或使用 ChatroomUIKit 之前对其进行初始化。

初始化时，需传入 App Key。你可以在环信控制台的应用概览页面查看 App Key。

// 初始化 ChatroomUIKit   
class ChatroomApplication : Application() {

  override fun onCreate() {
    super.onCreate()

    ChatroomUIKitClient.getInstance().setUp(this, "Your AppKey")

  }
}

第二步 登录 ChatroomUIKit

在 环信控制台 创建用户，获取用户 ID 和用户 token 登录 ChatroomUIKit。详见 创建用户文档。

提示

若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录 ChatroomUIKit。

在生产环境中，为了安全考虑，你需要在你的应用服务器集成 获取 App Token API 和 获取用户 Token API 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。

 ChatroomUIKitClient.getInstance().login("userId", "token")

第三步 创建聊天室视图

创建聊天室视图的步骤如下：

1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上 创建聊天室，获取聊天室 ID。

2. 加载聊天室视图 ComposeChatroom，传入的参数包括聊天室 ID 和聊天室所有者的用户 ID。

class ChatroomActivity : ComponentActivity(){
	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)
		setContent {
			ComposeChatroom(roomId = roomId,roomOwner = ownerInfo)
		}
	}
}

3. 添加聊天室成员。

第四步 发送消息

在屏幕下方输入消息内容，点击 发送 按钮，发送消息。