Interface

2026-01-21


ZIMAllRoomLeftCallback	ZIMBlacklistCheckedCallback
ZIMBlacklistQueriedCallback	ZIMBlacklistUsersAddedCallback
ZIMBlacklistUsersRemovedCallback	ZIMCallAcceptanceSentCallback
ZIMCallCancelSentCallback	ZIMCallEndSentCallback
ZIMCallingInvitationSentCallback	ZIMCallInvitationListQueriedCallback
ZIMCallInvitationSentCallback	ZIMCallJoinSentCallback
ZIMCallQuitSentCallback	ZIMCallRejectionSentCallback
ZIMCombineMessageDetailQueriedCallback	ZIMConversationDeletedCallback
ZIMConversationDraftSetCallback	ZIMConversationListQueriedCallback
ZIMConversationMarkSetCallback	ZIMConversationMessageReceiptReadSentCallback
ZIMConversationMessagesAllDeletedCallback	ZIMConversationNotificationStatusSetCallback
ZIMConversationPinnedListQueriedCallback	ZIMConversationPinnedStateUpdatedCallback
ZIMConversationQueriedCallback	ZIMConversationsAllDeletedCallback
ZIMConversationsSearchedCallback	ZIMConversationTotalUnreadMessageCountClearedCallback
ZIMConversationTotalUnreadMessageCountQueriedCallback	ZIMConversationUnreadMessageCountClearedCallback
ZIMDefines	ZIMFileCacheClearedCallback
ZIMFileCacheQueriedCallback	ZIMFriendAddedCallback
ZIMFriendAliasUpdatedCallback	ZIMFriendApplicationAcceptedCallback
ZIMFriendApplicationListQueriedCallback	ZIMFriendApplicationRejectedCallback
ZIMFriendApplicationSentCallback	ZIMFriendAttributesUpdatedCallback
ZIMFriendListQueriedCallback	ZIMFriendsDeletedCallback
ZIMFriendsInfoQueriedCallback	ZIMFriendsRelationCheckedCallback
ZIMFriendsSearchedCallback	ZIMGroupAliasUpdatedCallback
ZIMGroupApplicationListQueriedCallback	ZIMGroupAttributesOperatedCallback
ZIMGroupAttributesQueriedCallback	ZIMGroupAvatarUrlUpdatedCallback
ZIMGroupBeInviteModeUpdatedCallback	ZIMGroupCreatedCallback
ZIMGroupDismissedCallback	ZIMGroupInfoQueriedCallback
ZIMGroupInviteApplicationAcceptedCallback	ZIMGroupInviteApplicationRejectedCallback
ZIMGroupInviteApplicationsSentCallback	ZIMGroupInviteModeUpdatedCallback
ZIMGroupJoinApplicationAcceptedCallback	ZIMGroupJoinApplicationRejectedCallback
ZIMGroupJoinApplicationSentCallback	ZIMGroupJoinedCallback
ZIMGroupJoinModeUpdatedCallback	ZIMGroupLeftCallback
ZIMGroupListQueriedCallback	ZIMGroupMemberCountQueriedCallback
ZIMGroupMemberInfoQueriedCallback	ZIMGroupMemberKickedoutCallback
ZIMGroupMemberListQueriedCallback	ZIMGroupMemberMutedListQueriedCallback
ZIMGroupMemberNicknameUpdatedCallback	ZIMGroupMemberRoleUpdatedCallback
ZIMGroupMembersMutedCallback	ZIMGroupMembersSearchedCallback
ZIMGroupMessageReceiptMemberListQueriedCallback	ZIMGroupMutedCallback
ZIMGroupNameUpdatedCallback	ZIMGroupNoticeUpdatedCallback
ZIMGroupOwnerTransferredCallback	ZIMGroupsSearchedCallback
ZIMGroupUsersInvitedCallback	ZIMLoggedInCallback
ZIMLogUploadedCallback	ZIMMediaDownloadedCallback
ZIMMediaMessageSentCallback	ZIMMessageDeletedCallback
ZIMMessageExportedCallback	ZIMMessageExportingProgress
ZIMMessageImportedCallback	ZIMMessageImportingProgress
ZIMMessageInsertedCallback	ZIMMessageLocalExtendedDataUpdatedCallback
ZIMMessagePinnedCallback	ZIMMessageQueriedCallback
ZIMMessageReactionAddedCallback	ZIMMessageReactionDeletedCallback
ZIMMessageReactionUserListQueriedCallback	ZIMMessageReceiptsInfoQueriedCallback
ZIMMessageReceiptsReadSentCallback	ZIMMessageRepliedListQueriedCallback
ZIMMessageRevokedCallback	ZIMMessageSentCallback
ZIMMessageSentFullCallback	ZIMMessagesGlobalSearchedCallback
ZIMMessagesSearchedCallback	ZIMRoomAttributesBatchOperatedCallback
ZIMRoomAttributesOperatedCallback	ZIMRoomAttributesQueriedCallback
ZIMRoomCreatedCallback	ZIMRoomEnteredCallback
ZIMRoomJoinedCallback	ZIMRoomLeftCallback
ZIMRoomMemberAttributesListQueriedCallback	ZIMRoomMemberQueriedCallback
ZIMRoomMembersAttributesQueriedCallback	ZIMRoomMembersQueriedCallback
ZIMRoomOnlineMemberCountQueriedCallback	ZIMRoomSwitchedCallback
ZIMSelfUserInfoQueriedCallback	ZIMSendingMessageCancelledCallback
ZIMSubscribedUserStatusListQueriedCallback	ZIMTokenRenewedCallback
ZIMUserAvatarUrlUpdatedCallback	ZIMUserExtendedDataUpdatedCallback
ZIMUserNameUpdatedCallback	ZIMUserOfflinePushRuleUpdatedCallback
ZIMUsersInfoQueriedCallback	ZIMUsersStatusQueriedCallback
ZIMUsersStatusSubscribedCallback	ZIMUsersStatusUnsubscribedCallback

ZIMAllRoomLeftCallback

方法

onRoomAllLeft

public onRoomAllLeft

离开所有房间的结果的回调。

参数

名称	类型	描述
roomIDs	ArrayList<String>	房间 ID 列表。

通知时机：当用户调用 [leaveAllRoom]，则会触发该回调返回结果。

支持版本：1.15 及以上。

ZIMBlacklistCheckedCallback

方法

onBlacklistChecked

public onBlacklistChecked

黑名单检查结果回调。

参数

名称	类型	描述
isUserInBlacklist	boolean	该用户是否在黑名单
errorInfo	ZIMError	黑名单检查返回的错误码。0 代表检查成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

黑名单检查结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否检查成功。
通知时机：当开发者调用 [checkUserIsInBlacklist] 接口时，会触发该回调。
相关接口：通过 [checkUserIsInBlacklist] 检查用户是否在黑名单。

支持版本：2.13.0 及以上。

ZIMBlacklistQueriedCallback

方法

onBlacklistQueried

public onBlacklistQueried

查询黑名单结果回调。

参数

名称	类型	描述
blacklist	list<ZIMUserInfo>	SDK 本地存储的黑名单数据。
nextFlag	int	详情描述：下一个标志。为 0 表示黑名单查询完毕。不为 0 时表示黑名单查询未完成，再次调用查询接口，传入此 nextFlag 即可继续查询。
errorInfo	ZIMError	查询的错误码。0 代表成功，非 0 为失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询黑名单结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否查询成功。
通知时机：当开发者调用 [queryBlacklist] 接口时，会触发该回调。
相关接口：通过 [queryBlacklist] 查询黑名单列表。

支持版本：2.13.0 及以上。

ZIMBlacklistUsersAddedCallback

方法

onBlacklistUsersAdded

public onBlacklistUsersAdded

添加用户到黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	list<ZIMErrorUserInfo>	拉黑失败的 userInfo 列表。
errorInfo	ZIMError	添加用户到黑名单返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

添加用户到黑名单的操作结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否添加到黑名单成功。
通知时机：当开发者调用 [addUsersToBlacklist] 接口时，会触发该回调。
相关接口：通过 [addUsersToBlacklist] 添加黑名单。

支持版本：2.13.0 及以上。

ZIMBlacklistUsersRemovedCallback

方法

onBlacklistUsersRemoved

public onBlacklistUsersRemoved

移除用户出黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	list<ZIMErrorUserInfo>	移除失败的 userInfo 列表。
errorInfo	ZIMError	黑名单删除的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

移除用户出黑名单的操作结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否添加到黑名单成功。
通知时机：当开发者调用 [removeUsersFromBlacklist] 接口时，会触发该回调。
相关接口：通过 [removeUsersFromBlacklist] 将用户移除出黑名单。

支持版本：2.13.0 及以上。

ZIMCallAcceptanceSentCallback

方法

onCallAcceptanceSent

public onCallAcceptanceSent

接受呼叫邀请的操作回调。

参数

名称	类型	描述
callID	String	呼叫邀请唯一ID
errorInfo	ZIMError	接受呼叫邀请的错误码。0 代表接受呼叫邀请成功，非 0 为接受呼叫邀请失败。若出现接受呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

接受呼叫邀请的操作回调。

业务场景：进行接受呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：接受呼叫邀请操作结束后的结果返回。
相关接口：[callAccept]，接受呼叫邀请。

支持版本：2.0.0。

ZIMCallCancelSentCallback

方法

onCallCancelSent

public onCallCancelSent

取消呼叫邀请的操作回调。

参数

名称	类型	描述
callID	String	呼叫邀请唯一 ID
errorInvitees	ArrayList<String>	取消呼叫邀请失败的用户。
errorInfo	ZIMError	取消呼叫邀请的错误码。0 代表取消呼叫邀请成功，非 0 为取消呼叫邀请失败。若出现取消呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

取消呼叫邀请的操作回调。

业务场景：进行取消呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：取消呼叫邀请操作结束后的结果返回。
相关接口：[callCancel]，取消呼叫邀请。

支持版本：2.0.0。

ZIMCallEndSentCallback

方法

ZIMCallEndSentCallback

public ZIMCallEndSentCallback

结束呼叫的结果回调。

参数

名称	类型	描述
callID	String	呼叫的 callID。
info	ZIMCallInvitationEndedInfo	结束呼叫返回的信息。
errorInfo	ZIMError	结束呼叫返回的错误信息。

