Skip to content

Commit 21fc449

Browse files
authored
Merge pull request #977 from haoxiuwen/chatuikitimage
Modify UIKit Docs
2 parents 7860a6a + 8958f95 commit 21fc449

15 files changed

+197
-195
lines changed
146 KB
Loading
234 KB
Loading
236 KB
Loading

docs/uikit/chatuikit/android/chatfeature_common.md

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -82,40 +82,6 @@
8282

8383
![img](/images/uikit/chatuikit/feature/common/message_report.png =300x630)
8484

85-
## 输入状态指示
86-
87-
输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。
88-
89-
输入状态指示的 UI 和逻辑结构如下:
90-
- `EaseTitleBar` 中的 `subtitle` 控件显示用户的状态以及输入状态指示,收到输入状态后会先显示输入状态,用户取消输入状态后显示用户的状态,输入状态消失。
91-
- 输入状态相关回调和方法:
92-
- 输入状态投递为透传消息,接收到透传消息后,通过 `EaseChatFragment.Builder` 提供的 `setOnPeerTypingListener` 监听对方输入状态。
93-
- 输入状态回调为 `onPeerTyping(action: String?)`,其中 `action` 代表状态 `EaseChatLayout.ACTION_TYPING_BEGI``EaseChatLayout.ACTION_TYPING_END`
94-
95-
| 开启输入状态提示 | 关闭输入状态提示 |
96-
| :-------------- | :----- |
97-
| <img src=/images/uikit/chatuikit/feature/common/typing_indicator_enable.png width="300"/> |<img src=/images/uikit/chatuikit/feature/common/typing_indicator_disable.png width="300"/> |
98-
99-
### 如何使用
100-
101-
输入状态指示特性在 `EaseIM.getConfig()?.chatConfig?.enableChatTyping` 中默认开启,即 `enableChatTyping` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
102-
103-
同时也支持通过代码进行设置,`EaseChatFragment.Builder` 提供开启或关闭的 API `builder.turnOnTypingMonitor(true|false)`。通过代码设置优先级更高。
104-
105-
示例代码如下:
106-
107-
```kotlin
108-
109-
EaseIM.getConfig()?.chatConfig?.enableChatTyping = true
110-
111-
```
112-
113-
### 自定义输入状态指示 UI
114-
115-
本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/android/message_send_receive.html#通过透传消息实现输入指示器)
116-
117-
用户需要监听透传消息回调处理导航相关 UI 显示效果。
118-
11985
## 本地搜索
12086

12187
本地搜索功能允许用户快速根据类型搜索,包括搜索联系人(带有或无选择框)、会话、历史消息和黑名单,支持关键词匹配。该功能帮助用户高效找到所需信息,提高工作效率和信息管理的便捷性。
@@ -128,7 +94,7 @@ UIKit 提供封装的 `EaseSearchActivity` 搜索页面,用户根据 `EaseSear
12894

12995
![img](/images/uikit/chatuikit/feature/common/message_search.png)
13096

131-
### 如何使用
97+
#### 如何使用
13298

13399
跳转 `EaseSearchActivity` 页面,根据自己需要搜索的类型(`EaseSearchType:USER、SELECT_USER、CONVERSATION、MESSAGE、BLOCK_USER`)传入需要的参数,将匹配关键词并展示搜索结果。
134100

@@ -168,7 +134,7 @@ UIKit 提供封装的 `EaseSearchActivity` 搜索页面,用户根据 `EaseSear
168134

169135
![img](/images/uikit/chatuikit/feature/common/[email protected])
170136

171-
### 如何使用
137+
#### 如何使用
172138

173139
群组@提及特性默认开启。要关闭该特性,则不需理会 `MessageListController#onInputBoxEventsOccur` 方法,记重载此方法后不需要处理 mention 事件即可。
174140

docs/uikit/chatuikit/android/chatfeature_conversation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@
88

99
会话已读是指显示用户是否已阅读过含有未读消息的特定会话。
1010

11-
在单群聊 UIKit 中,用户可以通过左滑会话/右滑会话或长按会话的操作触发会话拓展功能菜单,选择会话已读选项,指定会话将会被置为已读。
11+
在单群聊 UIKit 中,用户可以通过长按会话的操作触发会话拓展功能菜单,选择会话已读选项,指定会话将会被置为已读。
1212

1313
![img](/images/uikit/chatuikit/feature/conversation/conversation_read.png)
1414

1515
## 会话置顶
1616

1717
会话置顶是指用户将重要的会话固定在聊天列表顶部,方便快速访问常用或优先级别的会话。
1818

