Skip to content

Commit b5c24e5

Browse files
authored
Merge pull request #65 from zjc19891106/doc
fix doc
2 parents fb20847 + c852766 commit b5c24e5

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

docs/docs/uikit/chatuikit/ios/chatfeature_message.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ Appearance.chat.messageLongPressedActions.removeAll { $0.tag == "Pin" }
212212
输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。
213213

214214
输入状态指示的 UI 和逻辑结构如下:
215-
- `EaseChatNavigationBar` 中的 `subtitle` 控件显示用户的状态以及输入状态指示,收到输入状态后会先显示输入状态,用户取消输入状态后显示用户的状态,输入状态消失。
215+
- `ChatNavigationBar` 中的 `subtitle` 控件显示用户的状态以及输入状态指示,收到输入状态后会先显示输入状态,用户取消输入状态后显示用户的状态,输入状态消失。
216216
- 输入状态相关回调和方法:
217217
- 当单聊会话中的一个用户输入文字时,可以调用 `MessageListViewModel#notifyTypingState()` 方法告知对方。
218218
- 会话中的对方会收到 `MessageListViewModel#onOtherPartyTypingText` 回调,更新对方的输入状态。

docs/docs/uikit/chatuikit/ios/chatuikit_advancedusage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,15 @@ Provider 仅用于会话列表以及联系人列表。若只通过快速开始
8787

8888
2. 实现会话列表 Provider。
8989

90-
对于 Objective-C,实现 `EaseProfileProviderOC` 即可。
90+
对于 Objective-C,实现 `ChatUserProfileProviderOC` 即可。
9191

9292
下面示例代码为实现带协程功能的 Swift 特有的 provider。
9393