详情

结束呼叫的结果回调。

ZIMCallInvitationListQueriedCallback

方法

ZIMCallInvitationListQueriedCallback

public ZIMCallInvitationListQueriedCallback

查询呼叫列表的结果回调。

参数

名称	类型	描述
callList	ArrayList<ZIMCallInfo>	查询返回的呼叫信息列表
nextFlag	long	分页查询返回的锚点，下次查询时传入可在上次查询的基础上继续查询。
errorInfo	ZIMError	查询返回的错误信息。

详情

查询呼叫列表的结果回调。

ZIMCallInvitationSentCallback

方法

onCallInvitationSent

public onCallInvitationSent

发送呼叫邀请的操作回调。

参数

名称	类型	描述
callID	String	已创建的呼叫邀请ID。
info	ZIMCallInvitationSentInfo	发送呼叫邀请信息。
errorInfo	ZIMError	发送呼叫邀请的错误码。0 代表发送呼叫邀请成功，非 0 为发送呼叫邀请失败。若出现发送呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

发送呼叫邀请的操作回调。

业务场景：进行发送呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：发送呼叫邀请操作结束后的结果返回。
相关接口：[callInvite]，发送呼叫邀请。

支持版本：2.0.0。

ZIMCallJoinSentCallback

方法

ZIMCallJoinSentCallback

public ZIMCallJoinSentCallback

加入呼叫的结果回调。

名称	类型	描述
callID	String	呼叫的 callID。
info	ZIMCallJoinSentInfo	加入呼叫返回的信息。
errorInfo	ZIMError	加入呼叫返回的错误信息。

ZIMCallQuitSentCallback

方法

ZIMCallQuitSentCallback

public ZIMCallQuitSentCallback

退出呼叫操作的回调闭包。

参数

名称	类型	描述
callID	String	退出的 callID。
info	ZIMCallQuitSentInfo	退出的信息。
errorInfo	ZIMError	错误信息。

详情

退出呼叫操作的回调闭包。

ZIMCallRejectionSentCallback

方法

onCallRejectionSent

public onCallRejectionSent

拒绝呼叫邀请的操作回调。

参数

名称	类型	描述
callID	String	呼叫邀请唯一ID
errorInfo	ZIMError	拒绝呼叫邀请的错误码。0 代表拒绝呼叫邀请成功，非 0 为拒绝呼叫邀请失败。若出现拒绝呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

拒绝呼叫邀请的操作回调。

业务场景：进行拒绝呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：拒绝呼叫邀请操作结束后的结果返回。
相关接口：[callReject]，拒绝呼叫邀请。

支持版本：2.0.0。

ZIMCallingInvitationSentCallback

方法

ZIMCallingInvitationSentCallback

public ZIMCallingInvitationSentCallback

邀请加入当前呼叫的结果回调。

参数

名称	类型	描述
callID	String	当前呼叫邀请的 callID。
info	ZIMCallingInvitationSentInfo	呼叫中邀请已发送信息。
errorInfo	ZIMError	错误信息，详情请参考常见错误码文档。

详情

邀请加入当前呼叫的结果回调。

ZIMCombineMessageDetailQueriedCallback

方法

ZIMCombineMessageDetailQueriedCallback

public ZIMCombineMessageDetailQueriedCallback

查询合并消息详情的结果回调。

参数

名称	类型	描述
message	ZIMCombineMessage	携带完整合并转发消息列表的合并消息。
errorInfo	ZIMError	错误信息，包含错误码和错误详细信息。

详情

查询合并消息详情的结果回调。

ZIMConversationDeletedCallback

方法

onConversationDeleted

public onConversationDeleted

会话删除的回调。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	删除回话的错误码。0 代表删除回话成功，非 0为删除回话失败。若出现删除回话失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除会话后通过该回调返回删除结果。

业务场景：可在该回调内做会话删除后的逻辑。
通知时机：删除会话后触发。
相关接口：[deleteConversation]。

支持版本：2.0.0 及以上。

ZIMConversationDraftSetCallback

方法

onConversationDraftSet

public onConversationDraftSet

设置会话草稿的回调。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置会话草稿的错误码。0 代表设置会话草稿成功，非 0为设置会话草稿失败。若出现设置会话草稿失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置会话草稿后，通过该回调返回操作结果。

业务场景：可在该回调内做设置会话草稿后的逻辑。
通知时机：设置会话草稿后触发。
相关接口：[setConversationDraft]。

支持版本：2.14.0 及以上。

ZIMConversationListQueriedCallback

方法

ZIMConversationListQueriedCallback

public ZIMConversationListQueriedCallback

会话列表查询回调。

参数

名称	类型	描述
conversationList	ArrayList<ZIMConversation>	会话列表。
errorInfo	ZIMError	查询回话列表的错误码。0 代表查询回话列表成功，非 0 为查询回话列表失败。若出现查询回话列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询会话列表后通过该回调返回查询结果。

业务场景：可在该回调内做会话列表查询后的逻辑。
通知时机：查询会话列表后触发。
相关接口：[queryConversationList]

支持版本：2.0.0 及以上。

ZIMConversationMarkSetCallback

方法

onConversationMarkSet

public onConversationMarkSet

会话标记设置的回调。

参数

名称	类型	描述
failedConversationInfos	ArrayList<ZIMConversationBaseInfo>	设置失败的会话简要信息。
errorInfo	ZIMError	会话标记操作的错误码。0 代表会话标记操作成功，非 0 为会话标记操作失败。若出现会话标记操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置会话标记的结果。

通知时机：设置会话标记后触发。
相关接口：[setConversationMark]。

支持版本：2.17.0 及以上。

ZIMConversationMessageReceiptReadSentCallback

方法

onConversationMessageReceiptReadSent

public onConversationMessageReceiptReadSent

设置回执会话已读的回调接口。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置回执会话已读的错误码。0 代表设置成功，非 0为设置失败。若出现设置失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置回执会话已读的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
通知时机：当开发者调用 [sendConversationMessageReceiptRead] 接口时，会触发该回调。
相关接口：通过 [sendConversationMessageReceiptRead] 设置回执的会话已读的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMConversationMessagesAllDeletedCallback

方法

onConversationMessagesAllDeleted

public onConversationMessagesAllDeleted

删除全部会话的全部消息的回调。

参数

名称	类型	描述
errorInfo	ZIMError	删除消息的错误码。0 代表删除消息成功，非 0为删除消息失败。若出现删除消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除全部会话的全部消息后通过该回调返回消息删除的结果。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
通知时机：调用删除消息接口 [deleteAllConversationMessages] 后触发。
相关接口：[deleteAllConversationMessages]。

支持版本：2.14.0 及以上。

ZIMConversationNotificationStatusSetCallback

方法

onConversationNotificationStatusSet

public onConversationNotificationStatusSet

会话通知状态设置的回调。

参数

名称	类型	描述
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置回话通知状态的错误码。0 代表设置回话通知状态成功，非 0为设置回话通知状态失败。若出现设置回话通知状态失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置群通知状态后通过该回调返回群通知的结果。

业务场景：可在该回调内做设置群通知状态后的逻辑。
通知时机：设置群通知状态后触发。
相关接口：[setConversationNotificationStatus]。

支持版本：2.0.0 及以上。

ZIMConversationPinnedListQueriedCallback

方法

ZIMConversationPinnedListQueriedCallback

public ZIMConversationPinnedListQueriedCallback

置顶会话列表查询回调。

参数

名称	类型	描述
conversationList	ArrayList<ZIMConversation>	置顶会话列表。
errorInfo	ZIMError	查询置顶会话列表的错误信息。0 代表查询置顶会话列表成功，非 0 为查询置顶会话列表失败。若出现查询置顶会话列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询置顶会话列表后通过该回调返回查询结果。

业务场景：可在该回调内做置顶会话列表查询后的逻辑。
通知时机：查询置顶会话列表后触发。

支持版本：2.8.0 及以上。

ZIMConversationPinnedStateUpdatedCallback

方法

ZIMConversationPinnedStateUpdatedCallback

public ZIMConversationPinnedStateUpdatedCallback

会话置顶状态变更回调。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	更新会话置顶状态的错误码。0 代表更新会话置顶状态成功，非 0为更新会话置顶状态失败。若出现更新会话置顶状态失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新会话置顶状态后通过该回调返回结果。

业务场景：可在该回调内做更新会话置顶状态后的逻辑。
通知时机：调用 [updateConversationPinnedState] 接口更新会话置顶状态后触发。

支持版本：2.8.0 及以上。

ZIMConversationQueriedCallback

方法

ZIMConversationQueriedCallback

public ZIMConversationQueriedCallback

会话查询回调。

参数

名称	类型	描述
conversation	ZIMConversation	会话对象。
errorInfo	ZIMError	查询会话的错误码。0 代表查询会话成功，非 0 为查询会话失败。若出现查询会话失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询会话后通过该回调返回查询结果。

业务场景：可在该回调内做会话查询后的逻辑。
通知时机：调用 [queryConversation] 接口查询会话后触发。

支持版本：2.8.0 及以上。

ZIMConversationTotalUnreadMessageCountClearedCallback

方法

onConversationTotalUnreadMessageCountCleared

public onConversationTotalUnreadMessageCountCleared

全部会话未读数清除的回调。

参数

名称	类型	描述
errorInfo	ZIMError	清除全部会话未读数数量的错误码。0 代表清除全部会话未读数数量成功，非 0为清除全部会话未读数数量失败。若出现清除全部会话未读数数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

清除全部会话未读数后通过该回调返回清除会话的结果。

业务场景：可在该回调内做清除全部未读数后的逻辑。
通知时机：清除全部会话未读数后触发。
相关接口：[clearConversationTotalUnreadMessageCount]

支持版本：2.12.0 及以上。

ZIMConversationTotalUnreadMessageCountQueriedCallback

方法

onConversationTotalUnreadMessageCountQueried

public onConversationTotalUnreadMessageCountQueried

查询会话未读消息总数的回调。

参数

名称	类型	描述
unreadMessageCount	int	会话未读消息总数。
errorInfo	ZIMError	查询操作的错误码。

