即时通讯 IM API 参考 v1.3.2
Agora Java IM SDK
|
Public 成员函数 | |
void | onMessageReceived (List< ChatMessage > messages) |
default void | onCmdMessageReceived (List< ChatMessage > messages) |
default void | onMessageRead (List< ChatMessage > messages) |
default void | onGroupMessageRead (List< GroupReadAck > groupReadAcks) |
default void | onReadAckForGroupMessageUpdated () |
default void | onMessageDelivered (List< ChatMessage > messages) |
default void | onMessageRecalled (List< ChatMessage > messages) |
default void | onMessageRecalledWithExt (List< RecallMessageInfo > recallMessageInfo) |
default void | onMessageChanged (ChatMessage message, Object change) |
default void | onReactionChanged (List< MessageReactionChange > messageReactionChangeList) |
default void | onMessageContentChanged (ChatMessage messageModified, String operatorId, long operationTime) |
default void | onMessagePinChanged (String messageId, String conversationId, MessagePinInfo.PinOperation pinOperation, MessagePinInfo pinInfo) |
消息事件监听器。 用于监听消息接收情况,消息成功发送到对方手机后会有回执(需开启送达回执,详见 io.agora.chat.ChatOptions#setRequireDeliveryAck(boolean))。 对方阅读了这条消息也会收到回执(需开启允许已读回执,详见 io.agora.chat.ChatOptions#setRequireAck(boolean))。 发送消息过程中,消息 ID 会从最初本地生成的 uuid 变更为服务器端生成的全局唯一 ID,该 ID 在使用 SDK 的所有设备上均唯一。 应用需实现此接口监听消息变更状态。
添加消息监听: ```java ChatClient.getInstance().chatManager().addMessageListener(mMessageListener); ``` 移除消息监听: ```java ChatClient.getInstance().chatManager().removeMessageListener(mMessageListener); ```
default void io.agora.MessageListener.onCmdMessageReceived | ( | List< ChatMessage > | messages | ) |
收到命令消息。 与 onMessageReceived(List) 不同, 这个回调只包含命令的消息,命令消息通常不对用户展示。
default void io.agora.MessageListener.onGroupMessageRead | ( | List< GroupReadAck > | groupReadAcks | ) |
收到群组消息的已读回执。
default void io.agora.MessageListener.onMessageChanged | ( | ChatMessage | message, |
Object | change | ||
) |
收到消息变化,包括消息 ID 的变化。
message | 修改后的消息。 |
change | 消息的变化。 |
default void io.agora.MessageListener.onMessageContentChanged | ( | ChatMessage | messageModified, |
String | operatorId, | ||
long | operationTime | ||
) |
收到消息内容变化。
messageModified | 修改的消息对象,其中的 message body 包含消息修改次数、最后一次修改的操作者、最后一次修改时间等信息。 你也可通过 onMessageContentChanged 回调获得最后一次修改的操作者和最后一次修改时间等信息。 |
operatorId | 最后一次修改消息的用户。 |
operationTime | 消息的最后一次修改时间戳,单位为毫秒。 |
default void io.agora.MessageListener.onMessageDelivered | ( | List< ChatMessage > | messages | ) |
收到消息的送达回执。
default void io.agora.MessageListener.onMessagePinChanged | ( | String | messageId, |
String | conversationId, | ||
MessagePinInfo.PinOperation | pinOperation, | ||
MessagePinInfo | pinInfo | ||
) |
收到消息的置顶状态变化。
messageId | 消息 ID。 |
conversationId | 会话 ID。 |
pinOperation | 消息置顶操作的类型:包含置顶和取消置顶。详见 MessagePinInfo.PinOperation。 |
pinInfo | 消息置顶详情,包含置顶操作者的用户 ID 和置顶时间等。 |
default void io.agora.MessageListener.onMessageRead | ( | List< ChatMessage > | messages | ) |
收到消息的已读回执。
default void io.agora.MessageListener.onMessageRecalled | ( | List< ChatMessage > | messages | ) |
撤回收到的消息。
default void io.agora.MessageListener.onMessageRecalledWithExt | ( | List< RecallMessageInfo > | recallMessageInfo | ) |
撤回收到的消息。
支持使用 onMessageRecalledWithExt
,因为该回调接收在离线期间被撤回的消息。
recallMessageInfo | 被撤回消息的详情 注: 接收方离线期间被撤回消息 recallMessage 参数的值为 null。 |
void io.agora.MessageListener.onMessageReceived | ( | List< ChatMessage > | messages | ) |
收到消息。 在收到文本、图片、视频、语音、地理位置和文件等消息时,通过此回调通知用户。
default void io.agora.MessageListener.onReactionChanged | ( | List< MessageReactionChange > | messageReactionChangeList | ) |
收到 Reaction 变更消息。
default void io.agora.MessageListener.onReadAckForGroupMessageUpdated | ( | ) |
收到群组消息的读取状态更新。