hyphenate_SDK_5.0 5.0.0
hyphenate java IM SDK
载入中...
搜索中...
未找到
hyphenate_SDK_5.0

即时通讯 IM 是一个高度可靠的全球通信平台,用户可以进行一对一单聊、群组聊天或聊天室聊天。用户可以通过发送文本消息、分享图片、音频、视频、文件、表情符号和位置进行沟通。

  • EMClient 类是聊天 SDK 的入口,提供登录和登出即时通讯 IM 的方法,并管理 SDK 与聊天服务器之间的连接。
  • EMChatManager 类提供发送和接收消息、管理会话以及下载附件的方法。
  • EMMessage 类定义消息的属性。
  • EMConversation 类提供管理会话的方法。
  • EMContactManager 类提供管理联系人的方法。
  • EMGroupManager 类提供群组创建、解散和成员管理等方法。
  • EMChatRoomManager 类提供聊天室和成员权限管理的方法。
  • EMPresenceManager 类提供管理用户在线状态的方法。
  • EMChatThreadManager 类提供子区创建、解散和成员管理的方法。
  • EMPushManager 类提供配置离线推送服务的方法。
  • EMUserInfoManager 类提供获取、更新和订阅用户属性的方法。

在方法调用过程中,SDK 可能会返回错误码。详见 EMError

Chat Client

方法 描述 起始版本
init 初始化 SDK。 V5.0.0
loginWithToken 通过 token 登录服务器。 V5.0.0
renewToken 更新 token。 V5.0.0
logout 退出登录。 V5.0.0
getCurrentUser 获取当前登录用户的用户ID。 V5.0.0
isConnected 检查 SDK 是否连接到 Chat 服务器。 V5.0.0
isLoggedIn 检查用户是否登录 Chat 服务。 V5.0.0
setDataSyncType 设置登录后需要自动同步的数据类型。 V5.0.0
addConnectionListener 设置连接状态监听器。 V5.0.0
addLogListener 设置日志回调监听器。 V5.0.0
groupManager 获取群组管理类。 V5.0.0
pushManager 获取推送管理类。 V5.0.0
chatroomManager 获取聊天室管理类。 V5.0.0
chatManager 获取聊天管理类。 V5.0.0
userInfoManager 获取用户信息管理类。 V5.0.0
contactManager 获取联系人管理类。 V5.0.0
presenceManager 获取presenceManager类。 V5.0.0
chatThreadManager 获取子区管理类。 V5.0.0
事件 描述 起始版本
onConnected 成功连接到 chat 服务器时触发。 V5.0.0
onDisconnected SDK 与 chat 服务器断开连接时触发。 V5.0.0
onTokenExpired token 已过期时触发。 V5.0.0
onTokenWillExpire token 即将过期时触发。 V5.0.0
onLog 当有日志输出时触发。 V5.0.0
onOfflineMessageSyncStart 开始从服务器拉取离线消息时触发。 V5.0.0
onOfflineMessageSyncFinish 从服务器拉取离线消息结束时触发。 V5.0.0
onDataSyncStart 登录后自动数据同步开始时触发。 V5.0.0
onDataSyncFinish 登录后自动数据同步结束时触发。 V5.0.0
onDatabaseOpened 本地数据库打开成功时触发。 V5.0.0

Chat manager

