Skip to content

Commit 01f096e

Browse files
haoxiuwenhaoxiuwen
authored
Merge pull request #38 from haoxiuwen/doc-shengwang
Add API Reference Overview for Each Platform
2 parents 67ff09a + 734bf28 commit 01f096e

File tree

5 files changed

+24250
-11726
lines changed

5 files changed

+24250
-11726
lines changed

‎docs/docs/sdk/android/api_reference_overview.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -180,34 +180,6 @@
180180
| CallBack#onError() | 发生错误时的回调，详见 Error 。 |
181181
| CallBack#onProgress() | 进度更新的回调。 |
182182

183-
## 联系人管理
184-
185-
`ContactManager` 类提供聊天联系人管理方法，例如添加、获取、修改和删除联系人。
186-
187-
| 方法名称 | 描述 |
188-
| ---------------------------------------------------------------------------------------------------- | ----------------------- |
189-
| ContactManager#asyncAddContact() | 添加联系人。 |
190-
| ContactManager#asyncDeleteContact() | 删除好友。 |
191-
| ContactManager#asyncGetAllContactsFromServer() | 从服务器获取所有的好友。 |
192-
| ContactManager#asyncAddUserToBlackList() | 把指定用户加入到黑名单中。 |
193-
| ContactManager#asyncSaveBlackList() | 上传黑名单列表到服务器。 |
194-
| ContactManager#asyncRemoveUserFromBlackList() | 将用户从黑名单中移除。 |
195-
| ContactManager#getBlackListUsernames() | 从本地获取黑名单列表。 |
196-
| ContactManager#asyncGetBlackListFromServer() | 从服务器获取黑名单列表。 |
197-
| ContactManager#asyncAcceptInvitation() | 接受加好友的邀请。 |
198-
| ContactManager#asyncDeclineInvitation() | 拒绝加好友的邀请。 |
199-
| ContactManager#getContactsFromLocal() | 从数据库获取好友列表。 |
200-
| ContactManager#asyncGetSelfIdsOnOtherPlatform() | 从服务器获取登录用户在其他设备上登录的 ID。 |
201-
| ContactManager#setContactListener() | 注册联系人监听。 |
202-
203-
| 事件 | 描述 |
204-
| ---------------------------------------------------------------------------------- | ------------------------ |
205-
| ContactListener#onContactAdded() | 增加联系人时回调此方法。 |
206-
| ContactListener#onContactDeleted() | 删除联系人时回调此方法。被删除的用户收到该回调。 |
207-
| ContactListener#onContactInvited() | 收到好友邀请。 |
208-
| ContactListener#onFriendRequestAccepted() | 同意好友请求。发送好友请求的用户收到该事件。 |
209-
| ContactListener#onFriendRequestDeclined() | 拒绝好友请求。发送好友请求的用户收到该事件。 |
210-
211183
## 群组
212184

213185
`GroupManager` 类提供群组管理方法，例如群组创建和解散以及成员管理。
@@ -284,7 +256,7 @@
284256
| GroupChangeListener#onAnnouncementChanged() | 群公告更新回调。 |
285257
| GroupChangeListener#onSharedFileAdded() | 群组中添加共享文件的回调。 |
286258
| GroupChangeListener#onSharedFileDeleted() | 群组中删除共享文件回调。 |
287-
| GroupChangeListener#onSpecificationChanged() | 群组详情更新回调，需调用 `GroupManager#asyncGetGroupFromServer() asyncGetGroupFromServer` 获取最新群组信息。 |
259+
| GroupChangeListener#onSpecificationChanged() | 群组详情更新回调，需调用 `GroupManager#asyncGetGroupFromServer()` 获取最新群组信息。 |
288260
| GroupChangeListener#onStateChanged() | 群组禁用或启动状态回调。 |
289261

290262
## 子区
@@ -378,6 +350,34 @@
378350
| ChatRoomChangeListener#onAttributesUpdate() | 聊天室自定义属性（key-value）有更新。 |
379351
| ChatRoomChangeListener#onAttributesRemoved() | 聊天室自定义属性被移除。 |
380352