通知时机：查询会话未读消息总数触发。

支持版本：2.17.0 及以上。

ZIMConversationUnreadMessageCountClearedCallback

方法

onConversationUnreadMessageCountCleared

public onConversationUnreadMessageCountCleared

会话未读数清除的回调。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	清除回话未读数数量的错误码。0 代表清除回话未读数数量成功，非 0为清除回话未读数数量失败。若出现清除回话未读数数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

清除会话未读数后通过该回调返回清除会话的结果。

业务场景：可在该回调内做清除未读数后的逻辑。
通知时机：清除会话未读数后触发。
相关接口：[clearConversationUnreadMessageCount]

支持版本：2.0.0 及以上。

ZIMConversationsAllDeletedCallback

方法

onConversationsAllDeleted

public onConversationsAllDeleted

全部会话删除的回调。

参数

名称	类型	描述
errorInfo	ZIMError	删除全部会话的错误码。0 代表删除全部会话成功，非 0为删除全部会话失败。若出现删除全部会话失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除全部会话后通过该回调返回删除结果。

业务场景：可在该回调内做全部会话删除后的逻辑。
通知时机：删除全部会话后触发。
相关接口：[deleteAllConversations]。

支持版本：2.12.0 及以上。

ZIMConversationsSearchedCallback

方法

onConversationsSearched

public onConversationsSearched

基于本地消息搜索本地会话结果的返回。

参数

名称	类型	描述
conversationSearchInfoList	ArrayList<ZIMConversationSearchInfo>	搜索到的会话消息列表。
nextFlag	int	分页拉取标志，搜索下一页的锚点。
errorInfo	ZIMError	搜索结果的错误码。0 代表搜索成功，非 0 为搜索失败。若出现搜索失败时，开发者应查看官网错误码文档查询解决方案。

详情

基于本地消息搜索本地会话结果的返回。

业务场景：进行本地会话消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalConversations]，基于本地消息搜索本地会话。

ZIMDefines

方法

ZIMUserCustomStatusUpdatedCallback

public ZIMUserCustomStatusUpdatedCallback

更新自定义状态的回调。

参数

名称	类型	描述
errorInfo	ZIMError	更新自定义状态的错误信息。
customStatus	String	自定义状态。

详情

更新自定义状态的回调。

ZIMFileCacheClearedCallback

方法

onFileCacheCleared

public onFileCacheCleared

清除本地缓存结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	清理缓存的错误码。0 代表清理缓存成功，非 0 为清理缓存失败。

详情

清除本地缓存结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否清理成功。
通知时机：当开发者调用 [clearLocalFileCache] 接口时，会触发该回调。
相关接口：通过 [clearLocalFileCache] 插入本地消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMFileCacheQueriedCallback

方法

onFileCacheQueried

public onFileCacheQueried

查询本地缓存的结果的回调。

参数

名称	类型	描述
fileCacheInfo	ZIMFileCacheInfo	缓存信息。
errorInfo	ZIMError	查询缓存的错误码。0 代表查询缓存成功，非 0 为查询缓存失败。

详情

查询本地缓存的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否查询成功。
通知时机：当开发者调用 [queryLocalFileCache] 接口时，会触发该回调。
相关接口：通过 [queryLocalFileCache]查询本地缓存，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMFriendAddedCallback

方法

onFriendAddedCallback

public onFriendAddedCallback

添加好友结果回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError	添加好友返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

添加好友的结果的返回。

业务场景：进行确添加好友操作后，成功与否可以通过该回调得知。
相关接口：[addFriend]，添加好友。

支持版本：2.13.0 及以上。

ZIMFriendAliasUpdatedCallback

方法

onFriendAliasUpdated

public onFriendAliasUpdated

更新好友备注的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError	更新好友备注的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新好友备注的返回结果。

业务场景：进行更新好友备注操作后，成功与否可以通过该回调得知。
相关接口：[updateFriendAlias]，更新好友备注。

ZIMFriendApplicationAcceptedCallback

方法

onFriendApplicationAccepted

public onFriendApplicationAccepted

接受好友申请的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError	同意好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

接受好友申请的返回结果。

业务场景：进行接受好友申请操作后，成功与否可以通过该回调得知。
相关接口：[acceptFriendApplication]，接受好友申请。

ZIMFriendApplicationListQueriedCallback

方法

onFriendApplicationListQueried

public onFriendApplicationListQueried

发起好友申请的返回结果。

参数

名称	类型	描述
applicationList	ArrayList<ZIMFriendApplicationInfo>	好友申请信息列表。
nextFlag	int	当前查询锚点下标。
errorInfo	ZIMError	查询好友申请列表错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
相关接口：[sendFriendApplication]，发起好友申请。

支持版本：2.14.0 及以上。

ZIMFriendApplicationRejectedCallback

方法

onFriendApplicationRejected

public onFriendApplicationRejected

拒绝好友申请的返回结果。

参数

名称	类型	描述
userInfo	ZIMUserInfo	申请人用户信息。
errorInfo	ZIMError	同意好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

拒绝好友申请的返回结果。

业务场景：进行拒绝好友申请操作后，成功与否可以通过该回调得知。
相关接口：[rejectFriendApplication]，拒绝好友申请。

ZIMFriendApplicationSentCallback

方法

onFriendApplicationSentCallback

public onFriendApplicationSentCallback

发起好友申请的返回结果。

参数

名称	类型	描述
applicationInfo	ZIMFriendApplicationInfo	好友申请信息。
errorInfo	ZIMError	发起好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
相关接口：[sendFriendApplication]，发起好友申请。

支持版本：2.14.0 及以上。

ZIMFriendAttributesUpdatedCallback

方法

onFriendAttributesUpdated

public onFriendAttributesUpdated

更新好友属性的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError	更新好友属性错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新好友属性的返回结果。

业务场景：进行更新好友属性操作后，成功与否可以通过该回调得知。
相关接口：[updateFriendAttributes]，更新好友属性。

ZIMFriendListQueriedCallback

方法

onFriendListQueried

public onFriendListQueried

查询好友列表的返回结果。

参数

名称	类型	描述
friendList	ArrayList<ZIMFriendInfo>	查询好友列表的返回结果。
nextFlag	int	当前查询锚点下标。
errorInfo	ZIMError	查询好友列表返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询好友列表的返回结果。

业务场景：进行查询好友列表操作后，成功与否可以通过该回调得知。
相关接口：[queryFriendList]，查询好友列表。

ZIMFriendsDeletedCallback

方法

onFriendsDeletedCallback

public onFriendsDeletedCallback

删除好友的返回结果。

参数

名称	类型	描述
errorUserList	list<ZIMErrorUserInfo>	删除失败的用户id及原因列表。
errorInfo	ZIMError	添加用户到黑名单返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除好友的返回结果。

业务场景：进行删除好友操作后，成功与否可以通过该回调得知。
相关接口：[deleteFriends]，批量删除好友。

支持版本：2.14.0 及以上。

ZIMFriendsInfoQueriedCallback

方法

onFriendsInfoQueried

public onFriendsInfoQueried

批量查询好友信息的返回结果。

参数

名称	类型	描述
friendInfos	ArrayList<ZIMFriendInfo>	好友信息。
errorUserList	ArrayList<ZIMErrorUserInfo>	查询失败的用户id及原因。
errorInfo	ZIMError	发起好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

批量查询好友信息的返回结果。

业务场景：进行批量查询好友信息操作后，成功与否可以通过该回调得知。
相关接口：[queryFriendsInfo]，批量查询好友信息。

ZIMFriendsRelationCheckedCallback

方法

onFriendsChecked

public onFriendsChecked

检查好友关系的返回结果。

参数

名称	类型	描述
errorUserList	ArrayList<ZIMErrorUserInfo>	检查好友关系失败的用户id及原因列表。
relationInfos	ArrayList<ZIMFriendRelationInfo>	好友关系信息列表。
errorInfo	ZIMError	查询的错误码。0 代表成功，非 0 为失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行检查好友关系操作后，成功与否可以通过该回调得知。
相关接口：[checkFriendsRelation]，检查好友关系。

支持版本：2.14.0 及以上。

ZIMFriendsSearchedCallback

方法

onFriendsSearched

public onFriendsSearched

搜索本地好友的返回结果。

参数

名称	类型	描述
friendInfos	ArrayList<ZIMFriendInfo>	好友信息列表。
nextFlag	int	当前查询锚点下标。
errorInfo	ZIMError	查询好友列表返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索本地好友的返回结果。

业务场景：进行本地好友搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalFriends]，搜索本地好友。

ZIMGroupAliasUpdatedCallback

方法

onGroupAliasUpdated

public onGroupAliasUpdated

群备注更新的结果回调。

参数

名称	类型	描述
groupID	String	群组 ID。
groupAlias	String	群备注。
errorInfo	ZIMError	更新群备注的错误码。0 代表更新成功，非 0为更新失败。若出现更新失败时，请查看官网错误码文档查询解决方案。

详情

群备注更新操作结果的返回。

业务场景：进行群备注更新操作后，成功与否可以通过该回调得知。
通知时机：群备注更新操作结束后的结果返回。
相关接口：[updateGroupAlias]，更新群备注。

ZIMGroupApplicationListQueriedCallback

方法

onGroupApplicationListQueried

public onGroupApplicationListQueried

查询入群申请列表的回调。

参数

名称	类型	描述
applicationList	ArrayList<ZIMGroupApplicationInfo>	入群申请列表。
nextFlag	int	下一个标志。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

入群申请列表查询结果的返回。

业务场景：进行入群申请列表查询后，成功与否可以通过该回调得知。
相关接口：[queryGroupApplicationList]，查询入群申请列表。

ZIMGroupAttributesOperatedCallback

方法

onGroupAttributesOperated

public onGroupAttributesOperated

群属性操作结果的返回。

参数

名称	类型	描述
groupID	String	群组ID。
errorKeys	ArrayList<String>	错误的键。
errorInfo	ZIMError	设置群组属性的错误码。0 代表设置群组属性成功，非 0 为设置群组属性失败。若出现设置群组属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

群属性操作结果的返回。

业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
通知时机：群属性操作结束后的结果返回。
相关接口：[setGroupAttributes]，设置房间属性。[deleteGroupAttributes]，删除房间属性。