方法 描述 起始版本
sendMessage 发送消息。 V5.0.0
asyncSendMessageReadReceipts 批量发送消息已读回执。 V5.0.0
asyncClearConversationUnreadMessageCount 清除指定会话的未读消息数。 V5.0.0
asyncClearAllConversationUnreadMessageCount 清除所有会话的未读消息数。 V5.0.0
asyncGetGroupMessageReadReceipts 从服务器批量获取消息的已读回执详情。 V5.0.0
getConversation 获取指定 ID 的会话对象。 V5.0.0
importMessages 将消息导入本地数据库。 V5.0.0
updateMessage 更新本地消息。 V5.0.0
downloadAttachment 下载消息的附件。 V5.0.0
downloadThumbnail 下载消息的缩略图。 V5.0.0
getAllConversations 获取本地当前所有会话。 V5.0.0
getUnreadMessageCount 获取未读消息数。 V5.0.0
asyncDeleteConversations 批量删除本地会话。 V5.0.0
deleteConversationFromServer 删除服务端和本地的指定会话及其历史消息。 V5.0.0
asyncFetchGroupMessageReadReceipts 从服务器分页获取指定群消息的已读回执。 V5.0.0
searchMsgFromDB 从本地数据库获取一定数量的特定类型的消息。 V5.0.0
deleteMessagesBeforeTimestamp 删除指定时间戳之前的本地历史消息。 V5.0.0
fetchSupportLanguages 获取翻译服务支持的语言。 V5.0.0
translateMessage 翻译一条文本消息。 V5.0.0
voiceMessageToText 将语音消息转换为文本。 V5.0.0
voiceFileToText 将本地语音文件转换为文本。 V5.0.0
asyncAddReaction 添加 Reaction。 V5.0.0
asyncRemoveReaction 删除 Reaction。 V5.0.0
asyncGetReactionList 获取 Reaction 列表。 V5.0.0
asyncGetReactionDetail 获取 Reaction 详细信息。 V5.0.0
addMessageListener 注册消息监听器。 V5.0.0
addConversationListener 注册会话监听器。 V5.0.0
asyncPinMessage 置顶消息。 V5.0.0
asyncUnPinMessage 取消置顶消息。 V5.0.0
asyncModifyMessage 修改本地以及服务端消息。 V5.0.0
asyncFetchHistoryMessages 根据消息拉取参数配置类(EMFetchMessageOption)从服务器分页获取指定会话的历史消息。 V5.0.0
asyncSearchMessagesFromServer 从服务器搜索消息。 V5.0.0
asyncAddConversationMark 标记会话。 V5.0.0
asyncRemoveConversationMark 取消标记会话。 V5.0.0
asyncDeleteAllMsgsAndConversations 清空所有会话及其消息。 V5.0.0
asyncGetPinnedMessagesFromServer 从服务端获取置顶消息。 V5.0.0
asyncGetMessageCount 获取本地数据库中的消息总数。 V5.0.0
asyncLoadMessages 从 SDK 本地数据库获取指定 ID 的消息,一次最多获取20条消息,返回的消息按照时间倒序排列。 V5.0.0
事件 描述 起始版本
onMessageReceived 收到消息。 V5.0.0
onCmdMessageReceived 收到命令消息。 V5.0.0
onMessageReadReceipts 收到消息已读回执。 V5.0.0
onMessageDelivered 收到消息的送达回执。 V5.0.0
onMessageRecalledWithExt 撤回收到的消息。 V5.0.0
onMessageChanged 收到消息变化,包括消息 ID 的变化。 V5.0.0
onReactionChanged 收到 Reaction 变更消息。 V5.0.0
onConversationUpdate 会话变更回调。 V5.0.0
onMessagePinChanged 收到消息的置顶状态变化。 V5.0.0
onMessageContentChanged 收到消息内容变化。 V5.0.0
onStreamMessageReceived 收到流式消息。 V5.0.0

Messages