353+
## 联系人
354+
355+
`ContactManager` 类提供聊天联系人管理方法，例如添加、获取、修改和删除联系人。
356+
357+
| 方法名称 | 描述 |
358+
| ---------------------------------------------------------------------------------------------------- | ----------------------- |
359+
| ContactManager#asyncAddContact() | 添加联系人。 |
360+
| ContactManager#asyncDeleteContact() | 删除好友。 |
361+
| ContactManager#asyncGetAllContactsFromServer() | 从服务器获取所有的好友。 |
362+
| ContactManager#asyncAddUserToBlackList() | 把指定用户加入到黑名单中。 |
363+
| ContactManager#asyncSaveBlackList() | 上传黑名单列表到服务器。 |
364+
| ContactManager#asyncRemoveUserFromBlackList() | 将用户从黑名单中移除。 |
365+
| ContactManager#getBlackListUsernames() | 从本地获取黑名单列表。 |
366+
| ContactManager#asyncGetBlackListFromServer() | 从服务器获取黑名单列表。 |
367+
| ContactManager#asyncAcceptInvitation() | 接受加好友的邀请。 |
368+
| ContactManager#asyncDeclineInvitation() | 拒绝加好友的邀请。 |
369+
| ContactManager#getContactsFromLocal() | 从数据库获取好友列表。 |
370+
| ContactManager#asyncGetSelfIdsOnOtherPlatform() | 从服务器获取登录用户在其他设备上登录的 ID。 |
371+
| ContactManager#setContactListener() | 注册联系人监听。 |
372+
373+
| 事件 | 描述 |
374+
| ---------------------------------------------------------------------------------- | ------------------------ |
375+
| ContactListener#onContactAdded() | 增加联系人时回调此方法。 |
376+
| ContactListener#onContactDeleted() | 删除联系人时回调此方法。被删除的用户收到该回调。 |
377+
| ContactListener#onContactInvited() | 收到好友邀请。 |
378+
| ContactListener#onFriendRequestAccepted() | 同意好友请求。发送好友请求的用户收到该事件。 |
379+
| ContactListener#onFriendRequestDeclined() | 拒绝好友请求。发送好友请求的用户收到该事件。 |
380+
381381
## 用户属性
382382

383383
`UserInfoManager` 类提供用户属性管理的方法，包括获取和修改用户属性。

‎docs/docs/sdk/harmonyos/api_reference_overview.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# API 概览
2+
13
即时通讯 IM 服务是一个高度可靠的全球通信平台，支持丰富的消息类型，包括文本、图片、语音、视频、文件、位置、透传以及自定义消息，可使你的用户很方便地进行单聊、群聊或聊天室聊天。
24

35
即时通讯 IM 服务提供以下类：

‎docs/docs/sdk/web/api_reference_overview.md‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -179,38 +179,38 @@
179179
- `chatClient` 提供聊天室管理的方法，如加入和离开聊天室、获取聊天室列表，以及管理成员权限。
180180
- `EventHandler` 类提供聊天室事件监听。
181181

