Skip to content

Commit

Permalink
Merge pull request #1029 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify UIKit Docs
  • Loading branch information
haoxiuwen authored Nov 7, 2024
2 parents e487122 + 42f65e0 commit 1f64b42
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 19 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 31 additions & 6 deletions docs/uikit/chatuikit/ios/chatfeature_conversation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
---
{
pageUri: "/uikit/chatuikit/android/chatfeature_conversation.html",
title: "会话列表"
}
---
# 会话特性

在会话列表页面,你 可以左滑或右滑单个会话进行会话操作,左滑菜单项包括会话免打扰、置顶会话和删除会话,右滑菜单包括会话已读和唤起更多菜单。

![img](/images/uikit/chatuikit/ios/configurationitem/conversation/Appearance_conversation_swipeLeftActions.png)

<Toc />

## 会话已读

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

在单群聊 UIKit 中,用户可以右滑单个会话,将会话将置为已读。

## 会话置顶

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

在单群聊 UIKit 中,用户可以左滑单个会话,将会话放置在会话列表前排区域。

## 会话免打扰

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

在单群聊 UIKit 中,用户可以左滑单个会话,将会话设置为免打扰状态,则该会话将不再接收通知。

## 会话删除

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

在单群聊 UIKit 中,用户可以左滑单个会话,将会话放置在会话列表前排区域。
14 changes: 2 additions & 12 deletions docs/uikit/chatuikit/ios/chatuikit_custom_conversation_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- 点击搜索按钮,跳转到搜索页面,搜索会话。
- 点击会话列表项,跳转到会话详情页面。
- 点击导航栏的扩展按钮,选择新会话,创建新会话。
- 左滑、右滑或长按会话触发会话拓展功能菜单,可进行删除会话、置顶会话、消息免打扰操作
- 左滑或右滑会话,可进行删除会话、置顶会话、消息免打扰和标记回话已读

单条会话展示会话名称、最后一条消息、最后一条消息的时间以及置顶和禁言状态等。

Expand Down Expand Up @@ -173,7 +173,7 @@
}
```

![img](/images/uikit/chatuikit/ios/configurationitem/conversation/Appearance_conversation_swipe_right_more.png)
![img](/images/uikit/chatuikit/ios/conversation_more.png)

### 设置会话时间

Expand All @@ -192,18 +192,8 @@

- `swipeAction`:滑动事件。

- `longPressed`:长按事件。

- `didSelected`:点击事件。

以下示例代码为会话长按事件:

```Swift
ComponentViewsActionHooker.shared.conversation.longPressed = { [weak self] indexPath,info in
//Process you business logic.
}
```

## 会话列表页面其他设置

1. 其他标记为 open 的方法均为可重载方法。如有需要,可重载对应方法实现自己业务逻辑。
Expand Down
1 change: 0 additions & 1 deletion docs/uikit/chatuikit/ios/chatuikit_listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
| `delete` | 会话列表左滑后点击删除按钮后触发回调。 ||
| `read` | 会话列表左滑后点击已读按钮后触发回调。 ||
| `conversationDidSelected` | 会话列表点击后回调。 ||
| `conversationLongPressed` | 会话列表长按后回调。 ||
| `moreAction` | 会话列表右滑后点击 `...` 回调。 ||
| `conversationLastMessageUpdate` | 会话列表中会话最后一条消息更新时回调。 ||
| `playNewMessageSound` | 收到新消息时播放音频方法。 ||
Expand Down

0 comments on commit 1f64b42

Please sign in to comment.