方法 描述 起始版本
conversationId 会话 ID,取决于会话类型。 V5.0.0
getUnreadMsgCount 获取会话中未读的消息数量。 V5.0.0
getAllMsgCount 获取 SDK 本地数据库中会话的全部消息数。 V5.0.0
isChatThread 查看当前会话是否是子区会话。 V5.0.0
loadMoreMsgFromDB 从 SDK 本地数据库中分页加载消息。 V5.0.0
removeMessage 删除本地数据库中的一条指定消息。 V5.0.0
getLastMessage 获取会话中的最新一条消息。 V5.0.0
getLatestMessageFromOthers 获取会话中收到的最新一条消息。 V5.0.0
getConversationName 获取会话名称。 V5.0.0
getConversationAvatar 获取会话头像。 V5.0.0
clearAllMessages 清除内存和数据库中指定会话中的消息。 V5.0.0
getExtField 获取会话的扩展字段。 V5.0.0
insertMessage 在本地数据库的会话中插入一条消息。 V5.0.0
appendMessage 在本地数据库中会话的尾部插入一条消息。 V5.0.0
updateMessage 更新本地数据库的指定消息。 V5.0.0
status 获取消息的发送/接收状态。 V5.0.0
getChatType 获取聊天类型。 V5.0.0
getBody 获取消息体。 V5.0.0
getMsgTime 获取消息的服务器时间戳。 V5.0.0
localTime 获取消息的本地时间戳。 V5.0.0
isChatThreadMessage 获取消息是否是子区消息。 V5.0.0
getChatThread 获取子区概览信息。 V5.0.0
getFrom 获取消息发送方的用户 ID。 V5.0.0
getTo 获取消息接收方。 V5.0.0
getMsgId 获取消息的 ID。 V5.0.0
ext 获取消息包含的全部扩展字段。 V5.0.0
isRead 检查消息是否已读。 V5.0.0
isPeerRead 获取对方是否已读。 V5.0.0
isNeedReadReceipt 该消息是否需要已读回执,发送前设置。 V5.0.0
readReceiptCount 消息已读人数。 V5.0.0
isDelivered 获取消息是否成功送达。 V5.0.0
isListened 获取语音消息是否已听。 V5.0.0
direct 消息方向。 V5.0.0
conversationId 获取会话 ID。 V5.0.0
getMessageReaction 获取 Reaction 列表。 V5.0.0
isOnlineState 是否为在线消息。 V5.0.0
pinnedInfo 获取消息的置顶详情。 V5.0.0
getSenderInfo 获取消息发送者信息。 V5.0.0
getMessageId 获取消息 ID。 V5.0.0
getConversationId 获取会话 ID。 V5.0.0
isPeerReceipt 单聊消息接收方是否已发送已读回执。 V5.0.0
getReadCount 获取群聊消息已读人数。 V5.0.0

Contacts

方法 描述 起始版本
asyncFetchAllContactsFromLocal 从本地获取所有好友。 V5.0.0
asyncSetContactRemark 设置好友备注。 V5.0.0
fetchContactFromLocal 从本地获取单个好友。 V5.0.0
asyncAddUserToBlackList 把指定用户加入到黑名单中。 V5.0.0
asyncRemoveUserFromBlackList 将用户从黑名单中移除。 V5.0.0
getBlackListUsernames 从本地获取黑名单列表。 V5.0.0
asyncGetBlackListFromServer 从服务器获取黑名单列表。 V5.0.0
asyncAcceptInvitation 接受加好友的邀请。 V5.0.0
asyncDeclineInvitation 拒绝加好友的邀请。 V5.0.0
getContactsFromLocal 从数据库获取好友列表。 V5.0.0
asyncGetSelfIdsOnOtherPlatform 从服务器获取当前用户的其他登录设备的登录 ID 列表。 V5.0.0
setContactListener 注册联系人监听。 V5.0.0
事件 描述 起始版本
onContactAdded 添加好友回调。 V5.0.0
onContactDeleted 被删除联系人时的回调。 V5.0.0
onContactInvited 收到好友邀请的回调。 V5.0.0
onFriendRequestAccepted 好友请求被同意的回调。 V5.0.0
onFriendRequestDeclined 好友请求被拒绝的回调。 V5.0.0
onContactInfoUpdate 好友信息变更时回调。 V5.0.0

Chat Group