ZIMGroupAttributesQueriedCallback

方法

onGroupAttributesQueried

public onGroupAttributesQueried

查询群属性结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
groupAttributes	HashMap<String, String>	群属性。
errorInfo	ZIMError	查询群组属性的错误码。0 代表查询群组属性成功，非 0 为查询群组属性失败。若出现查询群组属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

群属性查询结果的返回。

业务场景：进行自定义属性查询后，成功与否可以通过该回调得知。
通知时机：群属性查询后的结果返回。
相关接口：[queryGroupAttributes]，查询房间属性。

ZIMGroupAvatarUrlUpdatedCallback

方法

ZIMGroupAvatarUrlUpdatedCallback

public ZIMGroupAvatarUrlUpdatedCallback

群头像 URL 更新的结果的返回。

参数

名称	类型	描述
groupID	String	群组ID。
groupAvatarUrl	String	群头像 URL。
errorInfo	ZIMError	更新群头像 URL 的错误码。0 代表更新成功，非 0为更新群名称失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

群头像 URL 更新操作结果的返回。

业务场景：进行群头像 URL 更新操作后，成功与否可以通过该回调得知。
通知时机：群头像 URL 更新操作结束后的结果返回。
相关接口：[updateGroupAvatarUrl]。

ZIMGroupBeInviteModeUpdatedCallback

方法

onGroupBeInviteModeUpdated

public onGroupBeInviteModeUpdated

被邀请入群验证模式更新的回调。

参数

名称	类型	描述
groupID	String	群组ID。
mode	ZIMGroupBeInviteMode	被邀请入群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

被邀请入群证模式更新操作结果的返回。

业务场景：进行被邀请入群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：被邀请入群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupBeInviteMode]，被邀请入群验证模式更新。

ZIMGroupCreatedCallback

方法

onGroupCreated

public onGroupCreated

创建群的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群组信息。
userList	ArrayList<ZIMGroupMemberInfo>	用户列表。
errorUserList	ArrayList<ZIMErrorUserInfo>	错误用户列表。
errorInfo	ZIMError	创建群组的错误码。0 代表创建群组成功，非 0 为创建群组失败。若出现创建群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群创建操作结果的返回。

业务场景：进行群创建操作后，成功与否可以通过该回调得知。
通知时机：群创建操作结束后的结果返回。
相关接口：[createGroup]，创建群组。

ZIMGroupDismissedCallback

方法

onGroupDismissed

public onGroupDismissed

解散群的结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
errorInfo	ZIMError	解散群组的错误码。0 代表解散群组成功，非 0 为解散群组失败。若出现解散群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群解散操作结果的返回。

业务场景：进行群解散操作后，成功与否可以通过该回调得知。
通知时机：群解散操作结束后的结果返回。
相关接口：[createGroup]，创建群组。[dismissGroup]，解散群租。

ZIMGroupInfoQueriedCallback

方法

onGroupInfoQueried

public onGroupInfoQueried

查询群信息的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群信息。
errorInfo	ZIMError	查询群组信息的错误码。0 代表查询群组信息成功，非 0 为查询群组信息失败。若出现查询群组信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群信息查询结果的返回。

业务场景：进行群信息查询后，成功与否可以通过该回调得知。
通知时机：群信息查询结束后的结果返回。
相关接口：[queryGroupInfo]，群信息查询。

ZIMGroupInviteApplicationAcceptedCallback

方法

onGroupInviteApplicationAccepted

public onGroupInviteApplicationAccepted

接受邀请入群申请的回调。

参数

名称	类型	描述
groupID	String	群组ID。
inviterUserID	String	邀请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

接受邀请入群申请的操作结果的返回。

业务场景：接受邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[acceptGroupInviteApplication]，接受邀请入群申请。

ZIMGroupInviteApplicationRejectedCallback

方法

onGroupInviteApplicationRejected

public onGroupInviteApplicationRejected

拒绝邀请入群申请的回调。

参数

名称	类型	描述
groupID	String	群组ID。
inviterUserID	String	邀请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

拒绝邀请入群申请的操作结果的返回。

业务场景：拒绝邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[rejectGroupInviteApplication]，拒绝邀请入群申请。

ZIMGroupInviteApplicationsSentCallback

方法

onGroupInviteApplicationsSent

public onGroupInviteApplicationsSent

发送邀请入群申请的回调。

参数

名称	类型	描述
groupID	String	群组ID。
errorUserList	ArrayList<ZIMErrorUserInfo>	邀请失败的用户列表。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

发送邀请入群申请的操作结果的返回。

业务场景：发送邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[sendGroupInviteApplications]，发送邀请入群申请。

ZIMGroupInviteModeUpdatedCallback

方法

onGroupInviteModeUpdated

public onGroupInviteModeUpdated

邀请入群验证模式更新的回调。

参数

名称	类型	描述
groupID	String	群组ID。
mode	ZIMGroupInviteMode	邀请入群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

邀请入群证模式更新操作结果的返回。

业务场景：进行邀请入群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：邀请入群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupInviteMode]，邀请入群验证模式更新。

ZIMGroupJoinApplicationAcceptedCallback

方法

onGroupJoinApplicationAccepted

public onGroupJoinApplicationAccepted

接受加群申请的回调。

参数

名称	类型	描述
groupID	String	群组ID。
userID	String	申请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

接受加群申请的操作结果的返回。

业务场景：接受加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[acceptGroupJoinApplication]，接受加群申请。

ZIMGroupJoinApplicationRejectedCallback

方法

onGroupJoinApplicationRejected

public onGroupJoinApplicationRejected

拒绝加群申请的回调。

参数

名称	类型	描述
groupID	String	群组ID。
userID	String	申请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

拒绝加群申请的操作结果的返回。

业务场景：拒绝加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[rejectGroupJoinApplication]，拒绝加群申请。

ZIMGroupJoinApplicationSentCallback

方法

onGroupJoinApplicationSent

public onGroupJoinApplicationSent

发送加群申请的回调。

参数

名称	类型	描述
groupID	String	群组ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

发送加群申请的操作结果的返回。

业务场景：发送加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[sendGroupJoinApplication]，发送加群申请。

ZIMGroupJoinModeUpdatedCallback

方法

onGroupJoinModeUpdated

public onGroupJoinModeUpdated

加群验证模式更新的回调。

参数

名称	类型	描述
groupID	String	群组ID。
mode	ZIMGroupJoinMode	加群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

加群验证模式更新操作结果的返回。

业务场景：进行加群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：加群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupJoinMode]，加群验证模式更新。

ZIMGroupJoinedCallback

方法

onGroupJoined

public onGroupJoined

加入群的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo*	群信息。
errorInfo	ZIMError	加入群组的错误码。0 代表加入群组成功，非 0 为加入群组失败。若出现加入群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群加入操作结果的返回。

业务场景：进行群加入操作后，成功与否可以通过该回调得知。
通知时机：群加入操作结束后的结果返回。
相关接口：[joinGroup]，加入群组。[leaveGroup]，离开群组。

ZIMGroupLeftCallback

方法

onGroupLeft

public onGroupLeft

离开群的结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
errorInfo	ZIMError	离开群组的错误码。0 代表离开群组成功，非 0 为离开群组失败。若出现离开群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群离开操作结果的返回。

业务场景：进行群离开操作后，成功与否可以通过该回调得知。
通知时机：群离开操作结束后的结果返回。
相关接口：[leaveGroup]，离开群组。[joinGroup]，进入群组。

ZIMGroupListQueriedCallback

方法

onGroupListQueried

public onGroupListQueried

查询群列表的结果的返回。

参数

名称	类型	描述
groupList	ArrayList<ZIMGroupInfo>	群列表。
errorInfo	ZIMError	查询群组列表的错误码。0 代表查询群组列表成功，非 0 为查询群组列表失败。若出现查询群组列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

群列表查询结果的返回。

业务场景：进行群列表查询后，成功与否可以通过该回调得知。
通知时机：群列表查询结束后的结果返回。
相关接口：[queryGroupList]，查询群组列表。

ZIMGroupMemberCountQueriedCallback

方法

onGroupMemberCountQueried

public onGroupMemberCountQueried

查询群成员数量的结果的返回。

参数

名称	类型	描述
groupID	String	成员数量。
count	int	下一个标志。
errorInfo	ZIMError	查询群成员数量的错误码。0 代表查询群成员数量成功，非 0 为查询群成员数量失败。若出现查询群成员数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员数量操作结果的返回。

业务场景：进行查询群成员数量操作后，成功与否可以通过该回调得知。
通知时机：查询群成员数量操作结束后的结果返回。
相关接口：[queryGroupMemberCount]，查询群成员数量。

ZIMGroupMemberInfoQueriedCallback

方法

onGroupMemberInfoQueried

public onGroupMemberInfoQueried

群成员查询的结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
userInfo	ZIMGroupMemberInfo	群成员信息。
errorInfo	ZIMError	查询群组成员的错误码。0 代表查询群组成员成功，非 0 为查询群组成员失败。若出现查询群组成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员查询结果的返回。

业务场景：进行群成员查询后，成功与否可以通过该回调得知。
通知时机：群成员查询后的结果返回。
相关接口：[queryGroupMemberInfo]，群成员查询。

ZIMGroupMemberKickedoutCallback

方法

ZIMGroupMemberKickedCallback

public ZIMGroupMemberKickedCallback

踢出群成员的结果的返回。

参数

名称	类型	描述
kickedUserIDList	ArrayList<String>	被踢出的成员列表。
errorUserList	ArrayList<ZIMErrorUserInfo>	错误的用户列表。
errorInfo	ZIMError	踢出群成员的错误码。0 代表踢出群成员成功，非 0 为踢出群成员失败。若出现踢出群成员时，开发者应查看官网错误码文档查询解决方案。

详情

踢出群成员操作结果的返回。

业务场景：进行踢出群成员操作后，成功与否可以通过该回调得知。
通知时机：踢出群成员操作结束后的结果返回。
相关接口：[kickGroupMembers]，踢出群成员。

ZIMGroupMemberListQueriedCallback

方法

onGroupMemberListQueried

public onGroupMemberListQueried

查询群成员列表的结果的返回。

参数

