类
enum	SubscribeMode

Public 成员函数
void	sendMessage (final EMMessage msg)

void	ackConversationRead (String conversationId) throws HyphenateException

void	ackMessageRead (String to, String messageId) throws HyphenateException

void	ackGroupMessageRead (String to, String messageId, String ext) throws HyphenateException

void	recallMessage (EMMessage message) throws HyphenateException

void	asyncRecallMessage (final EMMessage message, final EMCallBack callback)

EMMessage	getMessage (String messageId)

EMConversation	getConversation (String id)

EMConversation	getConversation (String id, EMConversationType type)

EMConversation	getConversation (String username, EMConversationType type, boolean createIfNotExists)

EMConversation	getConversation (String username, EMConversationType type, boolean createIfNotExists, boolean isChatThread)

EMConversation	getConversation (String username, EMConversationType type, boolean createIfNotExists, boolean isChatThread, boolean isChannel)

void	markAllConversationsAsRead ()

int	getUnreadMessageCount ()

void	saveMessage (EMMessage message)

boolean	updateMessage (EMMessage message)

void	downloadAttachment (final EMMessage msg)

void	downloadThumbnail (final EMMessage msg)

synchronized void	importMessages (List< EMMessage > msgs)

List< EMConversation >	getConversationsByType (EMConversationType type)

Map< String, EMConversation >	getAllConversations ()

Map< String, EMConversation >	fetchConversationsFromServer () throws HyphenateException

void	asyncFetchConversationsFromServer (final EMValueCallBack< Map< String, EMConversation > > callBack)

void	loadAllConversations ()

boolean	deleteConversation (String username, boolean deleteMessages)

void	deleteConversationFromServer (String username, EMConversationType type, boolean isDeleteServerMessages, EMCallBack deleteCallBack)

void	addMessageListener (EMMessageListener listener)

void	removeMessageListener (EMMessageListener listener)

void	addConversationListener (EMConversationListener listener)

void	removeConversationListener (EMConversationListener listener)

void	setVoiceMessageListened (EMMessage message)

boolean	updateParticipant (String from, String changeTo)

EMCursorResult< EMGroupReadAck >	fetchGroupReadAcks (String msgId, int pageSize, String startAckId) throws HyphenateException

void	asyncFetchGroupReadAcks (final String msgId, final int pageSize, final String startAckId, final EMValueCallBack< EMCursorResult< EMGroupReadAck > > callBack)

EMCursorResult< EMMessage >	fetchHistoryMessages (String conversationId, EMConversationType type, int pageSize, String startMsgId) throws HyphenateException

EMCursorResult< EMMessage >	fetchHistoryMessages (String conversationId, EMConversationType type, int pageSize, String startMsgId, EMConversation.EMSearchDirection direction) throws HyphenateException

void	asyncFetchHistoryMessage (final String conversationId, final EMConversationType type, final int pageSize, final String startMsgId, final EMValueCallBack< EMCursorResult< EMMessage > > callBack)

void	asyncFetchHistoryMessage (final String conversationId, final EMConversationType type, final int pageSize, final String startMsgId, final EMConversation.EMSearchDirection direction, final EMValueCallBack< EMCursorResult< EMMessage > > callBack)

List< EMMessage >	searchMsgFromDB (Type type, long timeStamp, int maxCount, String from, EMConversation.EMSearchDirection direction)

List< EMMessage >	searchMsgFromDB (String keywords, long timeStamp, int maxCount, String from, EMConversation.EMSearchDirection direction)

void	deleteMessagesBeforeTimestamp (long timeStamp, EMCallBack callback)

void	asyncReportMessage (String msgId, String reportTarget, String reportReason, EMCallBack callBack)

void	reportMessage (String msgId, String reportTarget, String reportReason) throws HyphenateException

void	fetchSupportLanguages (EMValueCallBack< List< EMLanguage > > callBack)

void	translateMessage (EMMessage message, List< String > languages, EMValueCallBack< EMMessage > callBack)

void	addReaction (final String messageId, final String reaction) throws HyphenateException

void	asyncAddReaction (final String messageId, final String reaction, final EMCallBack callback)

void	removeReaction (final String messageId, final String reaction) throws HyphenateException

void	asyncRemoveReaction (final String messageId, final String reaction, final EMCallBack callback)

Map< String, List< EMMessageReaction > >	getReactionList (final List< String > messageIdList, final EMMessage.ChatType chatType, final String groupId) throws HyphenateException

void	asyncGetReactionList (final List< String > messageIdList, final EMMessage.ChatType chatType, final String groupId, final EMValueCallBack< Map< String, List< EMMessageReaction > > > callback)