方法 描述 起始版本
asyncCreateGroup 创建群组。 V5.0.0
asyncDestroyGroup 解散群组。 V5.0.0
asyncLeaveGroup 当前登录用户退出群组。 V5.0.0
asyncJoinGroup 当前登录用户加入公开群。 V5.0.0
asyncAddUsersToGroup 向群组中添加新成员。 V5.0.0
asyncRemoveUsersFromGroup 从群组中删除成员。 V5.0.0
asyncGetGroupFromServer 从服务器获取群组的详细信息。 V5.0.0
asyncGetJoinedGroupsCountFromServer 从服务器获取当前用户已加入的群组数量。 V5.0.0
asyncChangeGroupName 修改群组名称。 V5.0.0
asyncChangeGroupAvatar 修改群组头像。 V5.0.0
asyncUpdateGroupConfigs 批量更新群组配置。 V5.0.0
asyncChangeGroupDescription 修改群描述。 V5.0.0
asyncAcceptInvitation 接受入群邀请。 V5.0.0
asyncDeclineInvitation 拒绝入群邀请。 V5.0.0
asyncAcceptApplication 批准入群申请。 V5.0.0
asyncDeclineApplication 拒绝入群申请。 V5.0.0
asyncApplyJoinToGroup 申请加入群组。 V5.0.0
asyncBlockGroupMessage 屏蔽群消息。 V5.0.0
asyncUnblockGroupMessage 取消屏蔽群消息。 V5.0.0
asyncBlockUser 将用户加入群组黑名单。 V5.0.0
asyncUnblockUser 将用户从群组黑名单移除。 V5.0.0
asyncFetchGroupBlackList 获取群组黑名单(带分页)。 V5.0.0
asyncFetchGroupMembers 以分页方式获取群组成员列表。 V5.0.0
asyncChangeOwner 移交群组所有权。 V5.0.0
asyncAddGroupAdmin 添加群组管理员。 V5.0.0
asyncRemoveGroupAdmin 删除群组管理员。 V5.0.0
asyncMuteGroupMembers 将一组成员禁言。 V5.0.0
asyncUnMuteGroupMembers 解除禁言。 V5.0.0
asyncFetchGroupMuteList 获取群组的禁言列表。 V5.0.0
addToGroupWhiteList 添加白名单。 V5.0.0
removeFromGroupWhiteList 移除白名单。 V5.0.0
fetchGroupWhiteList 获取群组白名单列表。 V5.0.0
asyncUpdateGroupAnnouncement 更新群公告。 V5.0.0
asyncFetchGroupAnnouncement 从服务器获取群公告。 V5.0.0
asyncUploadGroupSharedFile 上传共享文件至群组。 V5.0.0
asyncFetchGroupSharedFileList 从服务器获取群共享文件列表。 V5.0.0
asyncDeleteGroupSharedFile 删除群组指定的共享文件。 V5.0.0
asyncDownloadGroupSharedFile 下载群组中指定的共享文件。 V5.0.0
getAllGroups 获取当前(内存)用户的所有群组。 V5.0.0
asyncSetGroupMemberAttributes 设置单个群成员的自定义属性。 V5.0.0
asyncFetchGroupMemberAllAttributes 获取单个群成员所有自定义属性。 V5.0.0
asyncFetchGroupMembersAttributes 根据指定的属性 key 获取多个群成员的自定义属性。 V5.0.0
asyncUpdateGroupNamecard 设置或更新当前用户在指定群组中的名片。 V5.0.0
getGroupNamecard 获取本地内存中指定用户在指定群组中的名片。 V5.0.0
addGroupChangeListener 注册群变动事件监听。 V5.0.0
事件 描述 起始版本
onInvitationReceived 用户收到入群邀请的回调。 V5.0.0
onRequestToJoinReceived 用户申请入群回调。 V5.0.0
onRequestToJoinAccepted 接受入群申请回调。 V5.0.0
onRequestToJoinDeclined 拒绝入群申请回调。 V5.0.0
onInvitationAccepted 接受入群邀请回调。 V5.0.0
onInvitationDeclined 拒绝群组邀请回调。 V5.0.0
onAutoAcceptInvitationFromGroup 自动接受入群邀请回调。 V5.0.0
onUserRemoved 当前登录用户被管理员移出群组回调。 V5.0.0
onMuteListAdded 有成员被禁言。 V5.0.0
onMuteListRemoved 有成员被解除禁言。 V5.0.0
onWhiteListAdded 添加白名单回调。 V5.0.0
onWhiteListRemoved 移除白名单回调。 V5.0.0
onAllMemberMuteStateChanged 全员禁言状态变化回调。 V5.0.0
onAdminAdded 成员设置为管理员回调。 V5.0.0
onAdminRemoved 取消成员的管理员权限回调。 V5.0.0
onOwnerChanged 转移群主权限回调。 V5.0.0
onMembersJoined 当一个或多个成员加入群组时触发。 V5.0.0
onMembersExited 当一个或多个成员离开群组时触发。 V5.0.0
onAnnouncementChanged 群公告更新回调。 V5.0.0
onSharedFileAdded 群组添加共享文件回调。 V5.0.0
onSharedFileDeleted 群组删除共享文件回调。 V5.0.0
onSpecificationChanged 群组详情更新回调,需调用com.hyphenate.chat.EMGroupManager#asyncGetGroupFromServer(String, EMValueCallBack)获取最新群组信息。 V5.0.0
onStateChanged 群组禁用或启动状态回调。 V5.0.0
onGroupMemberAttributeChanged 群组成员自定义属性变更回调。 V5.0.0
onUserGroupNamecardUpdated 群成员名片更新回调。 V5.0.0