名称	类型	描述
userList	ArrayList<ZIMGroupMemberInfo>	成员列表。
nextFlag	int	下一个标志。
errorInfo	ZIMError	查询群成员列表的错误码。0 代表查询群成员列表成功，非 0 为查询群成员列表失败。若出现查询群成员列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员列表操作结果的返回。

业务场景：进行查询群成员列表操作后，成功与否可以通过该回调得知。
通知时机：查询群成员列表操作结束后的结果返回。
相关接口：[queryGroupMemberList]，查询群成员列表。

ZIMGroupMemberMutedListQueriedCallback

方法

onGroupMemberListQueried

public onGroupMemberListQueried

查询群禁言成员列表的结果的返回。

参数

名称	类型	描述
groupID	String	修改群成员禁言状态的群 ID。
nextFlag	long	下一个标志。
userList	ArrayList<ZIMGroupMemberInfo>	成员列表。
errorInfo	ZIMError	查询群禁言成员列表的错误码。0 代表查询群禁言成员列表成功，非 0 为查询群禁言成员列表失败。若出现查询群禁言成员列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员禁言列表操作结果的返回。

业务场景：进行查询群禁言成员列表操作后，成功与否可以通过该回调得知。
通知时机：查询群禁言成员列表操作结束后的结果返回。
相关接口：[queryGroupMemberMutedList]，查询群禁言成员列表。

ZIMGroupMemberNicknameUpdatedCallback

方法

onGroupMemberNicknameUpdated

public onGroupMemberNicknameUpdated

群成员昵称更新的结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
forUserID	String	用户ID。
nickname	String	用户昵称。
errorInfo	ZIMError	设置群成员昵称的错误码。0 代表设置群成员昵称成功，非 0 为设置群成员昵称失败。若出现设置群成员昵称失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员昵称更新操作结果的返回。

业务场景：进行群成员昵称更新操作后，成功与否可以通过该回调得知。
通知时机：群成员昵称更新操作结束后的结果返回。
相关接口：[setGroupMemberNickname]，群成员昵称更新。

ZIMGroupMemberRoleUpdatedCallback

方法

onGroupMemberRoleUpdated

public onGroupMemberRoleUpdated

成员角色更新的结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
forUserID	String	用户ID。
role	int	角色。
errorInfo	ZIMError	群成员角色更新的错误码。0 代表群成员角色更新成功，非 0为群成员角色更新失败。若出现群成员角色更新失败时，开发者应查看官网错误码文档查询解决方案。

详情

成员角色更新操作结果的返回。

业务场景：进行成员角色更新操作后，成功与否可以通过该回调得知。
通知时机：成员角色更新操作结束后的结果返回。
相关接口：[setGroupMemberRole]，成员角色更新。

ZIMGroupMembersMutedCallback

方法

onGroupMembersMuted

public onGroupMembersMuted

群成员禁言更新的结果的返回。

参数

名称	类型	描述
groupID	String	群组ID。
isMute	boolean	群成员禁言或解除群成员禁言。
duration	int	群成员禁言时长，单位为秒。
mutedUserIDs	ArrayList<String>	成功被修改禁言状态的群成员 ID 列表。
errorUserList	ArrayList<ZIMErrorUserInfo>	修改禁言状态失败的群成员列表。
errorInfo	ZIMError	更新群成员禁言信息的错误码。0 代表更新群成员禁言信息成功，非 0为更新群成员禁言信息失败。若出现更新群成员禁言信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员禁言信息更新操作结果的返回。

业务场景：进行群成员禁言信息更新操作后，成功与否可以通过该回调得知。
通知时机：群成员禁言信息更新操作结束后的结果返回。
相关接口：[muteGroupMembers]，群禁言。

ZIMGroupMembersSearchedCallback

方法

onGroupMembersSearched

public onGroupMembersSearched

搜索群成员的结果的返回。

参数

名称	类型	描述
groupID	String	群 ID。
userList	ArrayList<ZIMGroupMemberInfo>	符合搜索条件的群成员列表。
nextFlag	int	分页拉取标志，搜索下一页的锚点。
errorInfo	ZIMError	搜索群成员的错误码。0 代表搜索群成员成功，非 0 为搜索群成员失败。若出现搜索群成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索群成员的结果的返回。

业务场景：进行群成员搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalGroupMembers]，搜索群成员。

ZIMGroupMessageReceiptMemberListQueriedCallback

方法

onGroupMessageReceiptMemberListQueried

public onGroupMessageReceiptMemberListQueried

查询群回执消息具体已读/未读成员列表的回调接口。

参数

名称	类型	描述
groupID	String	群组 ID。
userList	ArrayList<ZIMGroupMemberInfo>	查询成功的群用户列表。
nextFlag	int	查询下一页对应的 flag，用于给 [ZIMGroupMessageReceiptMemberQueryConfig] 的 nextFlag 参数使用。
errorInfo	ZIMError	设置查询群成员列表返回的错误码。0 代表查询成功，非 0为查询失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群回执消息具体已读/未读成员列表的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [queryGroupMessageReceiptReadMemberList] / [queryGroupMessageReceiptUnreadMemberList] 接口时，会触发该回调。

支持版本：2.5.0 及以上。

ZIMGroupMutedCallback

方法

onGroupMuted

public onGroupMuted

群禁言更新的结果的返回。

参数

名称	类型	描述
groupID	String	群组ID。
isMute	boolean	群禁言或解除群禁言。
mutedInfo	ZIMGroupMuteInfo	群禁言信息。
errorInfo	ZIMError	更新群禁言信息的错误码。0 代表更新群禁言信息成功，非 0为更新群禁言信息失败。若出现更新群禁言信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群禁言信息更新操作结果的返回。

业务场景：进行群禁言信息更新操作后，成功与否可以通过该回调得知。
通知时机：群禁言信息更新操作结束后的结果返回。
相关接口：[muteGroup]，群禁言。

ZIMGroupNameUpdatedCallback

方法

onGroupNameUpdated

public onGroupNameUpdated

群名称更新的结果的返回。

参数

名称	类型	描述
groupID	String	群组ID。
groupName	String	群名称。
errorInfo	ZIMError	更新群名称的错误码。0 代表更新群名称成功，非 0为更新群名称失败。若出现更新群名称失败时，开发者应查看官网错误码文档查询解决方案。

详情

群名称更新操作结果的返回。

业务场景：进行群名称更新操作后，成功与否可以通过该回调得知。
通知时机：群名称更新操作结束后的结果返回。
相关接口：[updateGroupName]，群名称更新。

ZIMGroupNoticeUpdatedCallback

方法

onGroupNoticeUpdated

public onGroupNoticeUpdated

群公告更新的结果的返回。

参数

名称	类型	描述
groupNotice	String	群公告。
errorInfo	ZIMError	更新群公告的错误码。0 代表更新群公告成功，非 0为更新群公告失败。若出现更新群公告失败时，开发者应查看官网错误码文档查询解决方案。

详情

群公告更新操作结果的返回。

业务场景：进行群公告更新操作后，成功与否可以通过该回调得知。
通知时机：群公告更新操作结束后的结果返回。
相关接口：[updateGroupNotice]，群公告更新。

ZIMGroupOwnerTransferredCallback

方法

onGroupOwnerTransferred

public onGroupOwnerTransferred

群主转让的结果的返回。

参数

名称	类型	描述
groupID	String	群组ID。
toUserID	String	用户ID。
errorInfo	ZIMError	转让群主的错误码。0 代表转让群主成功，非 0为转让群主失败。若出现转让群主失败时，开发者应查看官网错误码文档查询解决方案。

详情

群主转让操作结果的返回。

业务场景：进行群主转让操作后，成功与否可以通过该回调得知。
通知时机：群主转让操作结束后的结果返回。
相关接口：[transferGroupOwner]，群主转让。

ZIMGroupUsersInvitedCallback

方法

onGroupUsersInvited

public onGroupUsersInvited

用户被邀请进群的结果的返回。

参数

名称	类型	描述
groupID	String	群组 ID。
userList	ArrayList<ZIMGroupMemberInfo>	用户列表。
errorUserList	ArrayList<ZIMErrorUserInfo>	邀请失败的用户列表。
errorInfo	ZIMError	邀请用户入群的错误码。0 代表邀请用户入群，非 0为邀请用户入群失败。若出现邀请用户入群失败时，开发者应查看官网错误码文档查询解决方案。

详情

邀请用户进群操作结果的返回。

业务场景：用户被邀请进群后，成功与否可以通过该回调得知。
通知时机：用户被邀请进群后的结果返回。
相关接口：[inviteUsersIntoGroup]，邀请用户进群。

ZIMGroupsSearchedCallback

方法

onGroupsSearched

public onGroupsSearched

搜索群的结果的返回。

参数

名称	类型	描述
groupSearchInfoList	ArrayList<ZIMGroupSearchInfo>	群组信息。
nextFlag	int	分页拉取标志，搜索下一页的锚点。
errorInfo	ZIMError	搜索群组的错误码。0 代表搜索群组成功，非 0 为搜索群组失败。若出现搜索群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索群操作结果的返回。

业务场景：进行群搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalGroups]，搜索群组。

ZIMLogUploadedCallback

方法

onLogUploaded

public onLogUploaded

日志上传结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	日志上传结果的错误信息。信息中的错误码值 0 代表成功，非 0 为失败。若出现上传失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者进行上传日志后，执行结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否上传成功。
通知时机：当开发者调用 [uploadLog] 接口时，会触发该回调。
相关接口：通过 [uploadLog] 调用日志上传，成功与否会通过本回调通知。

支持版本：1.2.0 及以上。

ZIMLoggedInCallback

方法

onLoggedIn

public onLoggedIn

登录结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	日志上传结果的错误信息。信息中的错误码值 0 代表成功，非 0 为失败。若出现上传失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者登录结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
通知时机：当开发者调用 [login] 接口时，会触发该回调。

支持版本：1.2.0 及以上。

ZIMMediaDownloadedCallback

下载消息的回调接口

详情

下载消息的回调接口

Declared in callback/ZIMMediaDownloadedCallback.java

方法

onMediaDownloaded

public void onMediaDownloaded(ZIMMessage message, ZIMError errorInfo)

下载媒体消息的结果回调。