EMCursorResult< EMMessageReaction >	getReactionDetail (final String messageId, final String reaction, final String cursor, final int pageSize) throws HyphenateException

void	asyncGetReactionDetail (final String messageId, final String reaction, final String cursor, final int pageSize, final EMValueCallBack< EMCursorResult< EMMessageReaction > > callback)

void	clearCaches (String conversationId, long beforeTimeStamp)

void	clearCaches (String conversationId, List< String > msgIdList)

void	setConversationSubscribeMode (String conversationId, SubscribeMode mode)

Protected 成员函数
	EMChatManager (EMClient client, EMAChatManager manager, EMAReactionManager reactionManager)

void	removeMessagesFromServer (String conversationId, EMConversationType type, List< String > msgIdList, EMCallBack callBack)

void	removeMessagesFromServer (String conversationId, EMConversationType type, long beforeTimeStamp, EMCallBack callBack)

详细描述

聊天管理类，该类负责管理会话（加载，删除等）、发送消息、下载消息附件等。

发送文文本消息示例如下：

EMMessage message = EMMessage.createTxtSendMessage(content, toChatUsername);

EMClient.getInstance().chatManager().sendMessage(message);

成员函数说明

◆ ackConversationRead()

void com.hyphenate.chat.EMChatManager.ackConversationRead ( String conversationId ) throws HyphenateException

发送会话的已读回执，该方法只针对单聊会话。

该方法会通知服务器将此会话未读数设置为 0，消息发送方将会收到 EMConversationListener#onConversationRead(String, String) 回调。在多端多设备登录下，接收方的其他设备也会收到该回调。

群消息已读回执，详见 ackGroupMessageRead(String, String, String)。

参数

conversationId 会话 ID。

异常

HyphenateException 可能抛出以下异常：EMError#USER_NOT_LOGIN、EMError#SERVER_NOT_REACHABLE、 EMError#MESSAGE_INVALID 等，详见 EMError。

◆ ackGroupMessageRead()

void com.hyphenate.chat.EMChatManager.ackGroupMessageRead	(	String	to,
		String	messageId,
		String	ext
	)		throws HyphenateException

发送群消息已读回执。

注意

设置了 EMOptions#setRequireAck(boolean) 和 EMMessage#setIsNeedGroupAck(boolean) 后才能调用该方法。

发送单聊消息已读回执，详见 ackMessageRead(String, String)

会话已读回执，详见 ackConversationRead(String)。

参数

to	会话 ID。
messageId	消息 ID。
ext	扩展信息。用户通过定义关键字指定动作或命令。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ ackMessageRead()

void com.hyphenate.chat.EMChatManager.ackMessageRead	(	String	to,
		String	messageId
	)		throws HyphenateException

发送消息的已读回执。

该方法仅适用于单聊会话，仅在 EMOptions#setRequireAck(boolean) 为 true 时生效。

发送群消息已读回执，详见 ackGroupMessageRead(String, String, String)。

推荐进入聊天页面的时调用 ackConversationRead(String) ，其他情况下调用该方法以减少调用频率。

参数

to	接收方的用户 ID。
messageId	消息的 ID。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ addConversationListener()

void com.hyphenate.chat.EMChatManager.addConversationListener ( EMConversationListener listener )

注册会话监听器。

会话监听器可监听会话变化及会话已读回执。

在不需要会话监听器时，可调用 removeConversationListener(EMConversationListener) 方法移除。

参数

listener 要添加的会话监听，详见 EMConversationListener。

◆ addMessageListener()

void com.hyphenate.chat.EMChatManager.addMessageListener ( EMMessageListener listener )

注册消息监听器。

接收到新消息等回调可以通过设置此方法进行监听。

在不需要消息监听器时，可调用 removeMessageListener(EMMessageListener) 方法将其移除。

参数

listener 要注册的消息监听，详见 EMMessageListener。

◆ addReaction()

void com.hyphenate.chat.EMChatManager.addReaction	(	final String	messageId,
		final String	reaction
	)		throws HyphenateException

添加 Reaction。

同步方法。

参数

messageId	消息 ID。
reaction	要添加的消息 Reaction。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ asyncAddReaction()

void com.hyphenate.chat.EMChatManager.asyncAddReaction	(	final String	messageId,
		final String	reaction,
		final EMCallBack	callback
	)

添加 Reaction。

异步方法。

参数

messageId	消息 ID。
reaction	要添加的消息 Reaction。
callback	处理结果回调，失败会返回失败原因。详见 EMCallBack。

◆ asyncFetchConversationsFromServer()

void com.hyphenate.chat.EMChatManager.asyncFetchConversationsFromServer ( final EMValueCallBack< Map< String, EMConversation > > callBack )

