Skip to content

Commit ad3bc69

Browse files
authored
Merge pull request #31 from haoxiuwen/doc-shengwang
Modify Flutter API Reference Overview
2 parents f9447ac + 85f2ebf commit ad3bc69

File tree

1 file changed

+42
-12
lines changed

1 file changed

+42
-12
lines changed

docs/document/flutter/api_reference_overview.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@
55
- `ChatClient` 类是聊天 SDK 的入口,提供登录和登出即时通讯 IM 的方法,并管理 SDK 与聊天服务器之间的连接。
66
- `ChatManager` 类提供发送和接收消息、管理会话(包括加载和删除会话)以及下载附件的方法。
77
- `ChatMessage` 类定义消息的属性。
8-
- `Conversation` 类提供管理会话的方法。
9-
- `ContactManager` 类提供管理聊天联系人(如添加、获取、修改和删除联系人)的方法。
10-
- `GroupManager` 类提供群组管理的方法,如群组创建和解散以及成员管理。
8+
- `ChatConversation` 类提供管理会话的方法。
9+
- `ChatContactManager` 类提供管理聊天联系人(如添加、获取、修改和删除联系人)的方法。
10+
- `ChatGroupManager` 类提供群组管理的方法,如群组创建和解散以及成员管理。
1111
- `ChatRoomManager` 类提供聊天室管理的方法,如加入和离开聊天室、获取聊天室列表,以及管理成员权限。
12-
- `PresenceManager` 类提供管理用户在线状态订阅的方法。
12+
- `ChatPresenceManager` 类提供管理用户在线状态订阅的方法。
1313
- `ChatThreadManager` 类提供了管理子区的方法,包括创建、解散子区以及成员管理。
14-
- `PushManager` 类提供了配置离线推送服务的方法。
15-
- `UserInfoManager` 类提供了管理用户属性的方法,包括获取和更新用户属性。
14+
- `ChatPushManager` 类提供了配置离线推送服务的方法。
15+
- `ChatUserInfoManager` 类提供了管理用户属性的方法,包括获取和更新用户属性。
1616

1717
## 连接与初始化
1818

19+
**ChatClient** 类提供登录和登出即时通讯 IM 的方法和事件,并管理 SDK 与聊天服务器之间的连接。
20+
1921
| 方法 | 描述 |
2022
| :---------------------------------------------- | :------------------------------------------------ |
2123
| init | 初始化 SDK。 |
@@ -27,13 +29,13 @@
2729
| isLoginBefore | 检查用户是否已登录聊天应用。 |
2830
| addConnectionEventHandler | 添加监听。 |
2931
| removeConnectionEventHandler | 移除监听。 |
30-
| groupManager | 获取 `GroupManager` 类。 |
31-
| pushManager | 获取 `PushManager` 类。 |
32-
| chatRoomManager | 获取 `RoomManager` 类。 |
32+
| groupManager | 获取 `ChatGroupManager` 类。 |
33+
| pushManager | 获取 `ChatPushManager` 类。 |
34+
| chatRoomManager | 获取 `ChatRoomManager` 类。 |
3335
| chatManager | 获取 `ChatManager` 类。 |
34-
| userInfoManager | 获取 `UserInfoManager` 类。 |
35-
| contactManager | 获取 `ContactManager` 类。 |
36-
| presenceManager | 获取 `presenceManager` 类。 |
36+
| userInfoManager | 获取 `ChatUserInfoManager` 类。 |
37+
| contactManager | 获取 `ChatContactManager` 类。 |
38+
| presenceManager | 获取 `ChatPresenceManager` 类。 |
3739
| chatThreadManager | 获取 `ChatThreadManager` 类。 |
3840

3941
| 事件 | 描述 |
@@ -53,6 +55,12 @@
5355

5456
## 发送消息
5557

58+
- `ChatManager` 类提供发送和接收消息、管理会话(包括加载和删除会话)以及下载附件的方法和事件。
59+
60+
- `ChatMessageEvent` 类提供消息状态事件,包括消息发送或下载成功和失败以及上传或下载进度。
61+
62+
- `ChatEventHandler` 类用于监听收消息,已读回执等事件。
63+
5664
| 方法 | 描述 |
5765
| :------------------------------------------------ | :------------------------------------------------ |
5866
| sendMessage | 发送消息。 |
@@ -102,6 +110,9 @@
102110

103111
## 消息与会话
104112

113+
- `ChatMessage` 类定义消息的属性。
114+
- `ChatConversation` 类提供管理会话的方法。
115+
105116
| 方法 | 描述 |
106117
| :-------------------------------------------------- | :-------------------------------------------------- |
107118
| Conversation.id | 获取会话 ID。 |
@@ -141,6 +152,9 @@
141152

142153
## 联系人
143154

155+
- `ChatContactManager` 类提供管理聊天联系人(如添加、获取、修改和删除联系人)的方法。
156+
- `ChatContactEventHandler` 类提供联系人事件监听。
157+
144158
| 方法 | 描述 |
145159
| :------------------------------------------------- | :------------------------------------------------- |
146160
| fetchAllContacts | 从服务器获取所有联系人。 |
@@ -165,6 +179,9 @@
165179

166180
## 群组
167181

182+
- `ChatGroupManager` 类提供群组管理的方法,如群组创建和解散以及成员管理。
183+
- `ChatGroupEventHandler`类提供群组管理事件监听。
184+
168185
| 方法 | 描述 |
169186
| :-------------------------------------------------- | :-------------------------------------------------- |
170187
| createGroup | 创建群组。 |
@@ -237,6 +254,9 @@
237254

238255
## 聊天室
239256

257+
- `ChatRoomManager` 类提供聊天室管理的方法,如加入和离开聊天室、获取聊天室列表,以及管理成员权限。
258+
- `ChatRoomEventHandler` 类提供聊天室事件监听。
259+
240260
| 方法 | 描述 |
241261
| :------------------------------------------------------- | :------------------------------------------------------- |
242262
| createChatRoom | 创建聊天室。 |
@@ -290,6 +310,9 @@
290310

291311
## 用户在线状态订阅
292312

313+
- `ChatPresenceManager` 类提供管理用户在线状态订阅的方法。
314+
- `ChatPresenceEventHandler` 类提供订阅用户状态变更监听。
315+
293316
| 方法 | 描述 |
294317
| :-------------------------------------------------------- | :--------------------------------------------------- |
295318
| publishPresence | 发布自定义的在线状态。 |
@@ -306,6 +329,9 @@
306329

307330
## 子区
308331

332+
- `ChatThreadManager` 类提供了管理子区的方法,包括创建、解散子区以及成员管理。
333+
- `ChatThreadEvent` 类提供子区事件监听。
334+
309335
| 方法 | 描述 |
310336
| :---------------------------------------------------------- | :------------------------------------------------------- |
311337
| createChatThread | 创建子区。 |
@@ -332,6 +358,8 @@
332358

333359
## 离线推送
334360

361+
`PushManager` 类提供了配置离线推送服务的方法。
362+
335363
| 方法 | 描述 |
336364
| :---------------------------------------------------------- | :---------------------------------------------------- |
337365
| fetchPushConfigsFromServer | 从服务器获取推送配置。 |
@@ -346,6 +374,8 @@
346374

347375
## 用户属性
348376

377+
`UserInfoManager` 类提供了管理用户属性的方法,包括获取和更新用户属性。
378+
349379
| 方法 | 描述 |
350380
| :------------------------------------------------- | :------------------------------------------------- |
351381
| fetchOwnInfo | 获取当前用户的用户属性 |

0 commit comments

Comments
 (0)