19-
在单群聊 UIKit 中,用户可以通过左滑会话/右滑会话或长按会话的操作触发会话拓展功能菜单,选择会话置顶选项,指定会话将会被放置在会话列表前排区域。
19+
在单群聊 UIKit 中,用户可以通过长按会话的操作触发会话拓展功能菜单,选择会话置顶选项,指定会话将会被放置在会话列表前排区域。
2020

21-
![img](/images/uikit/chatuikit/feature/conversation/conversation_pin.png)
21+
![img](/images/uikit/chatuikit/feature/conversation/conversation_pin_android.png)
2222

2323
## 会话免打扰
2424

2525
会话免打扰是指用户暂时关闭特定会话的通知,避免被打扰。
2626

27-
在单群聊 UIKit 中,用户可以通过左滑会话/右滑会话或长按会话的操作触发会话拓展功能菜单,选择会话免打扰选项,指定会话将不再接收通知。
27+
在单群聊 UIKit 中,用户可以通过长按会话的操作触发会话拓展功能菜单,选择会话免打扰选项,指定会话将不再接收通知。
2828

29-
![img](/images/uikit/chatuikit/feature/conversation/conversation_dnd.png)
29+
![img](/images/uikit/chatuikit/feature/conversation/conversation_dnd_android.png)
3030

3131
## 会话删除
3232

3333
会话删除是指用户永久删除不再需要的会话,清理会话列表。
3434

35-
在单群聊 UIKit 中,用户可以通过左滑会话/右滑会话或长按会话的操作触发会话拓展功能菜单,选择会话删除选项,指定会话将会被删除。
35+
在单群聊 UIKit 中,用户可以通过长按会话的操作触发会话拓展功能菜单,选择会话删除选项,指定会话将会被删除。
3636

37-
![img](/images/uikit/chatuikit/feature/conversation/conversation_delete.png)
37+
![img](/images/uikit/chatuikit/feature/conversation/conversation_delete_android.png)

docs/uikit/chatuikit/android/chatfeature_message.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
![img](/images/uikit/chatuikit/feature/message/message_reply.png)
4343

44-
### 如何使用
44+
#### 如何使用
4545

4646
消息转发特性在 `EaseChatConfig` 中默认开启,即 `enableReplyMessage` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
4747

@@ -67,7 +67,7 @@
6767

6868
![img](/images/uikit/chatuikit/feature/message/message_translate.png)
6969

70-
### 如何使用
70+
#### 如何使用
7171

7272
使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。
7373

@@ -114,7 +114,7 @@
114114

115115
![img](/images/uikit/chatuikit/feature/message/message_reactions.png)
116116

117-
### 如何使用
117+
#### 如何使用
118118

119119
使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。
120120

@@ -134,7 +134,7 @@
134134

135135
![img](/images/uikit/chatuikit/feature/message/message_thread.png)
136136

137-
### 如何使用
137+
#### 如何使用
138138

139139
使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。
140140

@@ -148,7 +148,7 @@
148148

149149
```
150150

151-
### 如何自定义
151+
#### 如何自定义
152152

153153
你可以通过继承 `EaseChatThreadActivity` 添加自己的逻辑,示例如下:
154154

@@ -174,7 +174,7 @@ class ChatThreadActivity:EaseChatThreadActivity() {
174174

175175
![img](/images/uikit/chatuikit/feature/message/message_forward.png)
176176

177-
### 如何使用
177+
#### 如何使用
178178

179179
消息转发特性在 `EaseChatConfig` 中默认开启,即 `enableSendCombineMessage` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
180180

@@ -200,7 +200,7 @@ class ChatThreadActivity:EaseChatThreadActivity() {
200200

201201
![img](/images/uikit/chatuikit/feature/message/message_pin.png)
202202

203-
### 如何使用
203+
#### 如何使用
204204

205205
消息置顶特性在 `EaseChatConfig` 中默认开启,即 `enableChatPingMessage` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
206206

@@ -260,6 +260,39 @@ class ChatThreadActivity:EaseChatThreadActivity() {
260260

261261
```
262262