从服务器获取会话列表。

该功能需联系商务开通。开通后，用户默认可拉取 7 天内的 10 个会话（每个会话包含最新一条历史消息）。如需调整会话数量或时间限制请联系商务经理。

异步方法。

返回: 当前用户的会话列表。

◆ asyncFetchGroupReadAcks()

void com.hyphenate.chat.EMChatManager.asyncFetchGroupReadAcks	(	final String	msgId,
		final int	pageSize,
		final String	startAckId,
		final EMValueCallBack< EMCursorResult< EMGroupReadAck > >	callBack
	)

从服务器分页获取群组消息已读回执详情。

发送群组消息回执，可调用 ackGroupMessageRead(String, String, String)。

异步方法。

参数

msgId	消息 ID。
pageSize	每页获取的群消息已读回执数。取值范围为 [1,50]。
startAckId	查询起始的已读回执 ID。该参数设置后，SDK 从指定的已读回执 ID 开始，按服务器接收已读回执的时间的逆序获取。若该参数为空，SDK 从最新的已读回执开始按服务器接收回执时间的逆序获取。
callBack	结果回调。调用成功，触发 EMValueCallBack#onSuccess(Object) 回调，返回查询的已读回执列表（不包含查询起始 ID 的已读回执）和下次查询的 cursor。调用失败，触发 EMValueCallBack#onError(int, String) 回调报错。

◆ asyncFetchHistoryMessage() [1/2]

void com.hyphenate.chat.EMChatManager.asyncFetchHistoryMessage	(	final String	conversationId,
		final EMConversationType	type,
		final int	pageSize,
		final String	startMsgId,
		final EMConversation.EMSearchDirection	direction,
		final EMValueCallBack< EMCursorResult< EMMessage > >	callBack
	)

从服务器分页获取指定会话的历史消息。

异步方法。

参数

conversationId	会话 ID。
type	会话类型，详见 EMConversationType。
pageSize	每页期望获取的消息数。取值范围为 [1,50]。
startMsgId	查询的起始消息 ID。该参数设置后，SDK 从指定的消息 ID 开始，按消息搜索方向获取。如果传入消息的 ID 为空，SDK 忽略该参数，按搜索方向查询消息。若 `direction` 为 `UP`，SDK 从最新消息开始，按照服务器接收消息时间的逆序获取；若 `direction` 为 `DOWN`，SDK 从最早消息开始，按照服务器接收消息时间的正序获取。
direction	消息搜索方向。详见 EMConversation.EMSearchDirection。 `UP`：按照消息中的时间戳的逆序查询； `DOWN`：按照消息中的时间戳的正序查询；
callBack	结果回调：调用成功，触发 EMValueCallBack#onSuccess(Object)，返回消息列表（不包含查询起始 ID 的消息）和下次查询的 cursor；调用失败，触发 EMValueCallBack#onError(int, String) 报错。

◆ asyncFetchHistoryMessage() [2/2]

void com.hyphenate.chat.EMChatManager.asyncFetchHistoryMessage	(	final String	conversationId,
		final EMConversationType	type,
		final int	pageSize,
		final String	startMsgId,
		final EMValueCallBack< EMCursorResult< EMMessage > >	callBack
	)

从服务器分页获取指定会话的历史消息。

异步方法。

参数

conversationId	会话 ID。
type	会话类型，详见 EMConversationType。
pageSize	每页期望获取的消息条数。取值范围为 [1,50]。
startMsgId	查询的起始消息 ID。该参数设置后，SDK 从指定的消息 ID 开始，按服务器接收消息的时间的逆序获取。若该参数为空，SDK 从最新的消息开始，按服务器接收消息的时间的逆序获取。
callBack	结果回调，成功则执行 EMValueCallBack#onSuccess(Object)，返回消息列表（不包含查询起始 ID 的消息）和下次查询的 cursor；失败则执行 EMValueCallBack#onError(int, String)。

◆ asyncGetReactionDetail()

void com.hyphenate.chat.EMChatManager.asyncGetReactionDetail	(	final String	messageId,
		final String	reaction,
		final String	cursor,
		final int	pageSize,
		final EMValueCallBack< EMCursorResult< EMMessageReaction > >	callback
	)

获取 Reaction 详细信息。

异步方法。

参数

messageId	消息 ID。
reaction	消息 Reaction。
cursor	查询的起始游标位置。
pageSize	每页期望获取的 Reaction 数。
callback	处理结果回调，包含 cursor 和 EMMessageReaction 列表（仅使用该列表第一个数据即可）。

◆ asyncGetReactionList()

