Agora Chat Web API 参考

Agora Chat Web SDK 是通过 HTML 网页加载的 JavaScript 和 Typescript 库。你可以使用 Agora Chat Web SDK 在网页浏览器中调用 API 实现 Chat 功能。

CHATSDK 你引入的 SDK，包含了 SDK 的全部内容。

CHATROOM APIS
该模块包含聊天室相关操作的 API。

方法	描述
joinChatRoom	加入聊天室。
leaveChatRoom	离开聊天室。
getChatRooms	分页获取聊天室列表。
listChatRoomMembers	分页列出聊天室的所有成员。
modifyChatRoom	修改聊天室详情。
fetchChatRoomAnnouncement	获取聊天室公告。
updateChatRoomAnnouncement	更新聊天室公告。
setChatRoomAdmin	设置聊天室管理员。该方法只有聊天室所有者才有权限调用。
removeChatRoomAdmin	移除聊天室管理员。该方法只有聊天室所有者才有权限调用。
getChatRoomAdmin	获取聊天室的所有管理员。
blockChatRoomMember	添加单个成员至聊天室黑名单。仅聊天室所有者和管理员有权限调用该方法。
unblockChatRoomMember	将单个用户从聊天室黑名单移除。仅聊天室所有者和管理员有权限调用该方法。
blockChatRoomMembers	批量添加成员至聊天室黑名单。仅聊天室所有者和管理员有权限调用该方法。
unblockChatRoomMembers	批量将成员从聊天室黑名单移除。仅聊天室所有者和管理员有权限调用该方法。
getChatRoomBlocklist	获取聊天室黑名单。
muteChatRoomMember	禁止聊天室用户发言。该方法只有聊天室所有者才有权限调用。
unmuteChatRoomMember	解除对聊天室用户的禁言。仅聊天室所有者和管理员有权限调用该方法。
disableSendChatRoomMsg	聊天室全员禁言。仅聊天室创建者和管理员可调用此方法。
enableSendChatRoomMsg	聊天室解除全员禁言。仅聊天室创建者和管理员可调用此方法。
getChatRoomMutelist	获取聊天室所有被禁言成员。
addUsersToChatRoomAllowlist	批量增加聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。
removeChatRoomAllowlistMember	批量移除聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。
isInChatRoomAllowlist	查询聊天室成员是否是在白名单中。普通成员可查询自己是否在聊天室白名单中；聊天室所有者和管理员可查询其他成员是否在白名单中。
getChatRoomAllowlist	获取聊天室白名单列表。仅聊天室所有者和管理员有权调用该方法。
setChatRoomAttribute	设置单个聊天室自定义属性。
setChatRoomAttributes	批量设置聊天室属性。
removeChatRoomAttribute	移除单个聊天室自定义属性。
removeChatRoomAttributes	批量移除聊天室属性。
getChatRoomAttributes	获取聊天室全部的自定义属性。
getJoinedChatRooms	获取用户加入的聊天室列表

事件	描述
onChatroomEvent	当有聊天室事件时触发。

CONNECTION
Connection 类，用来发消息，你需要进行实例化。

方法	描述
open	登录。
registerUser	注册用户。
isOpened	监测连接状态。-true：已连接；- false：未连接。
renewToken	更新 token。
send	发送消息。
addEventHandler	注册监听函数。
removeEventHandler	移除监听函数。

事件	描述
onConnected	当连接建立成功之后触发。
onReconnecting	SDK 尝试重连时触发。
onDisconnected	当断开连接后触发。
onError	当发生错误时触发。
onMultiDeviceEvent	当在多个设备上操作时触发。
onOffline	当网络断开时触发。
onOnline	当网络连接成功时触发。
onTokenWillExpire	当 token 将要过期时触发。
onTokenExpired	当 token 过期后触发。

CONTACT APIS
该模块包含联系人相关操作的 API。