Declared in callback/ZIMMediaDownloadedCallback.java

参数

名称	类型	描述
message	ZIMMessage	详情描述：发送的消息对象，可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。
errorInfo	ZIMError	详情描述：发送消息的错误码。0 代表发送消息成功，非 0为发送消息失败。若出现发送消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

媒体消息下载的结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否下载成功。
通知时机：当开发者调用 [downloadMediaFile] 接口时，会触发该回调。
相关接口：通过 [downloadMediaFile] 下载媒体消息，成功与否会通过本回调通知。

支持版本：2.1.0 及以上。

onMediaDownloadingProgress

public void onMediaDownloadingProgress(ZIMMessage message, long currentFileSize, long totalFileSize)

下载媒体消息的进度回调。

Declared in callback/ZIMMediaDownloadedCallback.java

参数

名称	类型	描述
message	ZIMMessage	详情描述：当前下载的消息对象。
currentFileSize	long	详情描述：当前进度，即当前文件下载的实时大小。
totalFileSize	long	详情描述：总进度，即当前文件的总大小。

详情

下载媒体消息的进度回调。

业务场景：开发者可以通过该回调获得媒体消息的下载进度。
通知时机：当开发者调用 [downloadMediaFile] 接口时，会触发该回调，且在下载的过程中将会多次触发。
相关接口：通过 [downloadMediaFile]，下载进度情况会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMediaMessageSentCallback

发送媒体消息的回调接口。

详情

发送媒体消息的回调接口。

Declared in ZIM.java

方法

onMessageSent

public void onMessageSent(ZIMMediaMessage message, ZIMError errorInfo)

发送消息的结果的回调。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMediaMessage	详情描述：ZIMMediaMessage 对象。
errorInfo	ZIMError

详情

发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [sendMessage] 接口时，会触发该回调。
相关接口：通过 [sendMessage] 发送消息，发送消息的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

onMessageAttached

public void onMessageAttached(ZIMMediaMessage message)

为传入的消息对象赋予 localMessgeID 并返回。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMediaMessage	详情描述：ZIMMediaMessage 对象，与传入对象地址相同。

详情

为传入的消息对象赋予 localMessgeID 并返回。

业务场景：在消息发送成功前，可以对应其消息localMessageID，实现发送前loading的效果。
通知时机：发送消息后，消息发送成功前触发。

支持版本：2.4 及以后。

onMediaUploadingProgress

public void onMediaUploadingProgress(ZIMMediaMessage message, long currentFileSize, long totalFileSize)

返回上传进度的回调方法。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMediaMessage	详情描述：媒体消息对象。
currentFileSize	long	当前已上传的文件大小。
totalFileSize	long	文件总大小。

支持版本：返回上传进度的回调方法。

ZIMMessageDeletedCallback

方法

onMessageDeleted

public onMessageDeleted

删除消息的回调。

参数

名称	类型	描述
conversationID	String	会话 ID
conversationType	ZIMConversationType	会话类型
errorInfo	ZIMError	删除消息的错误码。0 代表删除消息成功，非 0为删除消息失败。若出现删除消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除消息后通过该回调返回消息删除的结果。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
通知时机：调用删除消息接口 [deleteMessage] 后触发。
相关接口：[deleteMessage]。

支持版本：2.0.0 及以上。

ZIMMessageExportedCallback

方法

onMessageExported

public onMessageExported

导出消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	导出消息的错误码。0 代表导出消息成功，非 0 为导出消息失败。

详情

导出消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否导出成功。
通知时机：当开发者调用 [exportLocalMessages] 接口时，会触发该回调。
相关接口：通过 [exportLocalMessages] 导出消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageExportingProgress

方法

onMessageExportingProgress

public onMessageExportingProgress

导出消息的进度回调。

参数

名称	类型	描述
exportedMessageCount	long	当前进度，即当前导出的消息数。
totalMessageCount	long	总进度，即导出消息的总数目。

详情

导出消息的进度回调。

业务场景：开发者可以通过该回调获得导出消息的进度。
通知时机：当开发者调用 [exportLocalMessages] 接口时，会触发该回调，且在导出的过程中将会多次触发。
相关接口：通过 [exportLocalMessages]，导出进度情况会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageImportedCallback

方法

onMessageImported

public onMessageImported

导入消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	导入消息的错误码。0 代表导入消息成功，非 0 为导入消息失败。

详情

导入消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否导入成功。
通知时机：当开发者调用 [importLocalMessages] 接口时，会触发该回调。
相关接口：通过 [importLocalMessages] 导入消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageImportingProgress

方法

onMessageImportingProgress

public onMessageImportingProgress

导入消息的进度回调。

参数

名称	类型	描述
importedMessageCount	long	当前进度，即当前导入的消息数。
totalMessageCount	long	总进度，即导入消息的总数目。

详情

导入消息的进度回调。

业务场景：开发者可以通过该回调获得导入消息的进度。
通知时机：当开发者调用 [importLocalMessages] 接口时，会触发该回调，且在导入的过程中将会多次触发。
相关接口：通过 [importLocalMessages]，导入进度情况会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageInsertedCallback

方法

ZIMMessageInsertedCallback

public ZIMMessageInsertedCallback

插入本地消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。
errorInfo	ZIMError	插入本地消息的错误码。0 代表插入消息成功，非 0 为插入消息失败。若出现插入消息失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

插入本地消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否插入成功。
通知时机：当开发者调用 [insertMessageToLocalDB] 接口时，会触发该回调。
相关接口：通过 [insertMessageToLocalDB] 插入本地消息，成功与否会通过本回调通知。

支持版本：2.4.0 及以上。

ZIMMessageLocalExtendedDataUpdatedCallback

方法

onMessageExtendedDataUpdated

public onMessageExtendedDataUpdated

更新消息本地拓展字段的回调。

参数

名称	类型	描述
message	ZIMMessage	更新后消息对象。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者修改消息本地扩展信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateMessageLocalExtendedData] 接口时，会触发该回调。

支持版本：2.9.0 及以上。

ZIMMessagePinnedCallback

方法

ZIMMessagePinnedCallback

public ZIMMessagePinnedCallback

置顶或取消置顶消息的结果的回调。

参数

名称	类型	描述
handle	zim_handle	实例的句柄。
errorInfo	ZIMError	置顶或取消消息的错误码。
sequence	zim_sequence	上下文，用于标识本次回调是哪一次调用触发的。

详情

置顶或取消置顶消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否编辑成功。
通知时机：当开发者调用 [pinMessage] 接口时，会触发该回调。

支持版本：2.25.0 及以上。

ZIMMessageQueriedCallback

方法

onMessageQueried

public onMessageQueried

开发者通过该回调获取查询到的消息列表，可以做历史消息显示。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
messageList	ArrayList<ZIMMessage>	查询结果的消息列表。
errorInfo	ZIMError	查询消息的错误码。0 代表查询消息成功，非 0为查询消息失败。若出现查询消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询消息列表的结果回调。

业务场景：开发者通过该回调获取查询到的消息列表，可以做历史消息显示。
通知时机：调用查询历史消息接口 [queryHistoryMessage] 后，查询到的消息列表会通过本回调通知。
相关接口：通过 [queryHistoryMessage] 查询历史消息，查询到的消息列表会通过本回调通知。

支持版本：2.0.0 及以上。

ZIMPinnedMessageListQueriedCallback

public ZIMPinnedMessageListQueriedCallback

开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。

参数

名称	类型	描述
messageList	ArrayList<ZIMMessage>	查询结果的消息列表。
errorInfo	ZIMError	查询消息的错误码。0 代表查询消息成功，非 0为查询消息失败。若出现查询消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询置顶消息列表的结果回调。

业务场景：开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。
通知时机：调用查询置顶消息接口 [queryPinnedMessageList] 后，查询到的置顶消息列表会通过本回调通知。
相关接口：通过 [queryPinnedMessageList] 查询历史消息，查询到的消息列表会通过本回调通知。

支持版本：2.25.0 及以上。

ZIMMessageReactionAddedCallback

方法

onMessageReactionAdded

public onMessageReactionAdded

消息表态新增的返回。

参数

名称	类型	描述
reaction	ZIMMessageReaction	表态数据。
errorInfo	ZIMError	添加消息表态的错误码，0 代表操作成功，非 0 代表操作失败，请参考官网文档（https://doc-zh.zego.im/article/11605）获取解决方案。

详情

消息表态新增操作的结果。

通知时机：对消息进行表态后。
相关接口：[addMessageReaction]

支持版本：2.10.0 及以上。

ZIMMessageReactionDeletedCallback

方法

onMessageReactionDeleted

public onMessageReactionDeleted

消息表态删除的返回。

参数

名称	类型	描述
reaction	ZIMMessageReaction	表态数据。
errorInfo	ZIMError	删除消息表态的错误码，0 代表操作成功，非 0 代表操作失败，请参考官网文档（https://doc-zh.zego.im/article/11605）获取解决方案。

详情

消息表态删除操作的结果。

通知时机：删除消息表态后。
相关接口：[deleteMessageReaction]

支持版本：2.10.0 及以上。

ZIMMessageReactionUserListQueriedCallback

方法

onMessageReactionUserListQueried

public onMessageReactionUserListQueried

消息表态详情查询的返回。

参数

名称	类型	描述
message	ZIMMessage	表态相关的消息。
userList	ArrayList<ZIMMessageReactionUserInfo>	查询出来的表态用户详情列表。
reactionType	String	表态的类型。
nextFlag	long	查询锚点，用于下一次分页传给 [ZIMMessageReactionUserQueryConfig] 查询使用。
totalCount	int	表态的用户总数。
error	ZIMError	错误信息。

详情

消息表态用户信息查询操作的结果。

通知时机：查询消息表态的用户信息后。
相关接口：[queryMessageReactionUserList]

支持版本：2.10.0 及以上。

ZIMMessageReceiptsInfoQueriedCallback

方法

onMessageReceiptsInfoQueried

public onMessageReceiptsInfoQueried

查询回执消息信息的回调接口。

参数