263+
## 输入状态指示
264+
265+
输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。
266+
267+
输入状态指示的 UI 和逻辑结构如下:
268+
- `EaseTitleBar` 中的 `subtitle` 控件显示用户的状态以及输入状态指示,收到输入状态后会先显示输入状态,用户取消输入状态后显示用户的状态,输入状态消失。
269+
- 输入状态相关回调和方法:
270+
- 输入状态投递为透传消息,接收到透传消息后,通过 `EaseChatFragment.Builder` 提供的 `setOnPeerTypingListener` 监听对方输入状态。
271+
- 输入状态回调为 `onPeerTyping(action: String?)`,其中 `action` 代表状态 `EaseChatLayout.ACTION_TYPING_BEGI``EaseChatLayout.ACTION_TYPING_END`
272+
273+
| 开启输入状态提示 | 关闭输入状态提示 |
274+
| :-------------- | :----- |
275+
| <img src=/images/uikit/chatuikit/feature/common/typing_indicator_enable.png width="300"/> |<img src=/images/uikit/chatuikit/feature/common/typing_indicator_disable.png width="300"/> |
276+
277+
#### 如何使用
278+
279+
输入状态指示特性在 `EaseIM.getConfig()?.chatConfig?.enableChatTyping` 中默认开启,即 `enableChatTyping` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
280+
281+
同时也支持通过代码进行设置,`EaseChatFragment.Builder` 提供开启或关闭的 API `builder.turnOnTypingMonitor(true|false)`。通过代码设置优先级更高。
282+
283+
示例代码如下:
284+
285+
```kotlin
286+
287+
EaseIM.getConfig()?.chatConfig?.enableChatTyping = true
288+
289+
```
290+
291+
#### 自定义输入状态指示 UI
292+
293+
本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/android/message_send_receive.html#通过透传消息实现输入指示器)
294+
295+
用户需要监听透传消息回调处理导航相关 UI 显示效果。
263296

264297

265298

docs/uikit/chatuikit/flutter/chatfeature_common.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -82,26 +82,6 @@
8282

8383
![img](/images/uikit/chatuikit/feature/common/message_report.png =300x630)
8484

85-
## 输入状态指示
86-
87-
输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。
88-
89-
本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/android/message_send_receive.html#通过透传消息实现输入指示器)
90-
91-
| 开启输入状态提示 | 关闭输入状态提示 |
92-
| :-------------- | :----- |
93-
| <img src=/images/uikit/chatuikit/feature/flutter/typing_indicator_enable.png width="300"/> |<img src=/images/uikit/chatuikit/feature/flutter/typing_indicator_disable.png width="300"/> |
94-
95-
### 如何使用
96-
97-
输入状态指示特性在 `ChatUIKitSettings.enableTypingIndicator` 中默认开启,即默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
98-
99-
示例代码如下:
100-
101-
```
102-
ChatUIKitSettings.enableTypingIndicator = false;
103-
```
104-
10585
## 本地消息搜索
10686

10787
本地消息搜索功能允许用户快速在会话内搜索历史消息内容,支持关键词匹配。该功能帮助用户高效找到所需信息,提高工作效率和信息管理的便捷性。

docs/uikit/chatuikit/flutter/chatfeature_message.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
![img](/images/uikit/chatuikit/feature/message/message_recall.png)
2626

27-
### 如何使用
27+
#### 如何使用
2828

2929
消息撤回功能默认开启,即 `ChatUIKitSettings.enableMessageRecall` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`。 示例代码如下:
3030

@@ -44,7 +44,7 @@ ChatUIKitSettings.recallExpandTime = 120;
4444

4545
![img](/images/uikit/chatuikit/feature/message/message_edit.png)
4646

47-
### 如何使用
47+
#### 如何使用
4848

4949
消息编辑功能默认开启,即 `ChatUIKitSettings.enableMessageEdit` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`。 示例代码如下:
5050

@@ -63,7 +63,7 @@ ChatUIKitSettings.enableMessageEdit = false;
6363
- `ChatUIKitQuoteWidget`:消息气泡的引用消息自定义 View。
6464
- `ChatUIKitReplyBar`:底部输入框组件上方展示的引用消息自定义 View。
6565

66-
### 如何使用
66+
#### 如何使用
6767

6868
消息转发特性默认开启,即 `ChatUIKitSettings.enableMessageReply` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
6969

@@ -83,7 +83,7 @@ ChatUIKitSettings.enableMessageReply = false;
8383

8484
![img](/images/uikit/chatuikit/feature/message/message_translate.png)
8585

86-
### 如何使用
86+
#### 如何使用
8787

8888
使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。
8989

@@ -119,7 +119,7 @@ ChatUIKitSettings.translateTargetLanguage = 'zh-Hans';
119119

120120
![img](/images/uikit/chatuikit/feature/message/message_reactions.png)
121121

122-
### 如何使用
122+
#### 如何使用
123123

124124
使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。
125125

@@ -135,7 +135,7 @@ ChatUIKitSettings.enableMessageReaction = true;
135135

136136
![img](/images/uikit/chatuikit/feature/message/message_thread.png)
137137

138-
### 如何使用
138+
#### 如何使用
139139

140140
使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。
141141

@@ -157,7 +157,7 @@ ChatUIKitSettings.enableMessageThread = true;
157157

158158
![img](/images/uikit/chatuikit/feature/message/message_forward.png)
159159

160-
### 如何使用
160+
#### 如何使用
161161