void com.hyphenate.chat.EMChatManager.asyncGetReactionList	(	final List< String >	messageIdList,
		final EMMessage.ChatType	chatType,
		final String	groupId,
		final EMValueCallBack< Map< String, List< EMMessageReaction > > >	callback
	)

获取 Reaction 列表。

异步方法。

参数

messageIdList	消息 ID。
chatType	会话类型，仅支持单聊（EMMessage.ChatType#Chat ）和群聊（EMMessage.ChatType#GroupChat）。
groupId	群组 ID，该参数只对群聊生效。
callback	处理结果回调，包含消息 ID 对应的 Reaction 列表（EMMessageReaction 的用户列表 `UserList` 为概要数据，只包含前三个用户信息）。

◆ asyncRecallMessage()

void com.hyphenate.chat.EMChatManager.asyncRecallMessage	(	final EMMessage	message,
		final EMCallBack	callback
	)

撤回发送成功的消息。

异步方法。

参数

message	消息对象。
callback	EMCallBack 类的对象，详见 EMCallBack。

◆ asyncRemoveReaction()

void com.hyphenate.chat.EMChatManager.asyncRemoveReaction	(	final String	messageId,
		final String	reaction,
		final EMCallBack	callback
	)

删除 Reaction。

异步方法。

参数

messageId	消息 ID。
reaction	要删除的 Reaction。
callback	处理结果回调，详见 EMCallBack。

◆ asyncReportMessage()

void com.hyphenate.chat.EMChatManager.asyncReportMessage	(	String	msgId,
		String	reportTarget,
		String	reportReason,
		EMCallBack	callBack
	)

举报非法消息。

异步方法。

参数

msgId	非法消息的 ID。
reportTarget	非法消息标签，如涉政或涉恐。
reportReason	举报原因。
callBack	结果回调，详见 EMCallBack：调用成功，触发 EMCallBack#onSuccess() 回调；调用失败，触发 EMCallBack#onError(int, String) 回调。

◆ deleteConversation()

boolean com.hyphenate.chat.EMChatManager.deleteConversation	(	String	username,
		boolean	deleteMessages
	)

删除指定会话及其本地历史消息。

参数

username	会话 ID。
deleteMessages	删除会话时是否同时删除本地的历史消息。 `true`：删除； `false`：不删除。

返回

会话是否删除成功。

true：是；
false：否。

◆ deleteConversationFromServer()

void com.hyphenate.chat.EMChatManager.deleteConversationFromServer	(	String	username,
		EMConversationType	type,
		boolean	isDeleteServerMessages,
		EMCallBack	deleteCallBack
	)

删除服务端的指定会话及其历史消息。

异步方法。

参数

username	会话 ID。
type	会话类型，详见 EMConversationType。
isDeleteServerMessages	删除会话时是否同时删除历史消息。 `true`：是； `false`: 否。
deleteCallBack	删除服务端会话及其历史消息成功与否的回调。 `true`：删除成功； `false`：删除失败。

◆ deleteMessagesBeforeTimestamp()

void com.hyphenate.chat.EMChatManager.deleteMessagesBeforeTimestamp	(	long	timeStamp,
		EMCallBack	callback
	)

删除指定时间戳之前的本地历史消息。

参数

timeStamp	查询的消息的起始 Unix 时间戳，单位为毫秒。
callback	删除结果回调，详见 EMCallBack。

◆ downloadAttachment()

void com.hyphenate.chat.EMChatManager.downloadAttachment ( final EMMessage msg )

下载消息的附件。

若附件自动下载失败，也可以调用此方法下载。

参数

msg 要下载附件的消息。

◆ downloadThumbnail()

void com.hyphenate.chat.EMChatManager.downloadThumbnail ( final EMMessage msg )

下载消息的缩略图。

参数

msg	要下载缩略图的消息。只有图片消息和视频消息有缩略图。

◆ fetchConversationsFromServer()

Map< String, EMConversation > com.hyphenate.chat.EMChatManager.fetchConversationsFromServer ( ) throws HyphenateException

从服务器获取会话列表。

该功能需联系商务开通。开通后，用户默认可拉取 7 天内的 10 个会话（每个会话包含最新一条历史消息）。如需调整会话数量或时间限制请联系商务经理。

同步方法，会阻塞当前线程。

返回: 返回当前用户的会话列表。

◆ fetchGroupReadAcks()

EMCursorResult< EMGroupReadAck > com.hyphenate.chat.EMChatManager.fetchGroupReadAcks	(	String	msgId,
		int	pageSize,
		String	startAckId
	)		throws HyphenateException

从服务器分页获取群组消息已读回执详情。

发送群组消息回执，可调用 ackGroupMessageRead(String, String, String)。

同步方法，会阻塞当前线程。

