Agora Chat 是一个高度可靠的全球交流平台,您的用户可以在其中进行一对一、群组或聊天室聊天。用户通过短信进行交流,共享图像、音频、视频、文件、表情符号和位置。 Agora Chat 提供开箱即用的打字指示器。
Method | Description |
---|---|
getInstance | Chat 客户端类。该类是 Chat SDK 的入口,负责登录、登出及管理 SDK 与 chat 服务器之间的连接。 |
getEventEmitter | Chat 客户端类。该类是 Chat SDK 的入口,负责登录、登出及管理 SDK 与 chat 服务器之间的连接。 |
setNativeListener | Chat 客户端类。该类是 Chat SDK 的入口,负责登录、登出及管理 SDK 与 chat 服务器之间的连接。 |
version | Chat 客户端类。该类是 Chat SDK 的入口,负责登录、登出及管理 SDK 与 chat 服务器之间的连接。 |
options | 获取 SDK 配置项。 |
currentUserName | 获取当前登录用户的用户 ID。 |
init | 初始化 SDK。 |
isConnected | 检查 SDK 是否连接到 Chat 服务器。 |
getCurrentUsername | 从服务器获取当前登录用户的用户 ID。 |
isLoginBefore | 检查当前用户是否登录。 |
getAccessToken | 获取登录 token。 |
createAccount | 注册新用户(开放注册)。 |
login | 通过密码或环信 token 登录 Chat 服务器。 |
loginWithAgoraToken | @deprecated 2023-11-17 使用 login 代替。 |
renewAgoraToken | 更新声网 token。 |
logout | 退出登录。 |
changeAppKey | 修改 App Key。 |
compressLogs | 压缩日志文件。 |
getLoggedInDevicesFromServer | 获取指定账号下登录的在线设备列表。 |
kickDevice | 将特定账号登录的指定设备下线。 |
kickAllDevices | 将指定账号登录的所有设备都踢下线。 |
updatePushConfig | 更新推送设置。 |
addConnectionListener | 设置连接状态监听器。 |
removeConnectionListener | 移除连接状态监听器。 |
removeAllConnectionListener | 移除所有连接状态监听器。 |
addMultiDeviceListener | 添加多设备监听器。 |
removeMultiDeviceListener | 移除指定多设备监听器。 |
removeAllMultiDeviceListener | 移除所有多设备监听器。 |
addCustomListener | 添加自定义监听器,接收 Android 或者 iOS 设备发到 React Native 层的数据。 |
removeCustomListener | 移除自定义监听,不再接收 Android 或者 iOS 设备发到 React Native 层的数据。 |
removeAllCustomListener | 移除所有自定义监听器。 |
addExceptListener | Add error listener. |
removeExceptListener | Remove error listener. |
removeAllExceptListener | Remove all error listener. |
chatManager | Gets the chat manager class. |
groupManager | 获取群组管理器类。 |
contactManager | 获取联系人管理器类。 |
pushManager | 获取推送管理器类。 |
userManager | 获取用户信息管理器类。 |
roomManager | 获取聊天室管理器类。 |
presenceManager | 获取在线状态管理器类。 |
Event | Description |
---|---|
onConnected | 成功连接到 chat 服务器时触发的回调。 |
onDisconnected | 和 chat 服务器断开连接时触发的回调。 |
onTokenWillExpire | Agora token 即将过期时触发。 |
onTokenDidExpire | Agora token 已过期时触发。 |
onAppActiveNumberReachLimit | 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限时回调。 |
onUserDidLoginFromOtherDevice | 其他设备登录通知。 |
onUserDidLoginFromOtherDeviceWithInfo | 用户在其它设备登录。 |
onUserDidRemoveFromServer | 用户被移除通知。 |
onUserDidForbidByServer | 被服务器禁止连接通知。 |
onUserDidChangePassword | 用户密码变更通知。 |
onUserDidLoginTooManyDevice | 登录设备数量超限通知。 |
onUserKickedByOtherDevice | 被其他设备踢掉通知。 |
onUserAuthenticationFailed | 鉴权失败通知。 典型触发通知场景:token 过期、token 验证失败。 |
Event | Description |
---|---|
onContactEvent | 联系人事件监听回调。 |
onGroupEvent | 群组事件监听回调。 |
onThreadEvent | 子区事件监听回调。 |
onMessageRemoved | 会话删除漫游消息后,其他设备收到该通知。 |
onConversationEvent | 会话操作发生后,其他设备收到该通知。 |
Event | Description |
---|---|
onDataReceived | 自定义事件监听器。 |
Event | Description |
---|---|
onMessagesReceived | 收到消息回调。 |
onCmdMessagesReceived | 收到命令消息回调。 |
onMessagesRead | 收到单聊消息已读回执的回调。 |
onGroupMessageRead | 收到群组消息的已读回执的回调。 |
onMessagesDelivered | 收到消息已送达回执的回调。 |
onMessagesRecalled | 已收到的消息被撤回的回调。 |
onMessagesRecalledInfo | 收到消息撤销通知的回调。 |
onConversationsUpdate | 会话更新事件回调。 |
onConversationRead | 收到会话已读回执的回调。 |
onMessageReactionDidChange | 消息表情回复(Reaction)变化监听器。 |
onChatMessageThreadCreated | 子区创建回调。 |
onChatMessageThreadUpdated | 子区更新回调。 |
onChatMessageThreadDestroyed | 子区移除回调。 |
onChatMessageThreadUserRemoved | 管理员移除子区用户的回调。 |
onMessageContentChanged | 文本消息内容更改,其它设备收到该通知。 |
onMessagePinChanged | 收到消息置顶状态变更回调。 |
Method | Description |
---|---|
setNativeListener | 联系人管理类,用于添加、查询和删除联系人。 |
addContactListener | 添加联系人监听器。 |
removeContactListener | 移除联系人监听器。 |
removeAllContactListener | 移除所有联系人监听器。 |
addContact | 添加好友。 |
deleteContact | 删除联系人及其相关的会话。 |
getAllContactsFromServer | 从服务器获取联系人列表。 |
getAllContactsFromDB | 从本地数据库获取联系人列表。 |
addUserToBlockList | 将指定用户加入黑名单。 |
removeUserFromBlockList | 将指定用户移除黑名单。 |
getBlockListFromServer | 从服务器获取黑名单列表。 |
getBlockListFromDB | 从本地数据库获取黑名单列表。 |
acceptInvitation | 接受加好友的邀请。 |
declineInvitation | 拒绝加好友的邀请。 |
getSelfIdsOnOtherPlatform | 获取登录用户在其他登录设备上唯一 ID,该 ID 由 user ID + "/" + resource 组成。 |
getAllContacts | 从本地数据库获取所有所有联系人。 |
getContact | 从本地数据库获取指定联系人备注信息。 |
fetchAllContacts | 从服务器获取所有联系人。 |
fetchContacts | 从服务器分页获取联系人 |
setContactRemark | 设置联系人备注。 |
Event | Description |
---|---|
onContactAdded | 好友请求被接受的回调。 |
onContactDeleted | 好友请求被拒绝的回调。 |
onContactInvited | 当前用户收到好友请求的回调。 |
onFriendRequestAccepted | 当前用户同意好友请求的回调。 |
onFriendRequestDeclined | 拒绝好友请求的回调。 |
Event | Description |
---|---|
onInvitationReceived | 当前用户收到入群邀请的回调。 |
onRequestToJoinReceived | 对端用户接收群组申请的回调。 |
onRequestToJoinAccepted | 对端用户接受当前用户发送的群组申请的回调。 |
onRequestToJoinDeclined | 对端用户拒绝群组申请的回调。 |
onInvitationAccepted | 当前用户收到对端用户同意入群邀请触发的回调。 |
onInvitationDeclined | 当前用户收到群组邀请被拒绝的回调。 |
onMemberRemoved | 当前用户被移出群组时的回调。 |
onDestroyed | 当前用户收到群组被解散的回调。 |
onAutoAcceptInvitation | 当前用户自动同意入群邀请的回调。 |
onMuteListAdded | 有成员被禁言回调。 |
onMuteListRemoved | 有成员被解除禁言的回调。 |
onAdminAdded | 成员设置为管理员的回调。 |
onAdminRemoved | 取消成员的管理员权限的回调。 |
onOwnerChanged | 转移群主权限的回调。 |
onMemberJoined | 新成员加入群组的回调。 |
onMemberExited | 群组成员主动退出回调。 |
onAnnouncementChanged | 群公告更新回调。 |
onSharedFileAdded | 群组添加共享文件回调。 |
onSharedFileDeleted | 群组删除共享文件回调。 |
onAllowListAdded | 成员加入群组白名单回调。 |
onAllowListRemoved | 成员移出群组白名单回调。 |
onAllGroupMemberMuteStateChanged | 全员禁言状态变化回调。 |
onDetailChanged | 群组详情变更回调。群组所有成员会收到该事件。 |
onStateChanged | 群组状态变更回调。群组所有成员会收到该事件。 |
onMemberAttributesChanged | 群组成员属性变化通知。 |
Event | Description |
---|---|
onDestroyed | 聊天室解散的回调。 |
onMemberJoined | 聊天室加入新成员回调。 |
onMemberExited | 聊天室成员主动退出回调。 |
onMemberRemoved | 聊天室成员被移除回调。 |
onMuteListAdded | 有成员被禁言回调。 |
onMuteListRemoved | 有成员从禁言列表中移除回调。 |
onAdminAdded | 有成员设置为聊天室管理员的回调。 |
onAdminRemoved | 移除聊天室管理员权限的回调。 |
onOwnerChanged | 转移聊天室的所有权的回调。 |
onAnnouncementChanged | 聊天室公告更新回调。 |
onAllowListAdded | 有成员被加入聊天室白名单的回调。 |
onAllowListRemoved | 有成员被移出聊天室白名单的回调。 |
onAllChatRoomMemberMuteStateChanged | 聊天室全员禁言状态变化回调。 |
onSpecificationChanged | 聊天室详情变更回调。聊天室所有成员会收到该事件。 |
onAttributesUpdated | 聊天室自定义属性(key-value)更新回调。聊天室所有成员会收到该事件。 |
onAttributesRemoved | 聊天室自定义属性(key-value)移除回调。聊天室所有成员会收到该事件。 |
Method | Description |
---|---|
setNativeListener | 在线状态管理器类。 |
addPresenceListener | 添加在线状态监听器。 |
removePresenceListener | 移除在线状态监听器。 |
removeAllPresenceListener | 清除所有在线状态监听器。 |
publishPresence | 发布自定义在线状态。 |
subscribe | 订阅指定用户的在线状态。 |
unsubscribe | 取消订阅指定用户的在线状态。 |
fetchSubscribedMembers | 分页查询当前用户订阅了哪些用户的在线状态。 |
fetchPresenceStatus | 查询指定用户的当前在线状态。 |
Event | Description |
---|---|
onPresenceStatusChanged | 收到被订阅用户的在线状态发生变化。 |
Method | Description |
---|---|
setNativeListener | 消息推送设置管理类。 |
setSilentModeForConversation | 设置指定会话的消息推送模式。 |
removeSilentModeForConversation | 清除指定会话的消息推送设置。 |
fetchSilentModeForConversation | 获取指定会话的离线推送设置。 |
setSilentModeForAll | 设置 app 的离线推送模式。 |
fetchSilentModeForAll | 获取 app 的离线推送设置。 |
fetchSilentModeForConversations | 获取指定的多个会话的离线推送设置。 |
setPreferredNotificationLanguage | 设置推送通知的首选语言。 |
fetchPreferredNotificationLanguage | 获取推送通知的首选语言。 |
updatePushNickname | 修改推送通知中显示的消息发送方的昵称。 |
updatePushDisplayStyle | 修改推送通知的展示方式。 |
fetchPushOptionFromServer | 从服务器获取推送配置。 |
selectPushTemplate | 选择离线推送模板,通知服务器。 |
fetchSelectedPushTemplate | 获取当前推送模板的名称。 |
Method | Description |
---|---|
updateOwnUserInfo | 修改当前用户的信息。 |
fetchUserInfoById | 获取指定用户的用户属性。 |
fetchOwnInfo | 从服务器获取当前用户的用户属性信息。 |
Method | Description |
---|---|
constructor | 构造消息。 |
createSendMessage | 构造消息。 |
createTextMessage | 创建一条待发送的文本消息。 |
createFileMessage | 创建一条待发送的文件类型消息。 |
createImageMessage | 创建一条待发送的图片消息。 |
createVideoMessage | 创建一条待发送的视频消息。 |
createVoiceMessage | 创建一条待发送的语音消息。 |
createCombineMessage | 创建合并类型消息体。 |
createLocationMessage | 创建一条待发送的位置消息。 |
createCmdMessage | 创建一条待发送的命令消息。 |
createCustomMessage | 创建一条待发送的自定义类型消息。 |
createReceiveMessage | 创建一条接收消息。 |
reactionList | 获取 Reaction 列表。 |
groupReadCount | 获取群组消息的已读人数。 |
threadInfo | 获取指定子区的详情。 |
getPinInfo | 获取消息的置顶信息。 |
messagePriority | 设置消息优先级。仅仅聊天室生效。 |
Method | Description |
---|---|
name | 获取会话 ID。 |
getUnreadCount | 获取会话的未读消息数量。 |
getMessageCount | 获取会话的消息数目。 |
getMessageCountWithTimestamp | 获取会话的消息数目。 |
getLatestMessage | 获取指定会话的最新消息。 |
getLatestReceivedMessage | 获取指定会话中最近接收到的消息。 |
setConversationExtension | 设置指定会话的自定义扩展信息。 |
markMessageAsRead | 标记指定消息为已读。 |
markAllMessagesAsRead | 标记所有消息为已读。 |
updateMessage | 更新本地数据库的指定消息。 |
deleteMessage | 删除本地数据库中的指定消息。 |
deleteMessagesWithTimestamp | 删除消息。 |
deleteAllMessages | 删除会话的所有消息。 |
getMessagesWithMsgType | 从本地数据库获取会话中的指定用户发送的某些类型的消息。 |
getMsgsWithMsgType | 从本地数据库中检索会话中某种类型的消息。 |
getMessages | 从本地数据库中检索会话中一定数量的消息。 |
getMsgs | 从本地数据库中检索会话中指定数量的消息。 |
getMessagesWithKeyword | 检索本地数据库中会话中带有关键字的消息。 |
getMsgsWithKeyword | 获取指定用户在一定时间段内在会话中发送的消息。 |
getMessageWithTimestamp | 获取本地数据库中某个会话在一定时间内发送和接收的消息。 |
getMsgWithTimestamp | 检索本地数据库中某个会话在一定时间内发送和接收的消息。 |
removeMessagesFromServerWithMsgIds | 从会话中删除消息(从本地存储和服务器)。 |
removeMessagesFromServerWithTimestamp | 从会话中删除消息(从本地存储和服务器)。 |
getPinnedMessages | 从本地获取会话中的置顶消息。 |
fetchPinnedMessages | 从服务器获取会话中顶置的消息。 |
searchMessages | 搜索本地消息。 |
removeMessagesWithTimestamp | 移除本地和服务器的消息。和该聊天会话相关的所有消息都将被删除。会话中的其他人的服务器端消息不受影响。不会删除。 |