182-
| 方法 | 描述 |
183-
| :-------------------------------- | :----------------- |
184-
| joinChatRoom | 加入聊天室。 |
185-
| leaveChatRoom | 离开聊天室。 |
186-
| getChatRooms | 分页获取聊天室列表。 |
187-
| listChatRoomMembers | 分页列出聊天室的所有成员。 |
188-
| modifyChatRoom | 修改聊天室详情。 |
189-
| fetchChatRoomAnnouncement | 获取聊天室公告。 |
190-
| updateChatRoomAnnouncement | 更新聊天室公告。 |
191-
| setChatRoomAdmin | 设置聊天室管理员。该方法只有聊天室所有者才有权限调用。 |
192-
| removeChatRoomAdmin | 移除聊天室管理员。该方法只有聊天室所有者才有权限调用。 |
193-
| getChatRoomAdmin | 获取聊天室的所有管理员。 |
194-
| blockChatRoomMember | 添加单个成员至聊天室黑名单。仅聊天室所有者和管理员有权限调用该方法。 |
195-
| unblockChatRoomMember | 将单个用户从聊天室黑名单移除。仅聊天室所有者和管理员有权限调用该方法。 |
196-
| blockChatRoomMembers | 批量添加成员至聊天室黑名单。仅聊天室所有者和管理员有权限调用该方法。 |
197-
| unblockChatRoomMembers | 批量将成员从聊天室黑名单移除。仅聊天室所有者和管理员有权限调用该方法。 |
198-
| getChatRoomBlocklist | 获取聊天室黑名单。 |
199-
| muteChatRoomMember | 禁止聊天室用户发言。该方法只有聊天室所有者才有权限调用。 |
200-
| unmuteChatRoomMember | 解除对聊天室用户的禁言。仅聊天室所有者和管理员有权限调用该方法。 |
201-
| disableSendChatRoomMsg | 聊天室全员禁言。仅聊天室创建者和管理员可调用此方法。 |
202-
| enableSendChatRoomMsg | 聊天室解除全员禁言。仅聊天室创建者和管理员可调用此方法。 |
203-
| getChatRoomMutelist | 获取聊天室所有被禁言成员。 |
204-
| addUsersToChatRoomAllowlist | 批量增加聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。 |
205-
| removeChatRoomAllowlistMember | 批量移除聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。 |
206-
| isInChatRoomAllowlist | 查询聊天室成员是否是在白名单中。普通成员可查询自己是否在聊天室白名单中；聊天室所有者和管理员可查询其他成员是否在白名单中。 |
207-
| getChatRoomAllowlist | 获取聊天室白名单列表。仅聊天室所有者和管理员有权调用该方法。 |
208-
| setChatRoomAttribute | 设置单个聊天室自定义属性。 |
209-
| setChatRoomAttributes | 批量设置聊天室属性。 |
210-
| removeChatRoomAttribute | 移除单个聊天室自定义属性。 |
211-
| removeChatRoomAttributes | 批量移除聊天室属性。 |
212-
| getChatRoomAttributes | 获取聊天室全部的自定义属性。 |
213-
| getJoinedChatRooms | 获取用户加入的聊天室列表 |
182+
| 方法 | 描述 |
183+
| :-------------------------------- | :----------------- |
184+
| joinChatRoom | 加入聊天室。 |
185+
| leaveChatRoom | 离开聊天室。 |
186+
| getChatRooms | 分页获取聊天室列表。 |
187+
| listChatRoomMembers | 分页列出聊天室的所有成员。 |
188+
| modifyChatRoom | 修改聊天室详情。 |
189+
| fetchChatRoomAnnouncement | 获取聊天室公告。 |
190+
| updateChatRoomAnnouncement | 更新聊天室公告。 |
191+
| setChatRoomAdmin | 设置聊天室管理员。该方法只有聊天室所有者才有权限调用。 |
192+
| removeChatRoomAdmin | 移除聊天室管理员。该方法只有聊天室所有者才有权限调用。 |
193+
| getChatRoomAdmin | 获取聊天室的所有管理员。 |
194+
| blockChatRoomMember | 添加单个成员至聊天室黑名单。仅聊天室所有者和管理员有权限调用该方法。 |
195+
| unblockChatRoomMember | 将单个用户从聊天室黑名单移除。仅聊天室所有者和管理员有权限调用该方法。 |
196+
| blockChatRoomMembers | 批量添加成员至聊天室黑名单。仅聊天室所有者和管理员有权限调用该方法。 |
197+
| unblockChatRoomMembers | 批量将成员从聊天室黑名单移除。仅聊天室所有者和管理员有权限调用该方法。 |
198+
| getChatRoomBlocklist | 获取聊天室黑名单。 |
199+
| muteChatRoomMember | 禁止聊天室用户发言。该方法只有聊天室所有者才有权限调用。 |
200+
| unmuteChatRoomMember | 解除对聊天室用户的禁言。仅聊天室所有者和管理员有权限调用该方法。 |
201+
| disableSendChatRoomMsg | 聊天室全员禁言。仅聊天室创建者和管理员可调用此方法。 |
202+
| enableSendChatRoomMsg | 聊天室解除全员禁言。仅聊天室创建者和管理员可调用此方法。 |
203+
| getChatRoomMutelist | 获取聊天室所有被禁言成员。 |
204+
| addUsersToChatRoomAllowlist | 批量增加聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。 |
205+
| removeChatRoomAllowlistMember | 批量移除聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。 |
206+
| isInChatRoomAllowlist | 查询聊天室成员是否是在白名单中。普通成员可查询自己是否在聊天室白名单中；聊天室所有者和管理员可查询其他成员是否在白名单中。 |
207+
| getChatRoomAllowlist | 获取聊天室白名单列表。仅聊天室所有者和管理员有权调用该方法。 |
208+
| setChatRoomAttribute | 设置单个聊天室自定义属性。 |
209+
| setChatRoomAttributes | 批量设置聊天室属性。 |
210+
| removeChatRoomAttribute | 移除单个聊天室自定义属性。 |
211+
| removeChatRoomAttributes | 批量移除聊天室属性。 |
212+
| getChatRoomAttributes | 获取聊天室全部的自定义属性。 |
213+
| getJoinedChatRooms | 获取用户加入的聊天室列表 |
214214

215215
| 事件 | 描述 |
216216
| :-------------- | :--------------------- |

0 commit comments

Comments
 (0)