参数

msgId	消息 ID。
pageSize	每页期望返回的群消息已读数。取值范围[1,50]。
startAckId	查询起始的已读回执 ID。该参数设置后，SDK 从指定的已读回执 ID 开始，按服务器接收已读回执的时间的逆序获取。若该参数为空，SDK 从最新的已读回执开始按服务器接收回执时间的逆序获取。

返回: 返回消息列表（不包含查询起始 ID 的已读回执）和用于继续获取群消息回执的 cursor。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ fetchHistoryMessages() [1/2]

EMCursorResult< EMMessage > com.hyphenate.chat.EMChatManager.fetchHistoryMessages	(	String	conversationId,
		EMConversationType	type,
		int	pageSize,
		String	startMsgId
	)		throws HyphenateException

从服务器分页获取指定会话的历史消息。

同步方法，会阻塞当前线程。

参数

conversationId	会话 ID。
type	会话类型, 详见 EMConversationType。
pageSize	每页期望获取的消息条数。取值范围为 [1,50]。
startMsgId	开始获取的消息 ID。该参数设置后，SDK 从指定的消息 ID 开始，按服务器接收消息的时间的逆序获取。若该参数为空，SDK 从最新的消息开始，按服务器接收消息的时间的逆序获取。

返回: 消息列表（不包含查询起始 ID 的消息）和下次查询的 cursor。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ fetchHistoryMessages() [2/2]

EMCursorResult< EMMessage > com.hyphenate.chat.EMChatManager.fetchHistoryMessages	(	String	conversationId,
		EMConversationType	type,
		int	pageSize,
		String	startMsgId,
		EMConversation.EMSearchDirection	direction
	)		throws HyphenateException

从服务器分页获取指定会话的历史消息。

同步方法，会阻塞当前线程。

参数

conversationId	会话 ID。
type	会话类型, 详见 EMConversationType。
pageSize	每页期望获取的消息条数。取值范围为 [1,50]。
startMsgId	查询的起始消息 ID。该参数设置后，SDK 从指定的消息 ID 开始，按消息检索方向获取。如果传入消息的 ID 为空，SDK 忽略该参数，按搜索方向查询消息。若 `direction` 为 `UP`，SDK 从最新消息开始，按照服务器接收消息时间的逆序获取；若 `direction` 为 `DOWN`，SDK 从最早消息开始，按照服务器接收消息时间的正序获取。
direction	消息检索方向。详见 EMConversation.EMSearchDirection。（默认）`UP`：按照服务器接收消息时间的逆序获取； `DOWN`：按照服务器接收消息时间的正序获取。

返回: 消息列表（不包含查询起始 ID 的消息）和下次查询的 cursor。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ fetchSupportLanguages()

void com.hyphenate.chat.EMChatManager.fetchSupportLanguages ( EMValueCallBack< List< EMLanguage > > callBack )

获取翻译服务支持的语言。

参数

callBack

结果回调，详见 EMCallBack。

调用成功，触发 EMCallBack#onSuccess() 返回获取的语言；
调用失败，触发 EMCallBack#onError(int, String) 报错。

◆ getAllConversations()

Map< String, EMConversation > com.hyphenate.chat.EMChatManager.getAllConversations ( )

获取本地当前所有会话。

该方法会先从内存中获取，如果未找到任何会话，从本地数据库获取。当数据库文件较大时，可能会耗时较长，建议此时放在异步线程中调用。

返回: 返回本地内存或者数据库中所有的会话。

◆ getConversation() [1/5]

EMConversation com.hyphenate.chat.EMChatManager.getConversation ( String id )

获取指定 ID 的会话对象。

参数

id 会话 ID。

返回: 根据指定会话 ID 找到的会话对象，如果没有找到会返回空值。

◆ getConversation() [2/5]

EMConversation com.hyphenate.chat.EMChatManager.getConversation	(	String	id,
		EMConversationType	type
	)

根据会话 ID 以及会话类型获取会话。

没有找到返回空值。

参数

id	会话 ID。单聊：对端用户的用户 ID；群聊：群组 ID；聊天室：聊天室 ID；子区：子区 ID。
type	会话类型，详见 EMConversationType。

返回: 根据指定 ID 以及会话类型找到的会话对象，未找到会返回空值。

◆ getConversation() [3/5]

EMConversation com.hyphenate.chat.EMChatManager.getConversation	(	String	username,
		EMConversationType	type,
		boolean	createIfNotExists
	)

根据会话 ID 和会话类型获取会话。

参数

username	会话 ID。单聊：对端用户的用户 ID；群聊：群组 ID；聊天室：聊天室 ID；子区：子区 ID。
type	会话类型，详见 EMConversationType。
createIfNotExists	未找到指定会话时是否创建一个新会话。 `true`：是； `false`：否。