名称	类型	描述
infos	ArrayList<ZIMMessageReceiptInfo>	查询出来的回执信息。
errorMessageIDs	ArrayList<Long>	查询消息回执信息错误的消息ID。
errorInfo	ZIMError	查询消息回执的错误码。0 代表查询成功，非 0 为查询失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询回执消息信息的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [queryMessageReceiptsInfo] 接口时，会触发该回调。
相关接口：通过 [queryMessageReceiptsInfo] 查询回执的信息的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageReceiptsReadSentCallback

方法

onMessageReceiptsReadSent

public onMessageReceiptsReadSent

设置回执消息已读的回调接口。

参数

名称	类型	描述
conversationID	String	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorMessageIDs	ArrayList<Long>	设置消息回执失败对应的消息ID。
errorInfo	ZIMError	设置回执消息已读的错误码。0 代表设置成功，非 0为设置失败。若出现设置失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置回执消息已读的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
通知时机：当开发者调用 [sendMessageReceiptsRead] 接口时，会触发该回调。
相关接口：通过 [sendMessageReceiptsRead] 设置回执的消息已读的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageRepliedListQueriedCallback

方法

onMessageRepliedListQueried

public onMessageRepliedListQueried

查询回复消息列表的结果的回调。

名称	类型	描述
messageList	ArrayList<ZIMMessage>	查询出来的消息列表。
nextFlag	long	查询锚点，用于下一次分页传给 [ZIMMessageRepliedListQueryConfig] 查询使用。
rootRepliedInfo	ZIMMessageRootRepliedInfo	根消息的回复信息。
error	ZIMError	错误信息。

ZIMMessageRevokedCallback

方法

onMessageRevoked

public onMessageRevoked

撤回消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。
errorInfo	ZIMError	撤回消息的错误码。0 代表撤回成功，非 0为撤回失败。若出现撤回失败时，开发者应查看官网错误码文档查询解决方案。

详情

撤回消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [revokeMessage] 接口时，会触发该回调。
相关接口：通过 [revokeMessage] 撤回消息，发送消息的成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageSentCallback

发送消息的回调接口

详情

发送消息的回调接口

Declared in ZIM.java

方法

onMessageSent

public void onMessageSent(ZIMMessage message, ZIMError errorInfo)

发送消息的结果的回调。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMessage	详情描述：ZIMMessage 对象。
errorInfo	ZIMError

详情

发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [sendMessage] 接口时，会触发该回调。
相关接口：通过 [sendMessage] 发送消息，发送消息的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

onMessageAttached

public void onMessageAttached(ZIMMessage message)

为传入的消息对象赋予 localMessgeID 并返回。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMessage	详情描述：ZIMMessage 对象，与传入对象地址相同。

详情

为传入的消息对象赋予 localMessgeID 并返回。

业务场景：在消息发送成功前，可以对应其消息localMessageID，实现发送前loading的效果。
通知时机：发送消息后，消息发送成功前触发。

支持版本：2.4 及以后。

ZIMMessageSentFullCallback

发送消息的回调接口

详情

发送消息的回调接口

Declared in ZIM.java

方法

onMessageSent

public void onMessageSent(ZIMMessage message, ZIMError errorInfo)

发送消息的结果的回调。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMessage	详情描述：ZIMMessage 对象。
errorInfo	ZIMError

详情

发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [sendMessage] 接口时，会触发该回调。
相关接口：通过 [sendMessage] 发送消息，发送消息的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

onMessageAttached

public void onMessageAttached(ZIMMessage message)

为传入的消息对象赋予 localMessgeID 并返回。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMessage	详情描述：ZIMMessage 对象，与传入对象地址相同。

详情

为传入的消息对象赋予 localMessgeID 并返回。

业务场景：在消息发送成功前，可以对应其消息localMessageID，实现发送前loading的效果。
通知时机：发送消息后，消息发送成功前触发。

支持版本：2.4 及以后。

onMediaUploadingProgress

public void onMediaUploadingProgress(ZIMMediaMessage message, long currentFileSize, long totalFileSize)

发送媒体消息的进度回调。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMediaMessage	详情描述：当前文件上传的消息对象。
currentFileSize	long	当前进度，即当前文件上传的实时大小。
totalFileSize	long	总进度，即当前文件的总大小。

详情

发送媒体消息的进度回调。

业务场景：开发者可以通过该回调获得媒体消息的发送进度。

支持版本：2.17.0 及以上。

onMultipleMediaUploadingProgress

public void onMultipleMediaUploadingProgress(ZIMMultipleMessage message, long currentFileSize, long totalFileSize, int messageInfoIndex, long currentIndexFileSize, long totalIndexFileSize)

发送包含媒体文件的组合消息的上传进度回调。

Declared in ZIM.java

参数

名称	类型	描述
message	ZIMMultipleMessage	当前发送的消息对象。
currentFileSize	long	当前总共已上传的大小。
totalFileSize	long	待上传的总共的文件的大小。
messageInfoIndex	int	当前上传的文件所在数组的索引。
currentIndexFileSize	long	当前上传的文件的已上传的大小。
totalIndexFileSize	long	当前上传的文件的总的大小。

详情

通过该通知，开发者可以获取到组合消息里的媒体文件上传时的进度回调。

业务场景：开发者可用于展示各媒体文件的上传进度及总的上传进度，提升 UI 交互体验。

支持版本：2.19.0 及以上。

ZIMMessagesGlobalSearchedCallback

方法

onMessagesGlobalSearched

public onMessagesGlobalSearched

全局搜索本地消息结果的返回。

参数

名称	类型	描述
messageList	ArrayList<ZIMMessage>	全局搜索到的消息列表。
nextMessage	ZIMMessage	分页拉取标志，搜索下一页的消息锚点。
errorInfo	ZIMError	全局搜索本地消息的错误码。0 代表全局搜索本地消息成功，非 0 为全局搜索本地消息失败。若出现全局搜索本地消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

全局搜索本地消息结果的返回。

业务场景：进行全局本地消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchGlobalLocalMessages]，全局搜索本地消息。

ZIMMessagesSearchedCallback

方法

onMessagesSearched

public onMessagesSearched

搜索本地消息结果的返回。

参数

名称	类型	描述
conversationID	String	会话 ID，单聊时，conversationID 即是对方的 userID。群组时，conversationID 即是群组的 groupID。
conversationType	ZIMConversationType	会话类型。0：单聊 1：房间 2：群组，注意：“房间”场景下，默认不支持缓存和搜索离线消息。
messageList	ArrayList<ZIMMessage>	搜索到的消息列表。
nextMessage	ZIMMessage	分页拉取标志，搜索下一页的消息锚点。
errorInfo	ZIMError	搜索本地消息的错误码。0 代表搜索本地消息成功，非 0 为搜索本地消息失败。若出现搜索本地消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索本地消息结果的返回。

业务场景：进行本地消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalMessages]，搜索本地消息。

ZIMRoomAttributesBatchOperatedCallback

方法

ZIMRoomAttributesBatchOperatedCallback

public ZIMRoomAttributesBatchOperatedCallback

房间属性组合操作结果的返回。

参数

名称	类型	描述
roomID	String	房间 ID
errorInfo	ZIMError	房间属性批处理操作的错误码。0 代表房间属性批处理操作成功，非 0 为房间属性批处理操作失败。若出现房间属性批处理操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性组合操作结果的返回。

业务场景：进行自定义属性组合操作后，成功与否可以通过该回调得知。
通知时机：房间属性组合操作结束后的结果返回。
相关接口：[beginRoomAttributesBatchOperation]，开始房间属性组合操作。[endRoomAttributesBatchOperation]，完成房间属性组合操作。

支持版本：1.3.0。

ZIMRoomAttributesOperatedCallback

方法

ZIMRoomAttributesOperatedCallback

public ZIMRoomAttributesOperatedCallback

房间属性操作结果的返回。

参数

名称	类型	描述
roomID	String	房间 ID。
errorKeys	ArrayList<String>	操作失败的 keys。
errorInfo	ZIMError	房间属性操作的错误码。0 代表房间属性操作成功，非 0 为房间属性操作失败。若出现房间属性操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性操作结果的返回。

业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
通知时机：房间属性操作结束后的结果返回。
相关接口：[setRoomAttributes]，设置房间属性。[deleteRoomAttributes]，删除房间属性。

支持版本：1.3.0。

ZIMRoomAttributesQueriedCallback

方法

ZIMRoomAttributesQueriedCallback

public ZIMRoomAttributesQueriedCallback

房间属性查询结果的返回。

参数

名称	类型	描述
roomID	String	房间 ID
roomAttributes	HashMap<String, String>	房间内的房间属性。
errorInfo	ZIMError	查询房间全部属性的错误码。0 代表查询房间全部属性成功，非 0 为查询房间全部属性失败。若出现查询房间全部属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性查询结果的返回。

业务场景：进行自定义属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间属性查询结束后的结果返回。
相关接口：[queryRoomAllAttributes]，查询房间属性。

支持版本：1.3.0。

ZIMRoomCreatedCallback

方法

onRoomCreated

public onRoomCreated

创建房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	错误信息。

详情

创建房间的结果回调。

业务场景：当开发者创建房间时可以通过该回调来判断是否创建成功，并执行相应的业务逻辑。
通知时机：当调用 [createRoom] 创建房间后结果会触发本回调通知。
相关接口：通过 [createRoom] 创建房间，创建结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomEnteredCallback

方法

onRoomEntered

public onRoomEntered

进入房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	错误信息。

详情

进入房间的结果回调。

业务场景：当开发者进入房间时可以通过该回调来判断是否进入成功，并执行相应的业务逻辑。
通知时机：当调用 [enterRoom] 进入房间后结果会触发本回调通知。
相关接口：通过 [enterRoom] 创建房间，进入结果会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMRoomJoinedCallback

方法

onRoomJoined

public onRoomJoined

加入房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	加入的房间的详细信息。若加入失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	加入房间的错误码。0 代表加入房间成功，非 0 为加入房间失败。若出现加入房间失败时，开发者应查看官网错误码文档查询解决方案。

详情

加入房间的结果的回调。

业务场景：当开发者加入房间时，开发者可以通过该回调判断是否加入成功。
通知时机：当有人加入房间时，会通过该回调通知。
相关接口：通过 [joinRoom] 加入房间，加入结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomLeftCallback

方法

onRoomLeft

public onRoomLeft

