hyphenate_SDK4.0 4.2.3-lite
hyphenate java IM SDK
|
Public 成员函数 | |
void | sendMessage (final EMMessage msg) |
void | ackConversationRead (String conversationId) throws HyphenateException |
void | ackMessageRead (String to, String messageId) 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) |
int | getUnreadMessageCount () |
void | saveMessage (EMMessage message) |
void | downloadAttachment (final EMMessage msg) |
void | downloadThumbnail (final EMMessage msg) |
List< EMConversation > | getConversationsByType (EMConversationType type) |
Map< String, EMConversation > | getAllConversations () |
void | asyncFetchPinnedConversationsFromServer (final int limit, final String cursor, final EMValueCallBack< EMCursorResult< EMConversation > > callback) |
void | asyncFetchConversationsFromServer (final int limit, final String cursor, final EMValueCallBack< EMCursorResult< EMConversation > > callback) |
void | asyncPinConversation (final String conversationId, boolean isPinned, final EMCallBack callback) |
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) |
void | asyncFetchHistoryMessages (String conversationId, EMConversationType type, int pageSize, String cursor, EMFetchMessageOption option, final EMValueCallBack< EMCursorResult< EMMessage > > callBack) |
Protected 成员函数 | |
void | removeMessagesFromServer (String conversationId, EMConversationType type, long beforeTimeStamp, EMCallBack callBack) |
聊天管理类,该类负责管理会话(加载,删除等)、发送消息、下载消息附件等。
发送文文本消息示例如下:
void com.hyphenate.chat.EMChatManager.ackConversationRead | ( | String | conversationId | ) | throws HyphenateException |
发送会话的已读回执,该方法只针对单聊会话。
该方法会通知服务器将此会话未读数设置为 0,消息发送方将会收到 EMConversationListener#onConversationRead(String, String) 回调。 在多端多设备登录下,接收方的其他设备也会收到该回调。
conversationId | 会话 ID。 |
HyphenateException | 可能抛出以下异常:EMError#USER_NOT_LOGIN、EMError#SERVER_NOT_REACHABLE、 EMError#MESSAGE_INVALID 等,详见 EMError。 |
void com.hyphenate.chat.EMChatManager.ackMessageRead | ( | String | to, |
String | messageId | ||
) | throws HyphenateException |
发送消息的已读回执。
该方法仅适用于单聊会话,仅在 EMOptions#setRequireAck(boolean) 为 true
时生效。
推荐进入聊天页面的时调用 ackConversationRead(String) ,其他情况下调用该方法以减少调用频率。
to | 接收方的用户 ID。 |
messageId | 消息的 ID。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
void com.hyphenate.chat.EMChatManager.addConversationListener | ( | EMConversationListener | listener | ) |
注册会话监听器。
会话监听器可监听会话变化及会话已读回执。
在不需要会话监听器时,可调用 removeConversationListener(EMConversationListener) 方法移除。
listener | 要添加的会话监听,详见 EMConversationListener。 |
void com.hyphenate.chat.EMChatManager.addMessageListener | ( | EMMessageListener | listener | ) |
注册消息监听器。
接收到新消息等回调可以通过设置此方法进行监听。
在不需要消息监听器时,可调用 removeMessageListener(EMMessageListener) 方法将其移除。
listener | 要注册的消息监听,详见 EMMessageListener。 |
void com.hyphenate.chat.EMChatManager.asyncFetchConversationsFromServer | ( | final int | limit, |
final String | cursor, | ||
final EMValueCallBack< EMCursorResult< EMConversation > > | callback | ||
) |
分页从服务器获取获取会话列表。
SDK 按照会话活跃时间(会话的最后一条消息的时间戳)倒序返回会话列表。
若会话中没有消息,则 SDK 按照会话创建时间的倒序返回会话列表。
limit | 每页期望返回的会话数量。取值范围为 [1,50]。 |
cursor | 开始获取数据的游标位置。若获取数据时传 null 或者空字符串(""),SDK 从最新活跃的会话开始获取。 |
callback | 分页获取结果 EMCursorResult,包含用于下次获取数据的 cursor 以及会话列表。 如果是最后一页,cursor 返回结果为空字符串。 |
void com.hyphenate.chat.EMChatManager.asyncFetchHistoryMessages | ( | String | conversationId, |
EMConversationType | type, | ||
int | pageSize, | ||
String | cursor, | ||
EMFetchMessageOption | option, | ||
final EMValueCallBack< EMCursorResult< EMMessage > > | callBack | ||
) |
/**
根据消息拉取参数配置类(EMFetchMessageOption
)从服务器分页获取指定会话的历史消息。
异步方法。
conversationId | 会话 ID。
|
type | 会话类型, 详见 EMConversationType。 |
pageSize | 每页期望获取的消息条数。取值范围为 [1,50]。 |
cursor | 查询的起始游标位置。 |
option | 查询历史消息的参数配置类,详见 EMFetchMessageOption。 |
callBack | 结果回调:
|
void com.hyphenate.chat.EMChatManager.asyncFetchPinnedConversationsFromServer | ( | final int | limit, |
final String | cursor, | ||
final EMValueCallBack< EMCursorResult< EMConversation > > | callback | ||
) |
分页从服务器获取置顶会话。
SDK 按照会话置顶时间倒序返回。
limit | 每页返回的会话数。取值范围为 [1,50]。 |
cursor | 开始获取数据的游标位置。若获取数据时传 null 或者空字符串(""),SDK 从最新置顶的会话开始查询。 |
callback | 分页获取结果 EMCursorResult,包含用于下次获取数据的 cursor 以及置顶的会话列表。 如果是最后一页,cursor 返回结果为空字符串。 |
void com.hyphenate.chat.EMChatManager.asyncPinConversation | ( | final String | conversationId, |
boolean | isPinned, | ||
final EMCallBack | callback | ||
) |
设置是否置顶会话。
conversationId | 会话 ID。 |
isPinned | 是否置顶会话:
|
false
: 取消置顶。 callback | 设置会话置顶状态的结果回调。 |
void com.hyphenate.chat.EMChatManager.asyncRecallMessage | ( | final EMMessage | message, |
final EMCallBack | callback | ||
) |
boolean com.hyphenate.chat.EMChatManager.deleteConversation | ( | String | username, |
boolean | deleteMessages | ||
) |
删除指定会话及其本地历史消息。
username | 会话 ID。 |
deleteMessages | 删除会话时是否同时删除本地的历史消息。
|
true
:是;false
: 否。 void com.hyphenate.chat.EMChatManager.deleteConversationFromServer | ( | String | username, |
EMConversationType | type, | ||
boolean | isDeleteServerMessages, | ||
EMCallBack | deleteCallBack | ||
) |
删除服务端的指定会话及其历史消息。
异步方法。
username | 会话 ID。 |
type | 会话类型,详见 EMConversationType。 |
isDeleteServerMessages | 删除会话时是否同时删除历史消息。
|
deleteCallBack | 删除服务端会话及其历史消息成功与否的回调。
|
void com.hyphenate.chat.EMChatManager.downloadAttachment | ( | final EMMessage | msg | ) |
下载消息的附件。
若附件自动下载失败,也可以调用此方法下载。
msg | 要下载附件的消息。 |
void com.hyphenate.chat.EMChatManager.downloadThumbnail | ( | final EMMessage | msg | ) |
下载消息的缩略图。
msg | 要下载缩略图的消息。只有图片消息和视频消息有缩略图。 |
Map< String, EMConversation > com.hyphenate.chat.EMChatManager.getAllConversations | ( | ) |
获取本地当前所有会话。
该方法会先从内存中获取,如果未找到任何会话,从本地数据库获取。
EMConversation com.hyphenate.chat.EMChatManager.getConversation | ( | String | id | ) |
获取指定 ID 的会话对象。
id | 会话 ID。 |
EMConversation com.hyphenate.chat.EMChatManager.getConversation | ( | String | id, |
EMConversationType | type | ||
) |
根据会话 ID 以及会话类型获取会话。
没有找到返回空值。
id | 会话 ID。
|
type | 会话类型,详见 EMConversationType。 |
EMConversation com.hyphenate.chat.EMChatManager.getConversation | ( | String | username, |
EMConversationType | type, | ||
boolean | createIfNotExists | ||
) |
根据会话 ID 和会话类型获取会话。
username | 会话 ID。
|
type | 会话类型,详见 EMConversationType。 |
createIfNotExists | 未找到指定会话时是否创建一个新会话。
|
EMConversation com.hyphenate.chat.EMChatManager.getConversation | ( | String | username, |
EMConversationType | type, | ||
boolean | createIfNotExists, | ||
boolean | isChatThread | ||
) |
根据会话 ID 以及会话类型获取会话。
username | 会话 ID。
|
type | 会话类型,详见 EMConversationType。 |
createIfNotExists | 未找到指定会话时是否创建一个新会话。
|
isChatThread | 是否查找子区会话。
|
List< EMConversation > com.hyphenate.chat.EMChatManager.getConversationsByType | ( | EMConversationType | type | ) |
EMMessage com.hyphenate.chat.EMChatManager.getMessage | ( | String | messageId | ) |
获取指定 ID 的消息对象。
messageId | 消息 ID。 |
int com.hyphenate.chat.EMChatManager.getUnreadMessageCount | ( | ) |
获取未读消息数。
void com.hyphenate.chat.EMChatManager.recallMessage | ( | EMMessage | message | ) | throws HyphenateException |
撤回发送成功的消息。
若消息发送和撤回时接收方为离线状态,接收方会收到消息撤回回调 EMMessageListener#onMessageRecalled,不会收到该消息。
同步方法,会阻塞当前线程。
message | 消息对象。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
void com.hyphenate.chat.EMChatManager.removeConversationListener | ( | EMConversationListener | listener | ) |
移除会话监听器。
调用 addConversationListener(EMConversationListener) 添加会话监听器后再调用本方法移除。
listener | 要移除的会话监听器,详见 EMConversationListener。 |
void com.hyphenate.chat.EMChatManager.removeMessageListener | ( | EMMessageListener | listener | ) |
移除消息监听器。
调用 addMessageListener(EMMessageListener) 添加消息监听后再调用本方法移除。
listener | 要移除的监听器,详见 EMMessageListener。 |
|
protected |
从本地数据库获取指定会话的一定数量的特定类型的消息。
type | 消息类型。详见 Type。 |
timeStamp | 查询的起始消息 Unix 时间戳,单位为毫秒。该参数设置后,SDK 从指定时间戳的消息开始,按消息搜索方向获取。 如果该参数设置为负数,SDK 从当前时间开始搜索。 |
maxCount | 每次获取的最大消息数。取值范围为 [1,400]。 |
from | 单聊或群聊中的消息发送方的用户 ID。若设置为 null 或空字符串,SDK 将在整个会话中搜索消息。 |
direction | 消息搜索方向。详见 EMConversation.EMSearchDirection。
|
从本地数据库获取指定会话中包含特定关键字的消息。
keywords | 查询关键字。 |
timeStamp | 查询的起始消息 Unix 时间戳,单位为毫秒。该参数设置后,SDK 从指定时间戳的消息开始,按消息搜索方向获取。 如果该参数设置为负数,SDK 从当前时间开始搜索。 |
maxCount | 每次获取的最大消息数。取值范围为 [1,400]。 |
from | 单聊或群聊中的消息发送方的用户 ID。若设置为 null 或空字符串,SDK 将在整个会话中搜索消息。 |
direction | 消息搜索方向。详见 EMConversation.EMSearchDirection。
|
删除指定时间戳之前的本地历史消息。
timeStamp | 查询的消息的起始 Unix 时间戳,单位为毫秒。 |
callback | 删除结果回调,详见 EMCallBack。 |
举报非法消息。
异步方法。
msgId | 要举报的消息 ID。 |
tag | 非法消息的标签。你需要填写自定义标签,例如涉政 或广告 。 |
reportReason | 举报原因。你需要自行填写举报原因。 |
callBack | 结果回调,详见 EMCallBack:
|
举报非法消息。
同步方法,会阻塞当前线程。
msgId | 要举报的消息 ID。 |
tag | 非法消息的标签。你需要填写自定义标签,例如涉政 或广告 。 |
reportReason | 举报原因。你需要自行填写举报原因。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 获取翻译服务支持的语言。 |
callBack | 结果回调,详见 EMCallBack。
|
翻译一条文本消息。
message | 要翻译的消息对象。 |
languages | 目标语言代码列表。 |
callBack | 结果回调,详见 EMCallBack。
|
添加 Reaction。
同步方法。
messageId | 消息 ID。 |
reaction | 要添加的消息 Reaction。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
添加 Reaction。
异步方法。
messageId | 消息 ID。 |
reaction | 要添加的消息 Reaction。 |
callback | 处理结果回调,失败会返回失败原因。详见 EMCallBack。 |
删除 Reaction。
同步方法。
messageId | 消息 ID。 |
reaction | 要删除的 Reaction。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
删除 Reaction。
异步方法。
messageId | 消息 ID。 |
reaction | 要删除的 Reaction。 |
callback | 处理结果回调,详见 EMCallBack。 |
获取 Reaction 列表。
同步方法。
messageIdList | 消息 ID。 |
chatType | 会话类型,仅支持单聊(EMMessage.ChatType#Chat)和群聊(EMMessage.ChatType#GroupChat)。 |
groupId | 群组 ID,该参数仅对群聊生效。 |
EMMessageReaction
的用户列表 UserList
为概要数据,只包含前三个用户信息)。获取 Reaction 列表。
异步方法。
messageIdList | 消息 ID。 |
chatType | 会话类型,仅支持单聊(EMMessage.ChatType#Chat )和群聊(EMMessage.ChatType#GroupChat)。 |
groupId | 群组 ID,该参数只对群聊生效。 |
callback | 处理结果回调,包含消息 ID 对应的 Reaction 列表(EMMessageReaction 的用户列表 UserList 为概要数据,只包含前三个用户信息)。 |
获取 Reaction 详细信息。
同步方法。
messageId | 消息 ID。 |
reaction | 消息 Reaction 内容。 |
cursor | 查询的起始游标位置。 |
pageSize | 每页期望获取的 Reaction 数。 |
cursor
为空表示数据已全部获取。获取 Reaction 详细信息。
异步方法。
messageId | 消息 ID。 |
reaction | 消息 Reaction。 |
cursor | 查询的起始游标位置。 |
pageSize | 每页期望获取的 Reaction 数。 |
callback | 处理结果回调,包含 cursor 和 EMMessageReaction 列表(仅使用该列表第一个数据即可)。 |
根据消息 ID 单向删除漫游消息。
conversationId | 会话 ID。 |
type | 会话类型。 |
msgIdList | 要删除的消息 ID 列表。 |
callBack | 处理结果回调,详见 EMCallBack。 |
根据时间戳单向删除漫游消息。
conversationId | 会话 ID。 |
type | 会话类型。 |
beforeTimeStamp | UNIX 时间戳,单位为毫秒。若消息的 UNIX 时间戳小于设置的值,则会被删除。 |
callBack | 处理结果回调,详见 EMCallBack。 |
void com.hyphenate.chat.EMChatManager.saveMessage | ( | EMMessage | message | ) |
void com.hyphenate.chat.EMChatManager.sendMessage | ( | final EMMessage | msg | ) |
发送消息。
如果是语音,图片类等有附件的消息,SDK 会自动上传附件。
可以通过 EMOptions#setAutoTransferMessageAttachments(boolean) 设置是否上传到聊天服务器。
发送消息的状态,可以通过设置 EMMessage#setMessageStatusCallback(EMCallBack) 进行监听。
msg | 要发送的消息,必填。 |
void com.hyphenate.chat.EMChatManager.setVoiceMessageListened | ( | EMMessage | message | ) |
将语音消息设置为已听。
message | 要设置的消息对象。 |