方法	描述
addContact	添加好友。
deleteContact	删除指定好友。
declineContactInvite	拒绝好友申请。
acceptContactInvite	接受好友申请。
getContacts	获取联系人列表。
addUsersToBlocklist	添加联系人至黑名单。
removeUserFromBlocklist	将联系人从黑名单移除。
getBlocklist	获取黑名单列表。
fetchUserInfoById	查询用户属性。
updateUserInfo	修改当前用户的用户属性。
deleteConversation	删除会话。
getHistoryMessages	获取对话历史消息。
addReaction	添加消息 Reaction。
deleteReaction	删除消息的 Reaction。
getReactionlist	获取消息的 Reaction 列表。
getReactionDetail	获取 Reaction 详情。
getServerConversations	分页获取服务器会话列表。
getServerPinnedConversations	分页获取服务器端的置顶会话列表。
pinConversation	设置是否置顶会话。
setContactRemark	设置好友备注。
getAllContacts	获取所有联系人。
getContactsWithCursor	分页获取联系人列表。
addConversationMark	标记会话。
removeConversationMark	取消标记会话。
getServerConversationsByFilter	根据会话过滤选项从服务器分页查询会话列表。
getSelfIdsOnOtherPlatform	从服务器获取当前用户的其他登录设备的登录 ID 列表。
deleteAllMessagesAndConversations	清除全部会话及其聊天记录。
pinMessage	置顶一条消息。
unpinMessage	取消置顶一条消息。
getServerPinnedMessages	分页获取会话中的置顶消息。

事件	描述
onContactInvited	当收到好友请求时触发。
onContactAgreed	当好友请求被接受时触发。
onContactRefuse	当好友请求被拒绝时触发。
onContactAdded	当添加好友成功后触发。
onContactDeleted	当删除好友成功后触发。
onReactionChange	当消息的 reaction 发生变化时触发。

EVENTHANDLER
该模块用于 SDK 添加或移除事件监听。

方法	描述
addEventHandler	添加事件监听。
removeEventHandler	移除事件监听。

GROUP APIS
该模块包含群组相关操作的 API。

方法	描述
joinGroup	申请加入群组。
acceptGroupJoinRequest	同意用户加入群。仅群主和管理员可调用此方法。
rejectGroupJoinRequest	拒绝入群申请。仅群主和管理员可调用此方法。
inviteUsersToGroup	邀请用户加群。
acceptGroupInvite	接受入群邀请。
rejectGroupInvite	拒绝入群邀请。
leaveGroup	离开群组。
getJoinedGroups	列出某用户加入的所有群组。
getPublicGroups	分页获取公开群。
createGroupVNext	创建群组。
destroyGroup	解散群组。仅群主可调用此方法。
changeGroupOwner	转让群组。仅群主可调用此方法。
modifyGroup	修改群信息。仅群组管理员可调用此方法。
getGroupInfo	获取群组详情。
fetchGroupAnnouncement	获取群公告。
updateGroupAnnouncement	更新群公告。
getGroupAdmin	获取群组下所有管理员。
setGroupAdmin	设置群管理员。仅群主可调用此方法。
removeGroupAdmin	移除群管理员。仅群主可调用此方法。
blockGroupMember	将单个成员加入群组黑名单。仅群主和管理员可调用此方法。
blockGroupMembers	批量添加成员至群组黑名单。仅群组管理员可调用此方法。
unblockGroupMember	将单个成员从群组黑名单移除。仅群组管理员可调用此方法。
unblockGroupMembers	将成员批量移出群组黑名单。仅群主和管理员可调用此方法。
getGroupBlocklist	获取群组黑名单。
muteGroupMember	将一个组成员禁言。仅群主和管理员可调用此方法。
unmuteGroupMember	解除禁言。仅群主和管理员可调用此方法。
getGroupMutelist	获取群组的禁言列表。
disableSendGroupMsg	设置全员禁言。仅群组管理员及以上身份可调用此方法。
enableSendGroupMsg	解除全员禁言。仅群组管理员及以上身份可调用此方法。
addUsersToGroupAllowlist	添加白名单。白名单里的成员可以在群禁言之后继续发言。仅群组管理员及以上身份可调用此方法。
removeGroupAllowlistMember	移除白名单。仅群组管理员及以上身份可调用此方法。
getGroupAllowlist	获取群组白名单列表。仅群组管理员及以上身份可调用此方法。
isInGroupAllowlist	检查当前用户是否在群组白名单中。app admin 可查询所有用户；app user 可查询自己。
setGroupMemberAttributes	设置群成员自定义属性。
getGroupMemberAttributes	获取单个群成员所有自定义属性。
getGroupMembersAttributes	根据指定的属性 key 获取多个群成员的自定义属性。