Chat Room

方法 描述 起始版本
joinChatRoom 加入聊天室。 V5.0.0
leaveChatRoom 退出聊天室。 V5.0.0
asyncFetchPublicChatRoomsFromServer 以分页的方式从服务器获取聊天室。 V5.0.0
asyncFetchChatRoomFromServer 从服务器获取聊天室详情。 V5.0.0
asyncChangeChatRoomSubject 修改聊天室名称。 V5.0.0
asyncChangeChatroomDescription 修改聊天室描述信息。 V5.0.0
asyncFetchChatRoomMembers 获取聊天室成员列表。 V5.0.0
asyncMuteChatRoomMembers 将一组成员禁言。 V5.0.0
asyncUnMuteChatRoomMembers 解除禁言。 V5.0.0
asyncAddChatRoomAdmin 添加聊天室管理员。 V5.0.0
asyncRemoveChatRoomAdmin 移除聊天室管理员权限。 V5.0.0
asyncFetchChatRoomMuteList 获取聊天室禁言列表。 V5.0.0
asyncRemoveChatRoomMembers 将成员移出聊天室。 V5.0.0
asyncBlockChatroomMembers 将成员添加到聊天室黑名单。 V5.0.0
asyncUnBlockChatRoomMembers 从聊天室黑名单中移除成员。 V5.0.0
asyncFetchChatRoomBlackList 以分页的形式获取聊天室黑名单列表。 V5.0.0
addToChatRoomWhiteList 将成员添加到白名单。 V5.0.0
removeFromChatRoomWhiteList 将成员从白名单移除。 V5.0.0
fetchChatRoomWhiteList 从服务器获取白名单列表。 V5.0.0
muteAllMembers 设置全员禁言。 V5.0.0
unmuteAllMembers 解除所有成员的禁言状态。 V5.0.0
asyncUpdateChatRoomAnnouncement 更新聊天室公告。 V5.0.0
asyncFetchChatRoomAnnouncement 从服务器获取聊天室公告内容。 V5.0.0
asyncSetChatroomAttributes 设置多个聊天室自定义属性。 V5.0.0
asyncSetChatroomAttribute 设置聊天室单个自定义属性。 V5.0.0
asyncSetChatroomAttributesForced 强制设置多个聊天室自定义属性。 V5.0.0
asyncSetChatroomAttributeForced 强制设置单个聊天室自定义属性。 V5.0.0
asyncFetchChatroomAttributesFromServer 根据聊天室属性 key 列表获取属性列表。 V5.0.0
asyncFetchChatRoomAllAttributesFromServer 获取聊天室所有自定义属性。 V5.0.0
asyncRemoveChatRoomAttributesFromServer 根据聊天室自定义属性 key 列表批量删除自定义聊天室属性。 V5.0.0
asyncRemoveChatRoomAttributeFromServer 删除单个聊天室属性。 V5.0.0
asyncRemoveChatRoomAttributesFromServerForced 强制删除多个聊天室自定义属性。 V5.0.0
asyncRemoveChatRoomAttributeFromServerForced 强制删除单个聊天室自定义属性。 V5.0.0
addChatRoomChangeListener 注册聊天室事件监听对象。 V5.0.0
事件 描述 起始版本
onRemovedFromChatRoom 有成员被移出聊天室。 V5.0.0
onMemberJoined 有新成员加入聊天室。 V5.0.0
onMemberExited 有成员主动退出聊天室。 V5.0.0
onMuteListAdded 有成员被禁言。 V5.0.0
onMuteListRemoved 有成员从禁言列表中移除。 V5.0.0
onWhiteListAdded 有成员加入白名单。 V5.0.0
onWhiteListRemoved 有成员被移出白名单。 V5.0.0
onAllMemberMuteStateChanged 全员禁言状态有变更。 V5.0.0
onAdminAdded 有成员被设置为管理员。 V5.0.0
onAdminRemoved 有成员被移出管理员列表。 V5.0.0
onOwnerChanged 聊天室所有者变更。 V5.0.0
onAnnouncementChanged 聊天室公告有变更。 V5.0.0
onSpecificationChanged 聊天室信息有更新。 V5.0.0
onAttributesUpdate 聊天室自定义属性(key-value)有更新。 V5.0.0
onAttributesRemoved 聊天室自定义属性被移除。 V5.0.0

