Merge pull request #564 from haoxiuwen/chatroomuikit

Modify Chatroom UIKit Docs
easemob · Jan 2, 2024 · 9ba9c7d · 9ba9c7d
2 parents 0bab15c + 1972d9b
commit 9ba9c7d
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 55 deletions.
diff --git a/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md
@@ -57,8 +57,12 @@ class ChatroomActivity : ComponentActivity(){
 
 ## 监听 ChatroomUIKit 事件和错误
 
-你可以调用 `registerRoomEventsListener` 方法添加监听器用于监听 ChatroomUIKit 事件和错误。
+你可以调用 `registerRoomResultListener` 方法添加监听器用于监听 ChatroomUIKit 事件和错误。
 
-```Kotlin
+```kotlin
 ChatroomUIKitClient.getInstance().registerRoomResultListener(this)
-```
+```
+
+## 参考
+
+若要了解以上最佳实践的详情，请访问 [GitHub 仓库](https://github.com/easemob/ChatroomDemo/tree/dev/Android/ChatroomDemo)。
diff --git a/docs/uikit/chatroomuikit/android/roomuikit_config_item.md b/docs/uikit/chatroomuikit/android/roomuikit_config_item.md
@@ -1,4 +1,4 @@
-# 可配项修改
+# 可配项
 
 <Toc />
 

diff --git a/docs/uikit/chatroomuikit/android/roomuikit_integrated.md b/docs/uikit/chatroomuikit/android/roomuikit_integrated.md
@@ -14,9 +14,7 @@
 - JDK 1.8 或以上版本；
 - Gradle 7.0.0 或以上版本。
 
-## 添加 ChatroomUIKit 模块依赖
-
-### 本地依赖
+## 添加 ChatroomUIKit 模块本地依赖
 
 找到下载的 **ChatroomUIKit** 模块添加为本地依赖。将 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomUIKit) 和 [ChatroomService](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomService) 模块导入到项目中。
 
@@ -33,11 +31,3 @@ dependencies {
 }
 ```
 
-### 远程依赖 
-
-在集成 ChatroomUIKit 的 app 目录下的 `build.gradle` 中添加下行代码：
-
-```
-implementation 'ChatroomUIKit'
-```
-
diff --git a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md
@@ -20,9 +20,7 @@
 
 2. 选择 **File** > **import Module**。
 
-3. 添加模块依赖。
-
-- 本地依赖：
+3. 模块本地依赖。
 
 找到下载的 **ChatroomUIKit** 模块添加为本地依赖。将 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomUIKit) 和 [ChatroomService](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomService) 模块导入到项目中。
 
@@ -39,14 +37,6 @@ dependencies {
 }
 ```
 
-- 远程依赖：
-
-在集成 ChatroomUIKit 的 app 目录下的 `build.gradle` 中添加下行代码：
-
-```
-implementation 'ChatroomUIKit'
-```
-
 ### 第一步 初始化 ChatroomUIKit
 
 你可以在应用加载时或使用 ChatroomUIKit 之前对其进行初始化。

diff --git a/docs/uikit/chatroomuikit/android/roomuikit_run.md b/docs/uikit/chatroomuikit/android/roomuikit_run.md
@@ -28,9 +28,7 @@
 
 2. 选择 **File** > **import Module**。
 
-3. 添加模块依赖。
-
-- 本地依赖：
+3. 添加模块本地依赖。
 
 找到下载的 **ChatroomUIKit** 模块添加为本地依赖。将 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomUIKit) 和 [ChatroomService](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomService) 模块导入到项目中。
 
@@ -47,14 +45,6 @@ dependencies {
 }
 ```
 
-- 远程依赖：
-
-在集成 ChatroomUIKit 的 app 目录下的 `build.gradle` 中添加下行代码：
-
-```
-implementation 'ChatroomUIKit'
-```
-
 ### 第三步 编译
 
 编译时，需要传入 App Key、用户 ID 和用户 token。因此，编译前，你需要在[环信控制台](https://console.easemob.com/user/login)上创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。此外，还需[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)。

diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/ios/roomuikit_best_practice.md
@@ -68,4 +68,8 @@ addSubView(roomView)
 
 ```Swift
 ChatroomUIKitClient.shared.registerRoomEventsListener（listener：self）
-```
+```
+
+## 参考
+
+若要了解以上最佳实践的详情，请访问 [GitHub 仓库](https://github.com/easemob/ChatroomDemo/tree/dev/iOS/ChatroomDemo)。
diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_config_item.md b/docs/uikit/chatroomuikit/ios/roomuikit_config_item.md
@@ -1,4 +1,4 @@
-# 可配项修改
+# 可配项
 
 Appearance.swift 是容纳了所有可配项的类，你需要在初始化 ChatroomView 之前修改其中的属性。
 

diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_overview.md b/docs/uikit/chatroomuikit/ios/roomuikit_overview.md
@@ -32,11 +32,3 @@ ChatroomUIKit 提供以下功能：
   - 搜索成员：在聊天室中查找指定成员的功能，支持支持本地搜索和模糊匹配。
   - 禁言成员：聊天室所有者可以在聊天室中对某个特定的成员禁言。
   - 移除成员：聊天室所有者将指定成员从聊天室中踢出。
-
-## 聊天室事件
-
-ChatroomUIKit 中提供了聊天室事件的监听接口。你可以通过注册聊天室监听器，获取聊天室事件，并作出相应处理。
-
-```swift
-ChatroomUIKitClient.shared.registerRoomEventsListener(listener: self)
-```
diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_overview.md b/docs/uikit/chatroomuikit/react-native/roomuikit_overview.md
@@ -33,10 +33,3 @@ ChatroomUIKit 提供以下功能：
   - 禁言成员：聊天室所有者可以在聊天室中对某个特定的成员禁言。
   - 移除成员：聊天室所有者将指定成员从聊天室中踢出。
 
-## 聊天室事件
-
-ChatroomUIKit 中提供了聊天室事件的监听接口。你可以通过注册聊天室监听器，获取聊天室事件，并作出相应处理。
-
-```
-
-```
diff --git a/docs/uikit/chatroomuikit/web/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/web/roomuikit_best_practice.md
@@ -54,3 +54,7 @@ ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
     </UIKitProvider>
 )
 ```
+
+## 参考
+
+若要了解以上最佳实践的详情，请访问 [GitHub 仓库](https://github.com/easemob/ChatroomDemo/tree/dev/WEB/ChatroomDemo)。
diff --git a/docs/uikit/chatroomuikit/web/roomuikit_config_item.md b/docs/uikit/chatroomuikit/web/roomuikit_config_item.md
@@ -1,4 +1,4 @@
-# 可配置项
+# 可配项
 
 <Toc />