9494
```
9595
//MARK: - ChatUserProfileProvider&ChatGroupProfileProvider for conversations&contacts usage.
9696
//For example using conversations controller,as follows.
9797
extension MainViewController: ChatUserProfileProvider,ChatGroupProfileProvider {
98-
//MARK: - EaseProfileProvider
98+
//MARK: - ChatUserProfileProvider
9999
func fetchProfiles(profileIds: [String]) async -> [any ShengwangChatUIKit.ChatUserProfileProtocol] {
100100
return await withTaskGroup(of: [ShengwangChatUIKit.ChatUserProfileProtocol].self, returning: [ShengwangChatUIKit.ChatUserProfileProtocol].self) { group in
101101
var resultProfiles: [ShengwangChatUIKit.ChatUserProfileProtocol] = []
@@ -114,7 +114,7 @@ extension MainViewController: ChatUserProfileProvider,ChatGroupProfileProvider {
114114
return resultProfiles
115115
}
116116
}
117-
//MARK: - EaseGroupProfileProvider
117+
//MARK: - ChatGroupProfileProvider
118118
func fetchGroupProfiles(profileIds: [String]) async -> [any ShengwangChatUIKit.ChatUserProfileProtocol] {
119119
120120
return await withTaskGroup(of: [ShengwangChatUIKit.ChatUserProfileProtocol].self, returning: [ShengwangChatUIKit.ChatUserProfileProtocol].self) { group in
@@ -155,7 +155,7 @@ extension MainViewController: ChatUserProfileProvider,ChatGroupProfileProvider {
155155
let result = await ChatClient.shared().userInfoManager?.fetchUserInfo(byId: unknownIds)
156156
if result?.1 == nil,let infoMap = result?.0 {
157157
for (userId,info) in infoMap {
158-
let profile = EaseChatProfile()
158+
let profile = ChatUserProfile()
159159
let nickname = info.nickname ?? ""
160160
profile.id = userId
161161
profile.nickname = nickname
@@ -181,7 +181,7 @@ extension MainViewController: ChatUserProfileProvider,ChatGroupProfileProvider {
181181
let groups = ChatClient.shared().groupManager?.getJoinedGroups() ?? []
182182
for groupId in groupIds {
183183
if let group = groups.first(where: { $0.groupId == groupId }) {
184-
let profile = EaseChatProfile()
184+
let profile = ChatUserProfile()
185185
profile.id = groupId
186186
profile.nickname = group.groupName
187187
profile.avatarURL = group.settings.ext

docs/docs/uikit/chatuikit/ios/chatuikit_custom_chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
## 自定义导航栏
1919

20-
聊天页面、会话列表页面、联系人列表页面、群详情页面和联系人详情页面的导航栏均使用 `EaseChatNavigationBar`。如果聊天页面(`MessageListController.swift`)的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
20+
聊天页面、会话列表页面、联系人列表页面、群详情页面和联系人详情页面的导航栏均使用 `ChatNavigationBar`。如果聊天页面(`MessageListController.swift`)的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
2121

2222
<ImageGallery>
2323
<ImageItem src="/images/uikit/chatuikit/ios/custom_chat_navigation.png" title="导航栏配置" />

docs/docs/uikit/chatuikit/ios/chatuikit_custom_contact_details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## 自定义导航栏
1010

11-
联系人详情页面、聊天页面、会话列表页面、联系人列表页面和群详情页面的导航栏均使用 `EaseChatNavigationBar`。如果联系人详情页面的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
11+
联系人详情页面、聊天页面、会话列表页面、联系人列表页面和群详情页面的导航栏均使用 `ChatNavigationBar`。如果联系人详情页面的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
1212

1313
### 设置点击右侧图片显示的联系人操作
1414

docs/docs/uikit/chatuikit/ios/chatuikit_custom_contact_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## 自定义导航栏
1212

13-
联系人列表页面、聊天页面、会话列表页面、群详情页面和联系人详情页面的导航栏均使用 `EaseChatNavigationBar`。如果联系人列表页面(`ContactViewController.swift`)的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
13+
联系人列表页面、聊天页面、会话列表页面、群详情页面和联系人详情页面的导航栏均使用 `ChatNavigationBar`。如果联系人列表页面(`ContactViewController.swift`)的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
1414

1515
## 自定义联系人列表 Header
1616

docs/docs/uikit/chatuikit/ios/chatuikit_custom_conversation_list.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@
2323

2424
## 自定义导航栏
2525

26-
会话列表页面、聊天页面、联系人列表页面、群详情页面和联系人详情页面的导航栏均使用 `EaseChatNavigationBar`。如果会话列表页面的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。
26+
会话列表页面、聊天页面、联系人列表页面、群详情页面和联系人详情页面的导航栏均使用 `ChatNavigationBar`。如果会话列表页面的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。
2727

28-
1. 在 Demo 中继承 `ShengwangChatUIKit` 中的 `EaseChatNavigationBar` 类创建自己的会话列表页面导航栏,例如 `CustomConversationNavigationBar`
28+
1. 在 Demo 中继承 `ShengwangChatUIKit` 中的 `ChatNavigationBar` 类创建自己的会话列表页面导航栏,例如 `CustomConversationNavigationBar`
2929
2. 重载 `createNavigation()` 方法并返回你使用 `CustomConversationNavigationBar` 创建的对象。示例代码如下:
3030

3131
```swift
32-
override func createNavigationBar() -> EaseChatNavigationBar {
32+
override func createNavigationBar() -> ChatNavigationBar {
3333
CustomConversationNavigationBar(showLeftItem: false,rightImages: [UIImage(named: "add", in: .chatBundle, with: nil,hiddenAvatar: false)])
3434
}
3535
```
@@ -81,7 +81,7 @@
8181
对于导航点击事件的监听,你需要重载会话列表页面中的 `navigationClick` 方法,然后根据对应的点击区域做对应的处理,示例代码如下:
8282

8383
```swift
84-
override func navigationClick(type: EaseChatNavigationBarClickEvent, indexPath: IndexPath?) {
84+
override func navigationClick(type: ChatNavigationBarClickEvent, indexPath: IndexPath?) {
8585
switch type {
8686
case .back: self.backAction()
8787
case .avatar: self.avatarAction()

docs/docs/uikit/chatuikit/ios/chatuikit_custom_group_details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## 自定义导航栏
1010

11-
群详情页面、联系人列表页面、聊天页面、会话列表页面和联系人详情页面的导航栏均使用 `EaseChatNavigationBar`。如果群详情页面的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
11+
群详情页面、联系人列表页面、聊天页面、会话列表页面和联系人详情页面的导航栏均使用 `ChatNavigationBar`。如果群详情页面的导航栏不满足需求,建议自定义导航栏,重载方法传入自定义的导航类。关于导航栏中的标题、头像、背景色、导航栏右侧按钮的显示图片和左侧的头像,详见[自定义会话列表页面的导航栏](chatuikit_custom_conversation_list.html#自定义导航栏)
1212

1313
### 设置点击右侧图片显示的群组操作
1414

0 commit comments

Comments
 (0)