Presence

方法 描述 起始版本
publishPresence 发布自定义在线状态。 V5.0.0
subscribePresences 订阅指定用户的在线状态。 V5.0.0
unsubscribePresences 取消订阅指定用户的在线状态。 V5.0.0
fetchSubscribedMembers 分页查询当前用户订阅了哪些用户的在线状态。 V5.0.0
fetchPresenceStatus 查询指定用户的当前在线状态。 V5.0.0
addListener 添加监听。 V5.0.0
事件 描述 起始版本
onPresenceUpdated 当订阅的用户的在线状态更新时触发。 V5.0.0

Threading

方法 描述 起始版本
createChatThread 创建子区。 V5.0.0
joinChatThread 加入子区。 V5.0.0
destroyChatThread 解散子区。 V5.0.0
leaveChatThread 退出子区。 V5.0.0
getChatThreadFromServer 从服务器获取子区详情。 V5.0.0
updateChatThreadName 修改子区名称。 V5.0.0
removeMemberFromChatThread 移除子区成员。 V5.0.0
getChatThreadMembers 分页获取子区成员。 V5.0.0
getJoinedChatThreadsFromServer 分页从服务器获取当前用户加入的子区列表。 V5.0.0
getJoinedChatThreadsFromServer 分页从服务器获取当前用户加入指定群组的子区列表。 V5.0.0
getChatThreadsFromServer 分页从服务器端获取指定群组的子区列表。 V5.0.0
getChatThreadLatestMessage 从服务器批量获取指定子区中的最新一条消息。 V5.0.0
addChatThreadChangeListener 注册子区事件监听器,用于监听子区变化,如子区的创建和解散等。 V5.0.0
事件 描述 起始版本
onChatThreadCreated 子区创建回调。 V5.0.0
onChatThreadUpdated 子区更新回调。 V5.0.0
onChatThreadDestroyed 子区解散回调。 V5.0.0
onChatThreadUserRemoved 当前登录用户被群主或群管理员移出子区。 V5.0.0

Offline push

方法 描述 起始版本
getPushConfigsFromServer 从服务器获取推送配置信息。 V5.0.0
asyncUpdatePushNickname 更新当前用户的推送昵称。 V5.0.0
setSilentModeForConversation 设置会话的免打扰。 V5.0.0
clearRemindTypeForConversation 清除会话的离线推送提醒类型设置。 V5.0.0
getSilentModeForConversation 获取会话的免打扰设置。 V5.0.0
setSilentModeForAll 设置当前登录用户的免打扰设置。 V5.0.0
getSilentModeForAll 获取当前登录用户的免打扰设置。 V5.0.0
getSilentModeForConversations 批量获取指定会话的免打扰设置。 V5.0.0
bindDeviceToken 绑定设备 token 到服务器。 V5.0.0

User Attributes

方法 描述 起始版本
updateOwnInfo 修改当前用户的用户属性。 V5.0.0
updateOwnInfoByAttribute 修改当前用户的属性。 V5.0.0
fetchUserInfoByUserId 根据用户 ID 获取用户属性。 V5.0.0
fetchUserInfoByAttribute 获取一个或多个用户的任意单个或多个属性。 V5.0.0
getUserInfoWithUserIds 根据用户 ID 从本地内存批量获取用户属性。 V5.0.0
subscribeUsersInfo 根据用户 ID 订阅陌生人的用户属性更新事件。 V5.0.0
unsubscribeUsersInfo 根据用户 ID 取消订阅陌生人的用户属性变更事件。 V5.0.0
fetchSubscribedUsers 获取已被订阅属性更新事件的陌生人的用户属性。 V5.0.0
addUserInfoManagerListener 添加用户属性更新监听器。 V5.0.0
事件 描述 起始版本
onSelfUserInfoUpdate 当前用户的信息更新回调。 V5.0.0
onUserInfoUpdate 其他用户的信息更新回调。 V5.0.0