离开房间的结果的回调。

参数

名称	类型	描述
roomID	String	房间 ID
errorInfo	ZIMError	离开房间的错误码。0 代表离开房间成功，非 0 为离开房间失败。若出现离开房间失败时，开发者应查看官网错误码文档查询解决方案。

详情

离开房间的结果的回调。

业务场景：当用户本人需要离开房间时，开发者可以在该回调里进行业务逻辑处理。
通知时机：当用户调用 [leaveRoom]，则会触发该回调返回结果。
相关接口：通过 [leaveRoom] 离开房间，离开结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomMemberAttributesListQueriedCallback

方法

ZIMRoomMemberAttributesListQueriedCallback

public ZIMRoomMemberAttributesListQueriedCallback

房间内用户属性列表查询结果的返回。

参数

名称	类型	描述
roomID	String	房间 ID。
infos	ArrayList<ZIMRoomMemberAttributesInfo>	房间用户属性列表。
nextFlag	String	下一个分页查询的锚点，为空则代表已经查询完毕。
errorInfo	ZIMError	查询房间用户属性的错误码。0 代表查询房间用户属性成功，非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

分页查询房间内所有用户属性列表结果的返回。

业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间用户属性查询结束后的结果返回。
相关接口：[queryRoomMemberAttributesList]，查询房间用户属性。

支持版本：2.4.0 及以上。

ZIMRoomMemberQueriedCallback

方法

onRoomMemberQueried

public onRoomMemberQueried

查询房间成员列表的结果回调。

参数

名称	类型	描述
roomID	String	房间 ID
memberList	ArrayList<ZIMUserInfo>	房间的成员列表。
nextFlag	String	分页查询的标识位，如果此字段为空字符串，说明已查询完毕。否则需要将此值设置到 ZIMQueryMemberConfig 的 "nextFlag" 字段中以进行下一页查询。
errorInfo	ZIMError	查询房间成员的错误码。0 代表查询房间成员成功，非 0 为查询房间成员失败。若出现查询房间成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询房间成员列表的结果回调。

通知时机：当调用 [queryRoomMember] 接口进行房间成员查询时候，会触发该回调。
相关接口：通过 [queryRoomMember] 查询房间成员列表，查询结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomMembersAttributesQueriedCallback

方法

ZIMRoomMembersAttributesQueriedCallback

public ZIMRoomMembersAttributesQueriedCallback

房间用户属性批量查询结果的返回。

参数

名称	类型	描述
roomID	String	房间 ID。
infos	ArrayList<ZIMRoomMemberAttributesInfo>	房间用户属性列表。
errorInfo	ZIMError	查询房间用户属性的错误码。0 代表查询房间用户属性成功，非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

根据 UserID 列表，房间用户属性批量查询结果的返回。

业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间用户属性查询结束后的结果返回。
相关接口：[queryRoomMembersAttributes]，查询房间用户属性。

支持版本：2.4.0 及以上。

ZIMRoomMembersQueriedCallback

方法

ZIMRoomMembersQueriedCallback

public ZIMRoomMembersQueriedCallback

查询房间指定成员的结果回调。

参数

名称	类型	描述
roomID	String	房间 ID。
memberList	ArrayList<ZIMRoomMemberInfo>	查询成功的用户信息列表。
errorUserList	ArrayList<ZIMErrorUserInfo>	查询失败的用户列表。
errorInfo	ZIMError	错误信息。

详情

查询房间用户信息后通过该回调返回查询结果。

业务场景：可在该回调内做查询房间用户信息后的逻辑。
通知时机：调用 [queryRoomMembers] 接口查询房间用户信息后触发。

支持版本：2.8.0 及以上。

ZIMRoomOnlineMemberCountQueriedCallback

方法

onRoomOnlineMemberCountQueried

public onRoomOnlineMemberCountQueried

查询房间在线成员数量回调。

参数

名称	类型	描述
roomID	String	房间 ID
count	int	房间的在线成员数量。
errorInfo	ZIMError	查询房间在线成员的错误码。0 代表查询房间在线成员成功，非 0 为查询房间在线成员失败。若出现查询房间在线成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

进行查询房间在线成员数量操作后，执行所获得的人数回调。

通知时机：当调用 [queryRoomOnlineMemberCount] 接口进行查询房间成员人数时，会触发该回调。
相关接口：可通过 [queryRoomOnlineMemberCount] 查询房间在线人数。

支持版本：1.1.0 及以上。

ZIMRoomSwitchedCallback

方法

onRoomSwitched

public onRoomSwitched

切换房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	切换后的房间的详细信息。
errorInfo	ZIMError	错误信息。

详情

切换房间的结果回调。

业务场景：当开发者切换房间时可以通过该回调来判断是否切换成功，并执行相应的业务逻辑。
通知时机：当调用 [switchRoom] 切换房间后结果会触发本回调通知。
相关接口：通过 [switchRoom] 切换房间，切换结果会通过本回调通知。

支持版本：2.18.0 及以上。

ZIMSelfUserInfoQueriedCallback

方法

ZIMSelfUserInfoQueriedCallback

public ZIMSelfUserInfoQueriedCallback

查询个人用户信息、规则的结果回调。

参数

名称	类型	描述
selfUserInfo	ZIMSelfUserInfo	自身用户信息、规则数据类。
errorInfo	ZIMError	包含错误码，错误信息。

详情

查询个人用户信息、规则的结果回调。

ZIMSendingMessageCancelledCallback

方法

ZIMSendingMessageCancelledCallback

public ZIMSendingMessageCancelledCallback

取消发送消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	取消发送消息的错误码。

详情

取消发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否取消发送成功。
通知时机：当开发者调用 [cancelSendingMessage] 接口时，会触发该回调。

支持版本：2.22.0 及以上。

ZIMSubscribedUserStatusListQueriedCallback

方法

onSubscribedUserStatusListQueried

public onSubscribedUserStatusListQueried

querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

参数

名称	类型	描述
userStatusSubscriptionList	ArrayList< ZIMUserStatusSubscription >	订阅列表中用户的订阅信息。

详情

querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

ZIMTokenRenewedCallback

方法

onTokenRenewed

public onTokenRenewed

更新 Token 的结果的回调。

参数

名称	类型	描述
token	String	需要更新的鉴权 Token。
errorInfo	ZIMError	错误信息。错误码值为 0 时更新成功，非 0 时更新失败。若出现返回非 0 错误码的时候，开发者应到官网错误码文档中查询解决方案。

详情

开发者更新 Token 后，执行结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否更新 Token 成功。
通知时机：当开发者调用 [renewToken] 接口时，会触发该回调。
相关接口：通过 [renewToken] 更新 Token，更新 Token 的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMUserAvatarUrlUpdatedCallback

方法

onUserAvatarUrlUpdated

public onUserAvatarUrlUpdated

更新 user avatar URL 的回调。

参数

名称	类型	描述
userAvatarUrl	String	更新后的 user avatar URL。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者更新用户头像 URL 后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserAvatarUrl] 接口时，会触发该回调。
相关接口：[updateUserAvatarUrl] 。

支持版本：2.3.0 及以上。

ZIMUserExtendedDataUpdatedCallback

方法

onUserExtendedDataUpdated

public onUserExtendedDataUpdated

更新 user extended data 的回调。

参数

名称	类型	描述
extendedData	String	更新后的 user extended data。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者修改用户扩展信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserExtendedData] 接口时，会触发该回调。
相关接口：通过 [updateUserExtendedData] 查询。

支持版本：2.2.0 及以上。

ZIMUserNameUpdatedCallback

方法

onUserNameUpdated

public onUserNameUpdated

更新 user name 的回调。

参数

名称	类型	描述
userName	String	更新后的 user name。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者更新用户名称后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserName] 接口时，会触发该回调。
相关接口：[updateUserName]。

支持版本：2.2.0 及以上。

ZIMUserOfflinePushRuleUpdatedCallback

方法

ZIMUserOfflinePushRuleUpdatedCallback

public ZIMUserOfflinePushRuleUpdatedCallback

更新用户离线推送规则的结果回调。

参数

名称	类型	描述
offlinePushRule	ZIMUserOfflinePushRule	更新后的离线推送规则。
errorInfo	ZIMError	包含错误码与详细信息。

详情

更新用户离线推送规则的结果回调。

ZIMUsersInfoQueriedCallback

方法

onUsersInfoQueried

public onUsersInfoQueried

查询 userInfo 的回调。

参数

名称	类型	描述
userList	ArrayList<ZIMUserFullInfo>	查询到的 userInfo 列表。
errorUserList	ArrayList<ZIMErrorUserInfo>	查询失败的 userInfo 列表。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者查询用户信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
通知时机：当开发者调用 [queryUsersInfo] 接口时，会触发该回调。
相关接口：通过 [queryUsersInfo] 查询。

支持版本：2.2.0 及以上。

ZIMUsersStatusQueriedCallback

方法

onUsersStatusSubscribed

public onUsersStatusSubscribed

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

参数

名称	类型	描述
userStatusList	ArrayList<ZIMUserStatus>	被查询用户的在线状态信息列表。
errorUserList	ArrayList< ZIMErrorUserInfo >	查询失败的用户列表。
errorInfo	ZIMError	查询操作的结果，包含错误码与错误信息。

详情

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

ZIMUsersStatusSubscribedCallback

方法

onUsersStatusSubscribed

public onUsersStatusSubscribed

subscribeUsersStatus 批量订阅接口的操作结果回调。

参数

名称	类型	描述
errorUserList	ArrayList<ZIMErrorUserInfo>	订阅失败的用户列表。
errorInfo	ZIMError	操作结果，包含错误码与错误信息。

详情

subscribeUsersStatus 批量订阅接口的操作结果回调。

ZIMUsersStatusUnsubscribedCallback

方法

onUsersStatusUnsubscribed

public onUsersStatusUnsubscribed

unsubscribeUsersStatus 批量取消订阅接口的操作回调。

参数

名称	类型	描述
errorUserList	ArrayList<ZIMErrorUserInfo>	取消失败的用户列表。
errorInfo	ZIMError	批量取消操作的结果，包含错误信息与错误码。

详情

unsubscribeUsersStatus 批量取消订阅接口的操作回调。