162162
消息转发特性在 `ChatUIKitSettings.enableMessageMultiSelect` 中提供开关,默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
163163

@@ -175,7 +175,7 @@ ChatUIKitSettings.enableMessageMultiSelect = true;
175175

176176
- 选择转发消息接收人页面 `ForwardMessageSelectView`
177177

178-
### 如何使用
178+
#### 如何使用
179179

180180
该功能默认开启,即 `ChatUIKitSettings.enableMessageForward` 的默认值为 `true`。如果不需要,可以将参数设置为 `false`。 示例代码如下:
181181

@@ -189,7 +189,7 @@ ChatUIKitSettings.enableMessageForward = false;
189189

190190
![img](/images/uikit/chatuikit/feature/message/message_pin.png)
191191

192-
### 如何使用
192+
#### 如何使用
193193

194194
消息置顶功能默认开启,即 `ChatUIKitSettings.enablePinMsg` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
195195

@@ -199,3 +199,24 @@ ChatUIKitSettings.enableMessageForward = false;
199199
ChatUIKitSettings.enablePinMsg = false;
200200
```
201201

202+
## 输入状态指示
203+
204+
输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。
205+
206+
本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/android/message_send_receive.html#通过透传消息实现输入指示器)
207+
208+
| 开启输入状态提示 | 关闭输入状态提示 |
209+
| :-------------- | :----- |
210+
| <img src=/images/uikit/chatuikit/feature/flutter/typing_indicator_enable.png width="300"/> |<img src=/images/uikit/chatuikit/feature/flutter/typing_indicator_disable.png width="300"/> |
211+
212+
#### 如何使用
213+
214+
输入状态指示特性在 `ChatUIKitSettings.enableTypingIndicator` 中默认开启,即默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
215+
216+
示例代码如下:
217+
218+
```
219+
ChatUIKitSettings.enableTypingIndicator = false;
220+
```
221+
222+

docs/uikit/chatuikit/ios/chatfeature_common.md

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -82,37 +82,6 @@
8282

8383
![img](/images/uikit/chatuikit/feature/common/message_report.png =300x630)
8484

85-
## 输入状态指示
86-
87-
输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。
88-
89-
输入状态指示的 UI 和逻辑结构如下:
90-
- `EaseChatNavigationBar` 中的 `subtitle` 控件显示用户的状态以及输入状态指示,收到输入状态后会先显示输入状态,用户取消输入状态后显示用户的状态,输入状态消失。
91-
- 输入状态相关回调和方法:
92-
- 输入状态投递为透传消息,接收到透传消息后,通过 `MessageListViewModel#notifyTypingState()` 回调,更新输入状态。
93-
- 输入状态回调为 `MessageListViewModel#onOtherPartyTypingText`
94-
95-
| 开启输入状态提示 | 关闭输入状态提示 |
96-
| :-------------- | :----- |
97-
| <img src=/images/uikit/chatuikit/feature/common/typing_indicator_enable.png width="300"/> |<img src=/images/uikit/chatuikit/feature/common/typing_indicator_disable.png width="300"/> |
98-
99-
### 如何使用
100-
101-
输入状态指示特性在 `Appearance.chat.enableTyping` 中默认开启,即 `Appearance.chat.enableTyping` 的默认值为 `true`。要关闭该特性,需将该参数设置为 `false`
102-
103-
示例代码如下:
104-
105-
```Swift
106-
Appearance.chat.enableTyping = false
107-
108-
```
109-
110-
### 自定义输入状态指示 UI
111-
112-
本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/ios/message_send_receive.html#通过透传消息实现输入指示器)
113-
114-
用户需要监听透传消息回调处理导航相关 UI 显示效果。
115-
11685
## 本地消息搜索
11786

11887
本地消息搜索功能允许用户快速在会话内搜索历史消息内容,支持关键词匹配。该功能帮助用户高效找到所需信息,提高工作效率和信息管理的便捷性。
@@ -125,7 +94,7 @@
12594

12695
![img](/images/uikit/chatuikit/feature/common/message_search.png)
12796

128-
### 如何使用
97+
#### 如何使用
12998

13099
跳转 `SearchHistoryMessagesViewController` 页面,入参为会话 ID,输入关键词后,将在历史消息中匹配关键词并展示搜索结果。
131100

@@ -148,7 +117,7 @@
148117

149118
![img](/images/uikit/chatuikit/feature/common/[email protected])
150119

151-
### 如何使用
120+
#### 如何使用
152121

153122
群组 @ 提及特性默认开启。要关闭该特性,则不需理会 `MessageListController#onInputBoxEventsOccur` 方法,记重载此方法后不需要处理 mention 事件即可。
154123

0 commit comments

Comments
 (0)