事件	描述
onGroupEvent	当有群组事件发生时触发。

PRESENCE APIS
该模块包含在线状态相关操作的 API。

方法	描述
publishPresence	发布自定义在线状态。
subscribePresence	订阅指定用户的在线状态。订阅成功后，在线状态变更时订阅者会收到回调通知。
unsubscribePresence	取消订阅指定用户的在线状态。
getSubscribedPresencelist	分页查询当前用户订阅了哪些用户的在线状态。
getPresenceStatus	查询指定用户的当前在线状态。

事件	描述
onPresenceStatusChange	当订阅的用户在线状态发生变化时触发。

SILENTMODE APIS
该模块包含免打扰设置相关操作的 API。

方法	描述
setSilentModeForAll	设置当前登录用户的免打扰设置。
getSilentModeForAll	获取当前用户的免打扰设置。
setSilentModeForConversation	设置会话的免打扰。
clearRemindTypeForConversation	清除会话的离线推送提醒类型设置。
getSilentModeForConversation	获取会话的免打扰设置。
getSilentModeForConversations	批量获取指定会话的免打扰设置。
setPushPerformLanguage	设置用户推送翻译语言。
getPushPerformLanguage	获取用户设置的推送翻译语言。

THREAD APIS
该模块包含消息子区相关操作的 API。

方法	描述
createChatThread	创建子区。
joinChatThread	加入子区。
leaveChatThread	退出子区。
destroyChatThread	解散子区。仅子区所属群组的群主和管理员可以调用该方法。
changeChatThreadName	修改子区名称。
getChatThreadMembers	分页获取子区成员。
removeChatThreadMember	移除子区成员。
getJoinedChatThreads	分页获取当前用户加入的子区列表。
getChatThreads	分页获取当前用户加入指定群组的子区列表。
getChatThreadLastMessage	批量获取指定子区中的最新一条消息。
getChatThreadDetail	获取子区详情。

事件	描述
onChatThreadChange	当子区发生变化时触发。

TRANSLATION APIS
该模块包含翻译服务相关操作的 API。

方法	描述
getSupportedLanguages	获取翻译服务支持的语言。
translateMessage	翻译消息。

LocalCache APIS
该模块包含本地存储相关操作的 API。

方法	描述
getLocalConversations	获取本地会话列表。
getLocalConversation	获取单个本地会话。
removeLocalConversation	删除单个本地会话。
setLocalConversationCustomField	设置本地会话自定义字段。
clearConversationUnreadCount	对本地会话的未读消息数清零。

MESSAGE
该模块用于 SDK 构建消息。

事件	描述
onTextMessage	当收到文本消息时触发。
onAudioMessage	当收到音频消息时触发。
onVideoMessage	当收到视频消息时触发。
onImageMessage	当收到图片消息时触发。
onCmdMessage	当收到透传消息时触发。
onCustomMessage	当收到自定义消息时触发。
onFileMessage	当收到文件消息时触发。
onLocationMessage	当收到位置消息时触发。
onStatisticMessage	当收到统计消息时触发。
onReceivedMessage	当收到消息已到达服务器的确认消息时触发。
onDeliveredMessage	当收到消息已被对方收到的确认消息时触发。
onReadMessage	当收到消息已被对方阅读的确认消息时触发。
onChannelMessage	当收到整个会话所有消息都置为已读的确认消息时触发。
onRecallMessage	当收到撤回消息通知时触发。
onModifiedMessage	当收到修改消息通知时触发。
onMessagePinEvent	当收到 PIN 消息通知时触发。
onOfflineMessageSyncStart	开始从服务器拉取离线消息时触发。
onOfflineMessageSyncFinish	从服务器拉取离线消息结束时触发。

TYPES
SDK 类型声明模块。