返回: 找到的会话对象，如果未找到，返回空值。

◆ getConversation() [4/5]

EMConversation com.hyphenate.chat.EMChatManager.getConversation	(	String	username,
		EMConversationType	type,
		boolean	createIfNotExists,
		boolean	isChatThread
	)

根据会话 ID 以及会话类型获取会话。

参数

username	会话 ID。单聊：对端用户的用户 ID；群聊：群组 ID；聊天室：聊天室 ID；子区：子区 ID。
type	会话类型，详见 EMConversationType。
createIfNotExists	未找到指定会话时是否创建一个新会话。 `true`：是； `false`：否。
isChatThread	是否查找子区会话。 `true`：是； `false`：否。

返回: 找到的会话对象。如果未找到，返回空值。

◆ getConversation() [5/5]

EMConversation com.hyphenate.chat.EMChatManager.getConversation	(	String	username,
		EMConversationType	type,
		boolean	createIfNotExists,
		boolean	isChatThread,
		boolean	isChannel
	)

根据用户或群组id以及会话类型获取会话。

没有找到的话，根据createIfNotExists的值返回一个新建对象或者空对象。

参数

username	会话ID。
type	会话类型。
createIfNotExists	没找到相应会话时是否自动创建。 `true` 表示没有找到相应会话时会自动创建会话； `false` 表示没有找到相应会话时不创建会话。
isChatThread	是否查找子区会话。 `true` 表示查找子区会话； `false` 表示不查找子区会话。
isChannel	是否在channel场景下查找。 `true` 表示在channel场景下； `false` 表示不在channel场景下。

返回: 根据指定 ID 以及会话类型找到的会话对象，如果没有找到会返回空值。 EMChatManager#getConversation(String, EMConversationType, boolean, boolean)

◆ getConversationsByType()

List< EMConversation > com.hyphenate.chat.EMChatManager.getConversationsByType ( EMConversationType type )

获取指定类型的所有会话。

参数

type	会话类型，详见 EMConversationType。

返回: 指定类型的会话列表。

◆ getMessage()

EMMessage com.hyphenate.chat.EMChatManager.getMessage ( String messageId )

获取指定 ID 的消息对象。

参数

messageId 消息 ID。

返回: 根据指定 ID 获取的消息对象，如果消息不存在会返回空值。

◆ getReactionDetail()

EMCursorResult< EMMessageReaction > com.hyphenate.chat.EMChatManager.getReactionDetail	(	final String	messageId,
		final String	reaction,
		final String	cursor,
		final int	pageSize
	)		throws HyphenateException

获取 Reaction 详细信息。

同步方法。

参数

messageId	消息 ID。
reaction	消息 Reaction 内容。
cursor	查询的起始游标位置。
pageSize	每页期望获取的 Reaction 数。

返回: 获取结果 EMCursorResult，包含 cursor 和 Reaction 列表。若 cursor 为空表示数据已全部获取。

◆ getReactionList()

Map< String, List< EMMessageReaction > > com.hyphenate.chat.EMChatManager.getReactionList	(	final List< String >	messageIdList,
		final EMMessage.ChatType	chatType,
		final String	groupId
	)		throws HyphenateException

获取 Reaction 列表。

同步方法。

参数

messageIdList	消息 ID。
chatType	会话类型，仅支持单聊（EMMessage.ChatType#Chat）和群聊（EMMessage.ChatType#GroupChat）。
groupId	群组 ID，该参数仅对群聊生效。

返回: map 指定消息 ID 对应的 Reaction 列表（EMMessageReaction 的用户列表 UserList 为概要数据，只包含前三个用户信息）。

◆ getUnreadMessageCount()

int com.hyphenate.chat.EMChatManager.getUnreadMessageCount ( )

获取未读消息数。

返回: 未读消息数。

◆ importMessages()

synchronized void com.hyphenate.chat.EMChatManager.importMessages ( List< EMMessage > msgs )

将消息导入本地数据库。

你只能将你发送或接收的消息导入本地数据库。

推荐一次导入 1,000 条以内的数据。

参数

msgs	需要导入数据库的消息。

◆ loadAllConversations()

void com.hyphenate.chat.EMChatManager.loadAllConversations ( )

从数据库加载本地所有的会话到内存中。

一般在登录成功后使用此方法，可以加快会话列表的加载速度。

◆ markAllConversationsAsRead()

void com.hyphenate.chat.EMChatManager.markAllConversationsAsRead ( )

将所有会话都设成已读。

该方法仅适用于本地会话。

◆ recallMessage()

void com.hyphenate.chat.EMChatManager.recallMessage ( EMMessage message ) throws HyphenateException

撤回发送成功的消息。

若消息发送和撤回时接收方为离线状态，接收方会收到消息撤回回调 EMMessageListener#onMessageRecalled，不会收到该消息。

同步方法，会阻塞当前线程。

参数

message 消息对象。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ removeConversationListener()

void com.hyphenate.chat.EMChatManager.removeConversationListener ( EMConversationListener listener )

移除会话监听器。

调用 addConversationListener(EMConversationListener) 添加会话监听器后再调用本方法移除。

参数

listener 要移除的会话监听器，详见 EMConversationListener。

◆ removeMessageListener()

void com.hyphenate.chat.EMChatManager.removeMessageListener ( EMMessageListener listener )

移除消息监听器。

调用 addMessageListener(EMMessageListener) 添加消息监听后再调用本方法移除。

参数

listener 要移除的监听器，详见 EMMessageListener。

◆ removeMessagesFromServer() [1/2]

void com.hyphenate.chat.EMChatManager.removeMessagesFromServer	(	String	conversationId,
		EMConversationType	type,
		List< String >	msgIdList,
		EMCallBack	callBack
	)

protected

单向删除漫游消息（根据msgId删除）

参数

conversationId	会话ID
type	会话类型
msgIdList	msgId列表
callBack	处理结果回调,详见 EMCallBack。

◆ removeMessagesFromServer() [2/2]

void com.hyphenate.chat.EMChatManager.removeMessagesFromServer	(	String	conversationId,
		EMConversationType	type,
		long	beforeTimeStamp,
		EMCallBack	callBack
	)

protected

单向删除漫游消息（根据时间节点删除只提供向上删除）

参数

conversationId	会话ID
type	会话类型
beforeTimeStamp	时间节点（毫秒）
callBack	处理结果回调,详见 EMCallBack。

◆ removeReaction()

void com.hyphenate.chat.EMChatManager.removeReaction	(	final String	messageId,
		final String	reaction
	)		throws HyphenateException

删除 Reaction。

同步方法。

参数

messageId	消息 ID。
reaction	要删除的 Reaction。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ reportMessage()

void com.hyphenate.chat.EMChatManager.reportMessage	(	String	msgId,
		String	reportTarget,
		String	reportReason
	)		throws HyphenateException

举报非法消息。

同步方法，会阻塞当前线程。

参数

msgId	非法消息的 ID。
reportTarget	非法消息标签，如涉政或涉恐。
reportReason	举报原因。

异常

HyphenateException 如果有异常会在这里抛出，包含错误码和错误描述，详见 EMError。

◆ saveMessage()

void com.hyphenate.chat.EMChatManager.saveMessage ( EMMessage message )

保存消息到内存和本地数据库。

命令消息（类型见：Type#CMD，消息体见：EMCmdMessageBody）不会在本地保存。

参数

message 待存储的消息。

◆ searchMsgFromDB() [1/2]

List< EMMessage > com.hyphenate.chat.EMChatManager.searchMsgFromDB	(	String	keywords,
		long	timeStamp,
		int	maxCount,
		String	from,
		EMConversation.EMSearchDirection	direction
	)

从本地数据库获取指定会话中包含特定关键字的消息。

参数

keywords	查询关键字。
timeStamp	查询的起始消息 Unix 时间戳，单位为毫秒。该参数设置后，SDK 从指定时间戳的消息开始，按消息搜索方向获取。如果该参数设置为负数，SDK 从当前时间开始搜索。
maxCount	每次获取的最大消息数。取值范围为 [1,400]。
from	查询来自指定用户或者群组的消息，一般为会话 ID。
direction	消息搜索方向。详见 EMConversation.EMSearchDirection。 `UP`：按照消息中的时间戳的逆序查询； `DOWN`：按照消息中的时间戳的正序查询。

返回: 消息列表（不包含查询起始时间戳对应的消息）。若未查找到任何消息，返回空列表。

◆ searchMsgFromDB() [2/2]

List< EMMessage > com.hyphenate.chat.EMChatManager.searchMsgFromDB	(	Type	type,
		long	timeStamp,
		int	maxCount,
		String	from,
		EMConversation.EMSearchDirection	direction
	)

从本地数据库获取指定会话的一定数量的特定类型的消息。

参数

type	消息类型。详见 Type。
timeStamp	查询的起始消息 Unix 时间戳，单位为毫秒。该参数设置后，SDK 从指定时间戳的消息开始，按消息搜索方向获取。如果该参数设置为负数，SDK 从当前时间开始搜索。
maxCount	每次获取的最大消息数。取值范围为 [1,400]。
from	搜索来自指定用户或者群组的消息，一般为会话 ID。
direction	消息搜索方向。详见 EMConversation.EMSearchDirection。 `UP`：按照消息中的时间戳的逆序查询； `DOWN`：按照消息中的时间戳的正序查询。

返回: 消息列表（不包含查询起始时间戳对应的消息）。若未查找到任何消息，返回空列表。

◆ sendMessage()

void com.hyphenate.chat.EMChatManager.sendMessage ( final EMMessage msg )

发送消息。

如果是语音，图片类等有附件的消息，SDK 会自动上传附件。

可以通过 EMOptions#setAutoTransferMessageAttachments(boolean) 设置是否上传到聊天服务器。

发送消息的状态，可以通过设置 EMMessage#setMessageStatusCallback(EMCallBack) 进行监听。

参数

msg	要发送的消息，必填。

◆ setConversationSubscribeMode()

void com.hyphenate.chat.EMChatManager.setConversationSubscribeMode	(	String	conversationId,
		SubscribeMode	mode
	)

设置会话订阅模式

参数

conversationId
mode

◆ setVoiceMessageListened()

void com.hyphenate.chat.EMChatManager.setVoiceMessageListened ( EMMessage message )

将语音消息设置为已听。

参数

message 要设置的消息对象。

◆ translateMessage()

void com.hyphenate.chat.EMChatManager.translateMessage	(	EMMessage	message,
		List< String >	languages,
		EMValueCallBack< EMMessage >	callBack
	)

翻译一条文本消息。

参数

message	要翻译的消息对象。
languages	目标语言代码列表。
callBack	结果回调，详见 EMCallBack。调用成功，触发 EMCallBack#onSuccess() 返回译文；调用失败，触发 EMCallBack#onError(int, String) 报错。

◆ updateMessage()

boolean com.hyphenate.chat.EMChatManager.updateMessage ( EMMessage message )

更新本地消息。

该方法会同时更新本地内存和数据库中的消息。

参数

message 要更新的消息对象。

◆ updateParticipant()

boolean com.hyphenate.chat.EMChatManager.updateParticipant	(	String	from,
		String	changeTo
	)

将数据库中指定联系人的相关信息变更成另外一个联系人。

注意

消息列表，会话列表，联系人列表和黑名单列表等相关信息会发生变化。
该方法不会更新内存中数据。

参数

from	原联系人的用户 ID。
changeTo	新联系人的用户 ID。

返回: 返回更新结果，任何列表更新失败，均会返回 false。

该类的文档由以下文件生成:

com/hyphenate/chat/EMChatManager.java

类

Public 成员函数

Protected 成员函数

详细描述

成员函数说明

◆ ackConversationRead()

◆ ackGroupMessageRead()

◆ ackMessageRead()

◆ addConversationListener()

◆ addMessageListener()

◆ addReaction()

◆ asyncAddReaction()

◆ asyncFetchConversationsFromServer()

◆ asyncFetchGroupReadAcks()

◆ asyncFetchHistoryMessage() [1/2]

◆ asyncFetchHistoryMessage() [2/2]

◆ asyncGetReactionDetail()

◆ asyncGetReactionList()

◆ asyncRecallMessage()

◆ asyncRemoveReaction()

◆ asyncReportMessage()

◆ deleteConversation()

◆ deleteConversationFromServer()

◆ deleteMessagesBeforeTimestamp()

◆ downloadAttachment()

◆ downloadThumbnail()

◆ fetchConversationsFromServer()

◆ fetchGroupReadAcks()

◆ fetchHistoryMessages() [1/2]

◆ fetchHistoryMessages() [2/2]

◆ fetchSupportLanguages()

◆ getAllConversations()

◆ getConversation() [1/5]

◆ getConversation() [2/5]

◆ getConversation() [3/5]

◆ getConversation() [4/5]

◆ getConversation() [5/5]

◆ getConversationsByType()

◆ getMessage()

◆ getReactionDetail()

◆ getReactionList()

◆ getUnreadMessageCount()

◆ importMessages()

◆ loadAllConversations()

◆ markAllConversationsAsRead()

◆ recallMessage()

◆ removeConversationListener()

◆ removeMessageListener()

◆ removeMessagesFromServer() [1/2]

◆ removeMessagesFromServer() [2/2]

◆ removeReaction()

◆ reportMessage()

◆ saveMessage()

◆ searchMsgFromDB() [1/2]

◆ searchMsgFromDB() [2/2]

◆ sendMessage()

◆ setConversationSubscribeMode()

◆ setVoiceMessageListened()

◆ translateMessage()

◆ updateMessage()

◆ updateParticipant()