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

Methods

onRoomAllLeft

public onRoomAllLeft

Callback for the results of leaving all rooms.

Parameters

Name	Type	Description
roomIDs	ArrayList<String>	Room IDs.

Trigger: When the user calls [leaveAllRoom], the callback will be triggered to return the result.

Available since: 1.15 or above.

ZIMBlacklistCheckedCallback

Methods

onBlacklistChecked

public onBlacklistChecked

Blacklist check result callback.

Parameters

Name	Type	Description
isUserInBlacklist	boolean	Whether the user is on the blacklist.
errorInfo	ZIMError	Error code.

Use cases: Developers can determine whether the check was successful through the [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [checkUserIsInBlacklist] interface.

Related interface: Check whether the user is on the blacklist through [checkUserIsInBlacklist].

ZIMBlacklistQueriedCallback

Methods

onBlacklistQueried

public onBlacklistQueried

Query the blacklist result callback.

Parameters

Name	Type	Description
blacklist	list<ZIMUserInfo>	Blacklist data stored locally by the SDK.
nextFlag	int	Description: nextFlag. A value of 0 indicates that the blacklist query is completed. When the value is not 0, it means that the blacklist query is not yet completed. To continue the query, call the query interface again and pass in this nextFlag.
errorInfo	ZIMError	Error code.

Use cases: The developer can check whether the queried succeeded by using [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [queryBlacklist] interface.

Related interface: Run the queryBlacklist query blacklist

ZIMBlacklistUsersAddedCallback

Methods

onBlacklistUsersAdded

public onBlacklistUsersAdded

Callback for operation results of adding users to the blacklist.

Parameters

Name	Type	Description
errorUserList	list<ZIMErrorUserInfo>	List of userInfo that failed to add to the blacklist.
errorInfo	ZIMError	Error code.

Use cases: The developer can check whether the queried succeeded by using [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [addUsersToBlacklist] interface.

Related interface: Run the addUsersToBlacklist add user to blacklist

ZIMBlacklistUsersRemovedCallback

Methods

onBlacklistUsersRemoved

public onBlacklistUsersRemoved

The callback result of the operation to remove the user from the blacklist.

Parameters

Name	Type	Description
errorUserList	list<ZIMErrorUserInfo>	List of userInfo that failed to add.
errorInfo	ZIMError	Error code.

Use cases: The developer can check whether the queried succeeded by using [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [removeUsersFromBlacklist] interface.

Related interface: Remove users from the blacklist through [removeUsersFromBlacklist].

ZIMCallAcceptanceSentCallback

Methods

onCallAcceptanceSent

public onCallAcceptanceSent

Action callback for accepting call invitations.

Parameters

Name	Type	Description
callID	String	Call ID
errorInfo	ZIMError	Error code to accept call invitation. 0 means accepting the call invitation successfully, non-0 means accepting the call invitation failed. If there is a failure to accept the call invitation, the developer should check the official website error code documentation for solutions.

Related APIs: [callAccept], accept the call invitation.

ZIMCallCancelSentCallback

Methods

onCallCancelSent

public onCallCancelSent

Callback for the action to cancel the call invitation.

Parameters

Name	Type	Description
callID	String	Call ID
errorInvitees	ArrayList<String>	The user who failed to cancel the call invitation.
errorInfo	ZIMError	Error code to cancel the call invitation. 0 means canceling the call invitation successfully, non-0 means canceling the call invitation failed. If there is a failure to cancel the call invitation, the developer should check the official website error code document to query the solution.

Related APIs: [callCancel], cancel the call invitation.

ZIMCallEndSentCallback

Methods

ZIMCallEndSentCallback

public ZIMCallEndSentCallback

Result callback of ending the call invitation.

Parameters

Name	Type	Description
callID	String	callID.
info	ZIMCallInvitationEndedInfo	End call invitation return information.
errorInfo	ZIMError	End call invitation return error information.

Details

Result callback of ending the call invitation.

ZIMCallInvitationListQueriedCallback

Methods

ZIMCallInvitationListQueriedCallback

public ZIMCallInvitationListQueriedCallback

Result Callback of querying the call list.

Parameters

Name	Type	Description
callList	ArrayList<ZIMCallInfo>	Query the list of returned call information
nextFlag	long	An anchor returned by a paging query that is passed in the next query to continue the query based on the last query.
errorInfo	ZIMError	Error information returned from the query.

Details

Result Callback of querying the call list.

ZIMCallInvitationSentCallback

Methods

onCallInvitationSent

public onCallInvitationSent

Action callback for sending a call invitation.

Parameters

Name	Type	Description
callID	String	The created call invitation ID.
info	ZIMCallInvitationSentInfo	Send a call invitation message.
errorInfo	ZIMError	Error code for sending call invitation. 0 means sending the call invitation successfully, non-0 means sending the call invitation failed. If there is a failure to send a call invitation, the developer should check the official website error code documentation for solutions.

Related APIs: [callInvite], send a call invitation.

ZIMCallJoinSentCallback

Methods

ZIMCallJoinSentCallback

public ZIMCallJoinSentCallback

Result callback of joining the call invitation.

Name	Type	Description
callID	String	callID.
info	ZIMCallJoinSentInfo	Join call invitation return information.
errorInfo	ZIMError	Join call invitation return error information.

ZIMCallQuitSentCallback

Methods

ZIMCallQuitSentCallback

public ZIMCallQuitSentCallback

Quit the callback closure of the call invitation operation.

Parameters

Name	Type	Description
callID	String	Quit callID.
info	ZIMCallQuitSentInfo	Information about quit.
errorInfo	ZIMError	Error information,

Details

Quit the callback closure of the call invitation operation.

ZIMCallRejectionSentCallback

Methods

onCallRejectionSent

public onCallRejectionSent

Action callback for rejecting a call invitation.

Parameters

Name	Type	Description
callID	String	Call ID
errorInfo	ZIMError	Error code to reject call invitation. 0 means rejecting the call invitation successfully, non-0 means failing to reject the call invitation. If there is a failure to reject the call invitation, the developer should check the official website error code documentation for solutions.

Related APIs: [callReject], rejects the call invitation.

ZIMCallingInvitationSentCallback

Methods

ZIMCallingInvitationSentCallback

public ZIMCallingInvitationSentCallback

Callback result of inviting the current call.

Parameters

Name	Type	Description
callID	String	callID of the current call invitation.
info	ZIMCallingInvitationSentInfo	Information about callingInvite.
errorInfo	ZIMError	Error information. For details, see the Common error code documentation.

Details

Callback result of inviting the current call.

ZIMCombineMessageDetailQueriedCallback

Methods

ZIMCombineMessageDetailQueriedCallback

public ZIMCombineMessageDetailQueriedCallback

Result callback for querying merge message details.

Parameters

Name	Type	Description
message	ZIMCombineMessage	Merge messages that carry a complete list of merge forward messages.
errorInfo	ZIMError	Error information, including error codes and error details.

Details

Result callback for querying merge message details.

ZIMConversationDeletedCallback

Methods

onConversationDeleted

public onConversationDeleted

Callback for conversation deletion.

Parameters

Name	Type	Description
conversationID	String	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorInfo	ZIMError	Delete the error code of the call. 0 means that the session was deleted successfully, non-0 means that the session was deleted failed. If the deletion of the call fails, the developer should check the official website error code document to query the solution.

Details

After a session is deleted, the deletion result is returned using this callback.

Use cases: You can do the deleted session logic in this callback.
When to call /Trigger: Description Triggered after the session was deleted.
Related APIs: [deleteConversation].

Available since: 2.0.0 and above.

ZIMConversationDraftSetCallback

Methods

onConversationDraftSet

public onConversationDraftSet

Sets the callback for the session draft.

Parameters

Name	Type	Description
conversationID	String	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorInfo	ZIMError	The error code for the set session draft. 0 indicates that the session draft is set successfully, and non-0 indicates that the session draft fails to be set. If the setup session draft fails, the developer should check the error code documentation on the official website for a solution.

Details

After setting the session draft, the result is returned through this callback.

Use cases: The logic after the session draft can be set up in this callback.
When to call /Trigger: Triggers after setting session draft.
Related APIs: [setConversationDraft].

Available since: 2.14.0 and above.

ZIMConversationListQueriedCallback

Methods

ZIMConversationListQueriedCallback

public ZIMConversationListQueriedCallback

Session list query callback.

Parameters

Name	Type	Description
conversationList	ArrayList<ZIMConversation>	Session list.
errorInfo	ZIMError	Error code for querying the conversation list. 0 means querying the session list succeeds, non-0 means querying the session list fails. If there is a failure to query the call list, the developer should check the official website error code document to query the solution.

Details

After the session list is queried, the callback is used to return the query result.

Use cases: The logic after the session list query can be done in this callback.
When to call /Trigger: Description Triggered when the session list is queried.
Related APIs: [queryConversationList].

Available since: 2.0.0 and above.

ZIMConversationMarkSetCallback

Methods

onConversationMarkSet

public onConversationMarkSet

Callback for conversation mark set.

Parameters

Name	Type	Description
failedConversationInfos	ArrayList<ZIMConversationBaseInfo>	Setting failed conversation brief information.
errorInfo	ZIMError	Conversation mark operation error codes. 0 represents a successful conversation mark operation, while non-zero values indicate a failed conversation mark operation. If a conversation mark operation fails, developers should refer to the official error code documentation for solution.

Details

The result of setting conversation marks.

When to

Trigger: Triggered after setting conversation marks.
Related APIs: [setConversationMark].

Available since: 2.17.0 and above.

ZIMConversationMessageReceiptReadSentCallback

Methods

onConversationMessageReceiptReadSent

public onConversationMessageReceiptReadSent

Callback interface for setting the read receipt conversation.

Parameters

Name	Type	Description
conversationID	String	ConversationID.
conversationType	ZIMConversationType	Conversation Type.
errorInfo	ZIMError	Set the error code of the receipt conversation read. 0 indicates that the setting is successful, and non-zero indicates that the setting fails. If the setting fails, the developer should check the official website error code document for solutions.

Details

Set the callback interface for the read receipt conversation.

Use cases: Developers can judge whether the sending is successful through [errorCode] in the callback.

Notification timing: When the developer calls the [sendConversationMessageReceiptRead] interface, this callback will be triggered.

Related APIs: The success or failure of the conversation read result set by [sendConversationMessageReceiptRead] will be notified through this callback.

Available since: 2.5.0 and above.

ZIMConversationMessagesAllDeletedCallback

Methods

onConversationMessagesAllDeleted

public onConversationMessagesAllDeleted

Deletes callbacks of all messages for all sessions.

Parameters

Name	Type	Description
errorInfo	ZIMError	Delete the error code of the message. 0 means the deletion of the message succeeded, non-0 means the deletion of the message failed. If the deletion message fails, the developer should check the official website error code document to query the solution.

Details

Supported versions: 2.14.0 and above.

Detail description: After all messages of all sessions are deleted, the callback returns the message deletion result.

Business scenario: The developer can judge whether the deletion is successful through the [errorCode] in the callback.

Notification timing: Triggered after calling the delete message interface [deleteAllConversationMessages].

Related interface: [deleteAllConversationMessages].

ZIMConversationNotificationStatusSetCallback

Methods

onConversationNotificationStatusSet

public onConversationNotificationStatusSet

Callback for conversation notification state settings.

Parameters

Name	Type	Description
conversationType	ZIMConversationType	Conversation type.
errorInfo	ZIMError	Set the error code for the callback notification state. 0 means setting the call back notification state successfully, non-0 means setting the call back notification state fails. If there is a failure to set the callback notification status, the developer should check the official website error code document to query the solution.

Details

This callback returns the result of group notification after the group notification status is set.

Use cases: You can do the logic after setting the group notification status in this callback.
When to call /Trigger: Triggered when the group notification status is set.
Related APIs: [setConversationNotificationStatus].

Available since: 2.0.0 and above.

ZIMConversationPinnedListQueriedCallback

Methods

ZIMConversationPinnedListQueriedCallback

public ZIMConversationPinnedListQueriedCallback

Callback for querying the pinned conversation list.

Parameters

Name	Type	Description
conversationList	ArrayList<ZIMConversation>	Conversation pinned list.
errorInfo	ZIMError	Error info for querying the conversation pinned list. 0 means querying the session list succeeds, non-0 means querying the session list fails. If there is a failure to query the call list, the developer should check the official website error code document to query the solution.

Details

After the conversation pinned list is queried, the callback is used to return the query result.

Use cases: The logic after the pinned conversation list query can be done in this callback.
When to call /Trigger: Triggered when the conversation pinned list is queried.

Available since: 2.8.0 and above.

ZIMConversationPinnedStateUpdatedCallback

Methods

ZIMConversationPinnedStateUpdatedCallback

public ZIMConversationPinnedStateUpdatedCallback

Callback for conversation pinned state updated.

Parameters

Name	Type	Description
conversationID	String	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorInfo	ZIMError	Error code for updating session pin status. 0 means updating the top status of the session was successful, and non-zero means updating the top status of the session failed. If there is a failure to update the top status of the session, the developer should check the error code document on the official website to find the solution.

Details

After updating the pinned status of the conversation, the query result is returned through this callback.

Use cases: The logic after updating the pinned status of the conversation can be done in this callback.
When to call /Trigger: Triggered after updating the pinned status of the conversation.

Available since: 2.8.0 and above.

ZIMConversationQueriedCallback

Methods

ZIMConversationQueriedCallback

public ZIMConversationQueriedCallback

Conversation query callback.

Parameters

Name	Type	Description
conversation	ZIMConversation	Conversation object.
errorInfo	ZIMError	The error info of the conversation query. 0 indicates that the query conversation is successful, and non-zero indicates that the query conversation fails. If the query conversation fails, the developer should check the official website error code document query solution.

Details

After the conversation is queried, the callback is used to return the query result.

Use cases: The logic after the conversation query can be done in this callback.
When to call /Trigger: Triggered when the conversation is queried.

Available since: 2.8.0 and above.

ZIMConversationTotalUnreadMessageCountClearedCallback

Methods

onConversationTotalUnreadMessageCountCleared

public onConversationTotalUnreadMessageCountCleared

Callback for sessions unread clearing.

Parameters

Name	Type	Description
errorInfo	ZIMError	Clear error codes for all unread sessions. 0 indicates that the number of unread sessions is successfully cleared. If the number is not 0, the number of unread sessions fails to be cleared. If you fail to clear the total number of unread sessions, the developer should check the error code documentation on the official website for a solution.

Details

This callback returns the result of clearing all sessions if the session is not read.

Use cases: You can do clear all unread logic in this callback.
When to call /Trigger: Triggered after clearing all sessions unread.
Related APIs: [clearConversationTotalUnreadMessageCount].

Available since: 2.12.0 and above.

ZIMConversationTotalUnreadMessageCountQueriedCallback

Methods

onConversationTotalUnreadMessageCountQueried

public onConversationTotalUnreadMessageCountQueried

Query conversation unread total count callback.

Parameters

Name	Type	Description
unreadMessageCount	int	Conversations unread message total count.
errorInfo	ZIMError	The error code for the query operation.

Trigger: Triggers after queried conversation total unread message count.

Available since: 2.17.0 and above.

When to

ZIMConversationUnreadMessageCountClearedCallback

Methods

onConversationUnreadMessageCountCleared

public onConversationUnreadMessageCountCleared

Callback for session unread clearing.

Parameters

Name	Type	Description
conversationID	String	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorInfo	ZIMError	Clears the error code for the number of unread calls. 0 means clearing the unread number of the session successfully, non-0 means the clearing the unread number of the session failed. If there is a failure to clear the number of unread calls, the developer should check the official website error code document to query the solution.

Details

This callback returns the result of clearing a session if the session is not read.

Use cases: You can do clear unread logic in this callback.
When to call /Trigger: Triggered after clearing session unread.
Related APIs: [clearConversationUnreadMessageCount].

Available since: 2.0.0 and above.

ZIMConversationsAllDeletedCallback

Methods

onConversationsAllDeleted

public onConversationsAllDeleted

Callback for conversations deletion.

Parameters

Name	Type	Description
errorInfo	ZIMError	Example Delete error codes for all sessions. 0 indicates that all sessions are deleted successfully. If the value is not 0, all sessions fail to be deleted. If all sessions fail to be deleted, the developer should check the error code documentation on the official website for a solution.

Details

After all sessions are deleted, the callback returns the deletion result.

Use cases: Logic after all sessions are deleted can be performed in the callback.
When to call /Trigger: Triggered after all sessions are deleted.
Related APIs: [deleteAllConversations].

Available since: 2.12.0 and above.

ZIMConversationsSearchedCallback

Methods

onConversationsSearched

public onConversationsSearched

Search for the return of local conversations results based on local messages.

Parameters

Name	Type	Description
conversationSearchInfoList	ArrayList<ZIMConversationSearchInfo>	List of searched conversation messages.
nextFlag	int	Pagination retrieval flag, anchor for searching the next page.
errorInfo	ZIMError	The error code of the search result. 0 means the search is successful, non-zero means the search failed. If the search fails, the developer should check the error code documentation on the official website for solutions.

Details

Search the results of local conversations based on local messages.

Use cases: After performing a local session message search operation, the success or failure can be known through this callback.

Related API: [searchLocalConversations], search for local conversations based on local messages.

ZIMDefines

Methods

ZIMUserCustomStatusUpdatedCallback

public ZIMUserCustomStatusUpdatedCallback

The callback of the custom status update.

Parameters

Name	Type	Description
errorInfo	ZIMError	The error message of the custom status update.
customStatus	String	custom status.

Details

The callback of the custom status update.

ZIMFileCacheClearedCallback

Methods

onFileCacheCleared

public onFileCacheCleared

Clears the callback of the local cache result.

Parameters

Name	Type	Description
errorInfo	ZIMError	Clear cached error codes. 0 indicates that the cache is successfully cleared. If the value is not 0, the cache fails to be cleared.

Related APIs: Run the [clearLocalFileCache] command to insert a local message. Whether the message is inserted successfully or not is notified by this callback.

ZIMFileCacheQueriedCallback

Methods

onFileCacheQueried

public onFileCacheQueried

Callback for querying the results of the local cache.

Parameters

Name	Type	Description
fileCacheInfo	ZIMFileCacheInfo	Cache information.
errorInfo	ZIMError	Example Query the cache error code. 0 indicates that the cache is successfully queried. If the value is not 0, the cache fails to be queried.

Related APIs: The local cache is queried using [queryLocalFileCache]. Success or failure is notified by this callback.

ZIMFriendAddedCallback

Methods

onFriendAddedCallback

public onFriendAddedCallback

Add a friend result callback.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code.

Details

The return of the result of adding a friend.

Use cases: The callback is used to determine whether a friend has been added.

Related API: [addFriend],Add friends.

ZIMFriendAliasUpdatedCallback

Methods

onFriendAliasUpdated

public onFriendAliasUpdated

Return results of updating friend alias.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code.

Details

Return results of updating friend alias.

Use cases: After updating friend alias, the success or failure can be known through this callback.

Related API: [updateFriendAlias], update friend alias.

ZIMFriendApplicationAcceptedCallback

Methods

onFriendApplicationAccepted

public onFriendApplicationAccepted

Accept the returned result of friend application.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code.

Details

Accept the returned result of friend application.

Use cases: After accepting a friend application, the success or failure can be known through this callback. Related API: [acceptFriendApplication], Accept friend application.

ZIMFriendApplicationListQueriedCallback

Methods

onFriendApplicationListQueried

public onFriendApplicationListQueried

The result of sending a friend application.

Parameters

Name	Type	Description
applicationList	ArrayList<ZIMFriendApplicationInfo>	Friend application information list.
nextFlag	int	The index of the current query anchor point.
errorInfo	ZIMError	Error code.

Details

The result of sending a friend application.

Use cases: After sending the friend application operation, the success can be known through the callback.

Related API: [sendFriendApplication],send friend application

ZIMFriendApplicationRejectedCallback

Methods

onFriendApplicationRejected

public onFriendApplicationRejected

Accept the returned result of friend application.

Parameters

Name	Type	Description
userInfo	ZIMUserInfo	Applicant user information.
errorInfo	ZIMError	Error code.

Details

Reject the returned result of friend application.

Use cases: After rejecting a friend application, the success or failure can be known through this callback. Related API: [rejectFriendApplication], Reject friend application.

ZIMFriendApplicationSentCallback

Methods

onFriendApplicationSentCallback

public onFriendApplicationSentCallback

The result of sending a friend application.

Parameters

Name	Type	Description
applicationInfo	ZIMFriendApplicationInfo	Friend application information.
errorInfo	ZIMError	Error code.

Details

The result of sending a friend application.

Use cases: After sending the friend application operation, the success can be known through the callback.

Related API: [sendFriendApplication],send friend application

ZIMFriendAttributesUpdatedCallback

Methods

onFriendAttributesUpdated

public onFriendAttributesUpdated

Return results of updating friend attributes.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code.

Details

Return results of updating friend attributes.

Use cases: After updating friend attributes, the success or failure can be known through this callback.

Related API: [updateFriendAttributes], update friend attributes.

ZIMFriendListQueriedCallback

Methods

onFriendListQueried

public onFriendListQueried

The returned result of querying the friends list.

Parameters

Name	Type	Description
friendList	ArrayList<ZIMFriendInfo>	The returned result of querying the friends list.
nextFlag	int	The index of the current query anchor point.
errorInfo	ZIMError	Error code.

Details

The returned result of querying the friends list.

Use cases: This callback will tell you if the operation to query the list of friends was successful or not.

Related API: [queryFriendList], Querying the friends list.

ZIMFriendsDeletedCallback

Methods

onFriendsDeletedCallback

public onFriendsDeletedCallback

Return results of deleting friends.

Parameters

Name	Type	Description
errorUserList	list<ZIMErrorUserInfo>	List of user IDs and reasons for failed deletion.
errorInfo	ZIMError	Error code.

Details

Return results of deleting friends.

Use cases: After deleting a friend, the success or failure can be known through this callback.

Related API: [deleteFriends], Delete friends in batches.

ZIMFriendsInfoQueriedCallback

Methods

onFriendsInfoQueried

public onFriendsInfoQueried

Return results of querying friend information in batches.

Parameters

Name	Type	Description
friendInfos	ArrayList<ZIMFriendInfo>	Friend information.
errorUserList	ArrayList<ZIMErrorUserInfo>	Query the user ID and reason for failed query.
errorInfo	ZIMError	Error code.

Details

Return results of querying friend information in batches.

Use cases: After querying friend information in batches, the success or failure can be known through this callback.

Related API: [queryFriendsInfo], Querying friend information in batches.

ZIMFriendsRelationCheckedCallback

Methods

onFriendsChecked

public onFriendsChecked

Check the friend relationship result.

Parameters

Name	Type	Description
errorUserList	ArrayList<ZIMErrorUserInfo>	Check the list of user IDs and reasons for friend relationship failure.
relationInfos	ArrayList<ZIMFriendRelationInfo>	Friend relationship information list.
errorInfo	ZIMError	Error code.

Details

The result of sending a friend application.

Use cases: After checking the friend relationship, the success or failure can be known through this callback.

Related API: [checkFriendsRelation], check the friend relationship.

ZIMFriendsSearchedCallback

Methods

onFriendsSearched

public onFriendsSearched

Search results returned by local friends.

Parameters

Name	Type	Description
friendInfos	ArrayList<ZIMFriendInfo>	Friend application information list.
nextFlag	int	The index of the current query anchor point.
errorInfo	ZIMError	Error code.

Details

Search results returned by local friends.

Use cases: This callback will tell you if the operation to query the list of friend application was successful or not.

Related API: [searchLocalFriends], Search results returned by local friends.

ZIMGroupAliasUpdatedCallback

Methods

onGroupAliasUpdated

public onGroupAliasUpdated

Returns the result of the group alias update.

Parameters

Name	Type	Description
groupID	String	ID of the group.
groupAlias	String	Alias of the group.
errorInfo	ZIMError	Update the error code of the group alias. 0 means the update succeeds, non-0 means the update fails. If there is a failure to update, please check the official error code document for the solution.

Details

Return result of group alias update operation.

Use cases: After a group alias update operation is performed, the success or failure can be determined by this callback.

When to

Trigger: The result of the group alias update operation is returned.
Related APIs: [updateGroupAlias], the group alias is updated.

ZIMGroupApplicationListQueriedCallback

Methods

onGroupApplicationListQueried

public onGroupApplicationListQueried

Query the callback of group application list.

Parameters

Name	Type	Description
applicationList	ArrayList<ZIMGroupApplicationInfo>	Group application list.
nextFlag	int	The next flag.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return of group application list query results..

Use cases: After querying the group application list, the success or failure can be determined by this callback.
Related APIs: [queryGroupApplicationList], query group application list.

ZIMGroupAttributesOperatedCallback

Methods

onGroupAttributesOperated

public onGroupAttributesOperated

Returns the result of a group attribute operation.

Parameters

Name	Type	Description
groupID	String	groupID.
errorKeys	ArrayList<String>	errorKeys.
errorInfo	ZIMError	Set the error code of the group attribute. 0 means the group attribute setting is successful, non-0 means the group attribute setting fails. If there is a failure to set the group properties, the developer should check the official website error code documentation for solutions.

Details

Returns the result of the group property operation.

Use cases: This callback tells you whether a custom property operation is successful.
When to call /Trigger: The result of the group property operation is returned.
Related APIs: [setGroupAttributes], set the room properties. [deleteGroupAttributes], delete the room attribute.

ZIMGroupAttributesQueriedCallback

Methods

onGroupAttributesQueried

public onGroupAttributesQueried

The return of query group attribute results.

Parameters

Name	Type	Description
groupID	String	Group ID.
groupAttributes	HashMap<String, String>	groupAttributes.
errorInfo	ZIMError	Error code for querying group attributes. 0 means the query group attribute succeeds, non-0 means the query group attribute fails. If there is a failure to query group properties, the developer should check the official website for the error code document query solution.

Details

Returns the result of group attribute query.

Use cases: This callback is used to determine the success of a custom property query.
When to call /Trigger: Group attribute query results are returned.
Related APIs: [queryGroupAttributes], query room attributes.

ZIMGroupAvatarUrlUpdatedCallback

Methods

ZIMGroupAvatarUrlUpdatedCallback

public ZIMGroupAvatarUrlUpdatedCallback

Returns the result of the group avatar URL update.

Parameters

Name	Type	Description
groupID	String	Group ID.
groupAvatarUrl	String	Group avatar URL.
errorInfo	ZIMError	Update the error code of the group avatar url. 0 means the update succeeds, non-0 means the update of the group name fails. If there is a failure, the developer should check the official website error code document to query the solution.

When to call /Trigger: The result will be returned after the group avatar URL update operation is complete.
Related APIs: [updateGroupAvatarUrl].

ZIMGroupBeInviteModeUpdatedCallback

Methods

onGroupBeInviteModeUpdated

public onGroupBeInviteModeUpdated

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	String	Group ID.
mode	ZIMGroupBeInviteMode	Group verification mode.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Group verification mode returns the result of the update operation.

Use cases: After a group verification mode update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The group verification mode is returned after the update operation is complete.
Related APIs: [updateGroupBeInviteMode], the group verification mode is updated.

ZIMGroupCreatedCallback

Methods

onGroupCreated

public onGroupCreated

Returns the result of creating a group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	groupInfo.
userList	ArrayList<ZIMGroupMemberInfo>	user list.
errorUserList	ArrayList<ZIMErrorUserInfo>	errorUserList.
errorInfo	ZIMError	Error code for group creation. 0 means the group creation is successful, non-0 means the group creation fails. If there is a failure to create a group, the developer should check the official website error code document to query the solution.

Details

Returns the result of the group creation operation.

Use cases: After a group creation operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The result is returned after the group creation operation is complete.

Related API: [createGroup] : creates a group.

ZIMGroupDismissedCallback

Methods

onGroupDismissed

public onGroupDismissed

Returns the result of disbanding the group.

Parameters

Name	Type	Description
groupID	String	Group ID.
errorInfo	ZIMError	The error code for disbanding the group. 0 means that the group is successfully disbanded, and non-0 means that the group failed to be disbanded. If there is a failure to dissolve the group, the developer should check the official website error code document to find the solution.

Details

Returns the result of the group dismiss operation.

Use cases: After a group disband operation is performed, the success of the operation can be determined by the callback.
When to call /Trigger: The result of the group disband operation is returned.

Related API: [createGroup],creates a group. [dismissGroup],dismissGroup.

ZIMGroupInfoQueriedCallback

Methods

onGroupInfoQueried

public onGroupInfoQueried

Returns the result of querying group information.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	groupInfo.
errorInfo	ZIMError	Error code for querying group information. 0 means the query group information is successful, non-0 means the query group information fails. If there is a failure to query group information, the developer should check the official website for the error code document query solution.

Details

Returns the result of the group dismiss operation.

Use cases: After a group disband operation is performed, the success of the operation can be determined by the callback.
When to call /Trigger: The result of the group disband operation is returned.
Related APIs: [createGroup],creates a group. [dismissGroup],dismissGroup.

ZIMGroupInviteApplicationAcceptedCallback

Methods

onGroupInviteApplicationAccepted

public onGroupInviteApplicationAccepted

The return of the results of the group invite application accept.

Parameters

Name	Type	Description
groupID	String	Group ID.
inviterUserID	String	Inviter user ID.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return the operation result of accept the group invite application.

Use cases: After accept the invite application to the group, the success or failure can be determined by this callback.
Related APIs: [acceptGroupInviteApplication], the group invite application accept.

ZIMGroupInviteApplicationRejectedCallback

Methods

onGroupInviteApplicationRejected

public onGroupInviteApplicationRejected

The return of the results of the group invite application accept.

Parameters

Name	Type	Description
groupID	String	Group ID.
inviterUserID	String	Inviter user ID.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return the operation result of reject the group invite application.

Use cases: After reject the invite application to the group, the success or failure can be determined by this callback.
Related APIs: [rejectGroupInviteApplication], the group invite application reject.

ZIMGroupInviteApplicationsSentCallback

Methods

onGroupInviteApplicationsSent

public onGroupInviteApplicationsSent

The return of the results of the group invite application sent.

Parameters

Name	Type	Description
groupID	String	Group ID.
errorUserList	ArrayList<ZIMErrorUserInfo>	List of users whose invitation failed.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return the operation result of sent the group invite application.

Use cases: After sent the invite application to the group, the success or failure can be determined by this callback.
Related APIs: [sendGroupInviteApplications], the group invite application sent.

ZIMGroupInviteModeUpdatedCallback

Methods

onGroupInviteModeUpdated

public onGroupInviteModeUpdated

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	String	Group ID.
mode	ZIMGroupInviteMode	Group verification mode.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Group verification mode returns the result of the update operation.

Use cases: After a group verification mode update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The group verification mode is returned after the update operation is complete.
Related APIs: [updateGroupInviteMode], the group verification mode is updated.

ZIMGroupJoinApplicationAcceptedCallback

Methods

onGroupJoinApplicationAccepted

public onGroupJoinApplicationAccepted

The return of the results of the group join application accept.

Parameters

Name	Type	Description
groupID	String	Group ID.
userID	String	Applicant user ID.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return the operation result of accept the group join application.

Use cases: After accept the application to join the group, the success or failure can be determined by this callback.
Related APIs: [acceptGroupJoinApplication], the group join application accept.

ZIMGroupJoinApplicationRejectedCallback

Methods

onGroupJoinApplicationRejected

public onGroupJoinApplicationRejected

The return of the results of the group join application reject.

Parameters

Name	Type	Description
groupID	String	Group ID.
userID	String	Applicant user ID.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return the operation result of reject the group join application.

Use cases: After reject the application to join the group, the success or failure can be determined by this callback.
Related APIs: [rejectGroupJoinApplication], the group join application reject.

ZIMGroupJoinApplicationSentCallback

Methods

onGroupJoinApplicationSent

public onGroupJoinApplicationSent

The return of the results of the group join application sent.

Parameters

Name	Type	Description
groupID	String	Group ID.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Return the operation result of sent the group join application.

Use cases: After sent the application to join the group, the success or failure can be determined by this callback.
Related APIs: [sendGroupJoinApplication], the group join application sent.

ZIMGroupJoinModeUpdatedCallback

Methods

onGroupJoinModeUpdated

public onGroupJoinModeUpdated

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	String	Group ID.
mode	ZIMGroupJoinMode	Group verification mode.
errorInfo	ZIMError	Error code for update operation. 0 means the update is successful, non-0 means the update fails.

Details

Group verification mode returns the result of the update operation.

Use cases: After a group verification mode update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The group verification mode is returned after the update operation is complete.
Related APIs: [updateGroupJoinMode], the group verification mode is updated.

ZIMGroupJoinedCallback

Methods

onGroupJoined

public onGroupJoined

Returns the result of joining the group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo*	groupInfo.
errorInfo	ZIMError	Error code to join the group. 0 means joining the group successfully, non-0 means joining the group failed. If there is a failure to join the group, the developer should check the official website error code document to query the solution.

Details

Returns the result of the group join operation.

Use cases: After a group join operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The result of the group join operation is returned.

Related API:[joinGroup] : joins a group. [leaveGroup], leave the group.

ZIMGroupLeftCallback

Methods

onGroupLeft

public onGroupLeft

Return of the result of leaving the group.

Parameters

Name	Type	Description
groupID	String	Group ID.
errorInfo	ZIMError	Error code for leaving the group. 0 means leaving the group successfully, non-0 means leaving the group failed. If there is a failure to leave the group, the developer should check the official website error code document to query the solution.

Details

Returns the result of the group departure operation.

Use cases: After a group exit operation is performed, the success or failure can be determined by the callback.
When to call /Trigger: The result of the group departure operation is returned.

Related API:[leaveGroup], leave the group. [joinGroup], enter the group.

ZIMGroupListQueriedCallback

Methods

onGroupListQueried

public onGroupListQueried

Returns the results of the query group list.

Parameters

Name	Type	Description
groupList	ArrayList<ZIMGroupInfo>	groupList.
errorInfo	ZIMError	Query the error code of the group list. 0 means the query group list succeeds, non-0 means the query group list fails. If there is a failure to query the group list, the developer should check the official website for the error code document query solution.

Details

Returns the group list query result.

Use cases: The success of a group list query can be determined by this callback.
When to call /Trigger: The result of the group list query is returned.
Related APIs: [queryGroupList] to query the group list.

ZIMGroupMemberCountQueriedCallback

Methods

onGroupMemberCountQueried

public onGroupMemberCountQueried

Returns the result of querying the group member count.

Parameters

Name	Type	Description
groupID	String	user count.
count	int	nextFlag.
errorInfo	ZIMError	Error code for querying the group member count. 0 means that the query of the group member count succeeds, and non-0 means that the query of the group member count fails. If there is a failure to query the group member count, the developer should check the official website for the error code document query solution.

Details

Returns the result of querying the group member count.

Use cases: After querying the group member count, you can use the callback to determine whether the query is successful.
When to call /Trigger: The result is displayed after the group member count is queried.

Related API:[queryGroupMemberCount], query the group member count.

ZIMGroupMemberInfoQueriedCallback

Methods

onGroupMemberInfoQueried

public onGroupMemberInfoQueried

Returns the result of the group member query.

Parameters

Name	Type	Description
groupID	String	Group ID.
userInfo	ZIMGroupMemberInfo	Group member information.
errorInfo	ZIMError	Query the error code of group members. 0 means querying group members successfully, non-0 means querying group members failed. If there is a failure to query group members, the developer should check the official website for the error code document query solution.

Details

Return of group member query results.

Use cases: After a group member query is performed, the success or failure can be determined by this callback.
When to call /Trigger: Group member query results are returned.
Related APIs: [queryGroupMemberInfo], queryGroupMemberInfo.

ZIMGroupMemberKickedoutCallback

Methods

ZIMGroupMemberKickedCallback

public ZIMGroupMemberKickedCallback

Returns the result of kicking out a group member.

Parameters

Name	Type	Description
kickedUserIDList	ArrayList<String>	List of kicked members.
errorUserList	ArrayList<ZIMErrorUserInfo>	Bad user list.
errorInfo	ZIMError	Error code for kicking out a group member. 0 means that the group member was successfully kicked out, and non-0 means that the group member failed to be kicked out. If a group member is kicked out, the developer should check the official website error code document to query the solution.

Details

Returns the result of the kick out group member operation.

Use cases: After a group member is kicked out, the success or failure can be determined by the callback.
When to call /Trigger: The result is returned after the group member is kicked out.

Related API:[kickGroupMembers] Kick out group members.

ZIMGroupMemberListQueriedCallback

Methods

onGroupMemberListQueried

public onGroupMemberListQueried

Returns the result of querying the group member list.

Parameters

Name	Type	Description
userList	ArrayList<ZIMGroupMemberInfo>	user list.
nextFlag	int	nextFlag.
errorInfo	ZIMError	Error code for querying the group member list. 0 means that the query of the group member list succeeds, and non-0 means that the query of the group member list fails. If there is a failure to query the group member list, the developer should check the official website for the error code document query solution.

Details

Returns the result of querying the group member list.

Use cases: After querying the group member list, you can use the callback to determine whether the query is successful.
When to call /Trigger: The result is displayed after the group member list is queried.
Related APIs: [queryGroupMemberList], query the group member list.

ZIMGroupMemberMutedListQueriedCallback

Methods

onGroupMemberListQueried

public onGroupMemberListQueried

Returns the result of querying the group muted member list.

Parameters

Name	Type	Description
groupID	String	Group ID for modifying the mute status of group members.
nextFlag	long	nextFlag.
userList	ArrayList<ZIMGroupMemberInfo>	user list.
errorInfo	ZIMError	Error code for querying the group muted member list. 0 means that the query of the group muted member list succeeds, and non-0 means that the query of the group muted member list fails. If there is a failure to query the group muted member list, the developer should check the official website for the error code document query solution.

Details

Returns the result of querying the group muted member list.

Use cases: After querying the group muted member list, you can use the callback to determine whether the query is successful.

When to trigger: The result is displayed after the group muted member list is queried.

Related APIs: [queryGroupMemberMutedList], query the group muted member list.

ZIMGroupMemberNicknameUpdatedCallback

Methods

onGroupMemberNicknameUpdated

public onGroupMemberNicknameUpdated

Returns the result of the group member's nickname update.

Parameters

Name	Type	Description
groupID	String	Group ID.
forUserID	String	userID.
nickname	String	userNickname.
errorInfo	ZIMError	Set the error code of the group member's nickname. 0 means setting the group member's nickname successfully, non-0 means setting the group member's nickname failed. If there is a failure to set the group member's nickname, the developer should check the official website error code document to query the solution.

Details

Return result of group member nickname update operation.

Use cases: After a group member nickname update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The result of the group member nickname update operation is returned.
Related APIs: [setGroupMemberNickname], the nickname of the group member is updated.

ZIMGroupMemberRoleUpdatedCallback

Methods

onGroupMemberRoleUpdated

public onGroupMemberRoleUpdated

Returns the result of the member role update.

Parameters

Name	Type	Description
groupID	String	Group ID.
forUserID	String	userID.
role	int	role.
errorInfo	ZIMError	Error code for group member role update. 0 means the group member role update is successful, non-0 means the group member role update fails. If the group member role update fails, the developer should check the official website error code document to query the solution.

Details

Return of the result of the member role update operation.

Use cases: After a member role update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The result of the member role update operation is returned.
Related APIs: [setGroupMemberRole], the member role is updated.

ZIMGroupMembersMutedCallback

Methods

onGroupMembersMuted

public onGroupMembersMuted

Returns the result of the group members mute info update.

Parameters

Name	Type	Description
groupID	String	groupID.
isMute	boolean	Group members mute or lift group members mute.
duration	int	Duration of group member mute, in seconds.
mutedUserIDs	ArrayList<String>	List of group member IDs successfully modified to mute status.
errorUserList	ArrayList<ZIMErrorUserInfo>	List of group members failed to modify to mute status.
errorInfo	ZIMError	Update the error code of the group members mute info. 0 means the update of the group members mute info succeeds, non-0 means the update of the group members mute info fails. If there is a failure to update the group members mute info, the developer should check the official website error code document to query the solution.

Details

Return result of group members mute info update operation.

Use cases: After a group members mute info update operation is performed, the success or failure can be determined by this callback.

When to

Trigger: The result of the group members mute info update operation is returned.
Related APIs: [muteGroupMembers], the group members mute info is updated.

ZIMGroupMembersSearchedCallback

Methods

onGroupMembersSearched

public onGroupMembersSearched

Returns the result of search a group members.

Parameters

Name	Type	Description
groupID	String	Group ID.
userList	ArrayList<ZIMGroupMemberInfo>	The search result list of group members.
nextFlag	int	Pagination retrieval flag, anchor for searching the next page.
errorInfo	ZIMError	Error codes for searching group members. 0 represents a successful search for group members, and non-zero indicates a failed search for group members. If a search for group members fails, developers should refer to the official website's error code documentation for solutions.

Details

Returns the result of a group member search operation.

Use cases: After performing a group member search operation, whether it is successful or not can be known through this callback.

Related API: [searchLocalGroupMembers], search for group members.

ZIMGroupMessageReceiptMemberListQueriedCallback

Methods

onGroupMessageReceiptMemberListQueried

public onGroupMessageReceiptMemberListQueried

Callback interface for querying the specific read/unread member list of group receipt messages.

Parameters

Name	Type	Description
groupID	String	Group ID.
userList	ArrayList<ZIMGroupMemberInfo>	Query the list of successful group users.
nextFlag	int	Query the flag corresponding to the next page, which is used for the next flag parameter of [ZIMGroupMessageReceiptMemberQueryConfig].
errorInfo	ZIMError	Set the error code returned by querying the group member list. 0 means the query is successful, and non-zero means the query failed. If the query fails, the developer should check the official website error code document for solutions.

Details

The callback interface for querying the specific read/unread member list of the group receipt message.

Use cases: Developers can judge whether the sending is successful through [errorCode] in the callback.

Notification timing: When the developer calls the [queryGroupMessageReceiptReadMemberList] / [queryGroupMessageReceiptUnreadMemberList] interface, this callback will be triggered.

Available since: 2.5.0 and above.

ZIMGroupMutedCallback

Methods

onGroupMuted

public onGroupMuted

Returns the result of the group mute info update.

Parameters

Name	Type	Description
groupID	String	groupID.
isMute	boolean	Group mute or lift group mute.
mutedInfo	ZIMGroupMuteInfo	Group mute info.
errorInfo	ZIMError	Update the error code of the group mute info. 0 means the update of the group mute info succeeds, non-0 means the update of the group mute info fails. If there is a failure to update the group mute info, the developer should check the official website error code document to query the solution.

Details

Return result of group mute info update operation.

Use cases: After a group mute info update operation is performed, the success or failure can be determined by this callback.

When to

Trigger: The result of the group mute info update operation is returned.
Related APIs: [muteGroup], the group mute info is updated.

ZIMGroupNameUpdatedCallback

Methods

onGroupNameUpdated

public onGroupNameUpdated

Returns the result of the group name update.

Parameters

Name	Type	Description
groupID	String	groupID.
groupName	String	groupName.
errorInfo	ZIMError	Update the error code of the group name. 0 means the update of the group name succeeds, non-0 means the update of the group name fails. If there is a failure to update the group name, the developer should check the official website error code document to query the solution.

Details

Return result of group name update operation.

Use cases: After a group name update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The result of the group name update operation is returned.
Related APIs: [updateGroupName], the group name is updated.

ZIMGroupNoticeUpdatedCallback

Methods

onGroupNoticeUpdated

public onGroupNoticeUpdated

The return of the results of the group announcement update.

Parameters

Name	Type	Description
groupNotice	String	Group announcement.
errorInfo	ZIMError	Update the error code of the group announcement. 0 means the update group announcement is successful, non-0 means the update group announcement fails. If the update group announcement fails, the developer should check the official website error code document to query the solution.

Details

Group announcement returns the result of the update operation.

Use cases: After a group bulletin update operation is performed, the success or failure can be determined by this callback.
When to call /Trigger: The group bulletin is returned after the update operation is complete.
Related APIs: [updateGroupNotice], the group notice is updated.

ZIMGroupOwnerTransferredCallback

Methods

onGroupOwnerTransferred

public onGroupOwnerTransferred

Returns the result of the group owner assignment.

Parameters

Name	Type	Description
groupID	String	groupID.
toUserID	String	userID.
errorInfo	ZIMError	The error code of the transfer group owner. 0 means the transfer of the group owner is successful, non-0 means the transfer of the group owner failed. If the transfer of the group owner fails, the developer should check the official website error code document to query the solution.

Details

Returns the result of the group master transfer operation.

Use cases: After a group master transfer operation is performed, the success of the operation can be determined by this callback.
When to call /Trigger: The result of the group master transfer operation is returned.

Related API:[transferGroupOwner], group master transfer.

ZIMGroupUsersInvitedCallback

Methods

onGroupUsersInvited

public onGroupUsersInvited

The result of the user being invited to the group is returned.

Parameters

Name	Type	Description
groupID	String	Group ID.
userList	ArrayList<ZIMGroupMemberInfo>	user list.
errorUserList	ArrayList<ZIMErrorUserInfo>	List of users who failed to invite.
errorInfo	ZIMError	Error code for inviting users to join the group. 0 means to invite the user to join the group, non-0 means that the invitation to join the group fails. If there is a failure to invite users to join the group, the developer should check the official website error code document to query the solution.

Details

Returns the result of inviting the user to join the group.

Use cases: After a user is invited to a group, the success or failure can be determined by the callback.
When to call /Trigger: Results are returned after the user is invited to the group.

Related API:[inviteUsersIntoGroup] invites users to join the group.

ZIMGroupsSearchedCallback

Methods

onGroupsSearched

public onGroupsSearched

Returns the result of search a group.

Parameters

Name	Type	Description
groupSearchInfoList	ArrayList<ZIMGroupSearchInfo>	groupInfo.
nextFlag	int	Pagination retrieval flag, anchor for searching the next page.
errorInfo	ZIMError	Error codes for group search. 0 represents a successful group search, and non-zero indicates a failed group search. If a group search fails, developers should refer to the official website's error code documentation for solutions.

Details

Returns the result of a group search operation.

Use cases: After performing a group search operation, whether it is successful or not can be known through this callback.

Related API: [searchLocalGroups], search for groups.

ZIMLogUploadedCallback

Methods

onLogUploaded

public onLogUploaded

Callback of the log upload result.

Parameters

Name	Type	Description
errorInfo	ZIMError

Use cases: Developers can use the [errorCode] in the callback to determine whether the upload is successful.

Notification timing: When the developer calls the [uploadLog] interface, the callback will be triggered.

Related interface: call log upload via [uploadLog], success or failure will be notified through this callback.

ZIMLoggedInCallback

Methods

onLoggedIn

public onLoggedIn

Callback of the login result.

Parameters

Name	Type	Description
errorInfo	ZIMError

Use cases: Developers can use the [errorCode] in the callback to determine whether the login is successful.

Notification timing: When the developer calls the [login] interface, the callback will be triggered.

ZIMMediaDownloadedCallback

Callback interfaces for downloading media messages

Details

Callback interfaces for downloading media messages

Declared in callback/ZIMMediaDownloadedCallback.java

Methods

onMediaDownloaded

public void onMediaDownloaded(ZIMMessage message, ZIMError errorInfo)

The result callback of the download completion of the media message.

Declared in callback/ZIMMediaDownloadedCallback.java

Parameters

Name	Type	Description
message	ZIMMessage	Description: The sent message object, from which parameters such as messageID can be obtained. If the sending fails, the messageID parameter in the message will be an empty string.
errorInfo	ZIMError	Description: The error code of the sent message. 0 means sending the message successfully, non-0 means sending the message failed. If there is a failure to send a message, the developer should check the official website error code document to query the solution.

Related APIs: Download media messages through [downloadMediaFile], and it will be notified through this callback whether it is successful or not.

onMediaDownloadingProgress

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

Progress callback for downloading media messages.

Declared in callback/ZIMMediaDownloadedCallback.java

Parameters

Name	Type	Description
message	ZIMMessage	Description: The message object for the current file download.
currentFileSize	long	Description: The current progress, that is, the real-time size of the current file download.
totalFileSize	long	Description: Total progress, which is the total size of the current file.

Related APIs: Through [downloadMediaFile], the download progress will be notified through this callback.

ZIMMediaMessageSentCallback

Callback interface for sending media messages.

Details

Callback interface for sending media messages.

Declared in ZIM.java

Methods

onMessageSent

public void onMessageSent(ZIMMediaMessage message, ZIMError errorInfo)

Callback of the result of sending the message.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMediaMessage	Description: ZIMMediaMessage Object.
errorInfo	ZIMError

Details

Supported Versions: 1.1.0 and above.

Detail description: The callback for the result of sending the message.

Business scenario: The developer can judge whether the sending is successful through the [errorCode] in the callback.

Notification timing: This callback is triggered when the developer calls the [sendMessage] interfaces.

Related interfaces: Send messages through [sendMessage] , and the success of sending messages will be notified through this callback.

onMessageAttached

public void onMessageAttached(ZIMMediaMessage message)

The incoming message object is given a localMessgeID and returned.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMediaMessage	Description: ZIMMediaMessage object with the same address as the object passed in.

Details

Supported version: 2.4 and later.

The incoming message object is given a localMessgeID and returned.

Service scenario: Before a message is successfully sent, it can correspond to its localMessageID to implement loading before sending.

Notification time: Triggered after the message is sent and before the message is successfully sent.

onMediaUploadingProgress

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

Returns the callback method for uploading progress.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMediaMessage	Description: ZIMMediaMessage Object.
currentFileSize	long	Size of the uploaded file.
totalFileSize	long	Total file size.

Available since: Returns the callback method for uploading progress.

ZIMMessageDeletedCallback

Methods

onMessageDeleted

public onMessageDeleted

A callback to delete a message.

Parameters

Name	Type	Description
conversationID	String	Conversation ID
conversationType	ZIMConversationType	Conversation Type
errorInfo	ZIMError	Delete the error code of the message. 0 means the deletion of the message succeeded, non-0 means the deletion of the message failed. If the deletion message fails, the developer should check the official website error code document to query the solution.

Details

Supported versions: 2.0.0 and above.

Detail description: After the message is deleted, the result of message deletion is returned through this callback.

Business scenario: The developer can judge whether the deletion is successful through the [errorCode] in the callback.

Notification timing: Triggered after calling the delete message interface [deleteMessage].

Related interface: [deleteMessage].

ZIMMessageExportedCallback

Methods

onMessageExported

public onMessageExported

Callback of the result of exporting the message.

Parameters

Name	Type	Description
errorInfo	ZIMError	The error code for exporting the message. 0 indicates that the message is successfully exported. If the message is not 0, the message fails to be exported.

Related APIs: Export messages by [exportLocalMessages], success or failure is notified by this callback.

ZIMMessageExportingProgress

Methods

onMessageExportingProgress

public onMessageExportingProgress

Progress callback of the exported message.

Parameters

Name	Type	Description
exportedMessageCount	long	Current progress, that is, the number of exported messages.
totalMessageCount	long	Total progress: The total number of exported messages.

Related APIs: With [exportLocalMessages], the exported progress is notified by this callback.

ZIMMessageImportedCallback

Methods

onMessageImported

public onMessageImported

Callback of the result of importing the message.

Parameters

Name	Type	Description
errorInfo	ZIMError	The error code for importing the message. 0 indicates that the message is successfully imported. If the message is not 0, the message fails to be imported.

Related APIs: Import messages by [importLocalMessages], success or failure is notified by this callback.

ZIMMessageImportingProgress

Methods

onMessageImportingProgress

public onMessageImportingProgress

Progress callback of the imported message.

Parameters

Name	Type	Description
importedMessageCount	long	Current progress, that is, the number of imported messages.
totalMessageCount	long	Total progress: The total number of imported messages.

Related APIs: With [importLocalMessages], the imported progress is notified by this callback.

ZIMMessageInsertedCallback

Methods

ZIMMessageInsertedCallback

public ZIMMessageInsertedCallback

Callback of the result of inserting the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Insert the error code for the local message. 0 means inserting the message successfully, non-0 means inserting the message failed. If there is a failure to insert the message, the developer should check the https://doc-zh.zego.im/article/11606 to query the solution.

Related APIs: Insert local messages through [insertMessageToLocalDB], and the success or failure will be notified through this callback.

ZIMMessageLocalExtendedDataUpdatedCallback

Methods

onMessageExtendedDataUpdated

public onMessageExtendedDataUpdated

Callback for updating message local extension fields.

Parameters

Name	Type	Description
message	ZIMMessage	Updated of the message.
errorInfo	ZIMError	Error code.

Use cases: Developers can determine whether the operation is successful through the [errorCode] in this callback.

Notification timing: This callback is triggered when developers call the [updateMessageLocalExtendedData] interface.

ZIMMessagePinnedCallback

Methods

ZIMMessagePinnedCallback

public ZIMMessagePinnedCallback

Callback of the result of the message to be pinned or unpinned.

Parameters

Name	Type	Description
handle	zim_handle	The handle of the instance.
errorInfo	ZIMError	The error code of the pinned or unpinned message.
sequence	zim_sequence	Context that identifies which invocation triggered this callback.

Details

Supported versions: 2.25.0 and above.

Detailed description: The callback for the result of pinning or unpinning a message.

Business scenario: Developers can determine whether the operation was successful via the [errorCode] in this callback.

Notification timing: This callback is triggered when the developer calls the [pinMessage] interface.

ZIMMessageQueriedCallback

Methods

onMessageQueried

public onMessageQueried

The developer uses this callback to get a list of queried messages, which can be used to display historical messages.

Parameters

Name	Type	Description
conversationID	String	ConversationID.
conversationType	ZIMConversationType	Conversation Type.
messageList	ArrayList<ZIMMessage>	The message list of the query result.
errorInfo	ZIMError	The error code of the query message. 0 means the query message is successful, non-0 means the query message fails. If the query message fails, the developer should check the official website error code document to query the solution.

Details

Callback result of query message list.

Use cases: Through this callback, developers can obtain the list of queried messages and display historical messages.

Notification timing: After calling queryHistoryMessage, the list of queried messages is notified through this callback.

Related APIs: Use [queryPeerMessage] to query historical messages. The queried message list is notified through this callback.

Available since: 2.0.0 or later.

ZIMPinnedMessageListQueriedCallback

public ZIMPinnedMessageListQueriedCallback

The developer uses this callback to get a list of queried pinned messages, which can be used to display pinned messages.

Parameters

Name	Type	Description
messageList	ArrayList<ZIMMessage>	The message list of the query result.
errorInfo	ZIMError	The error code of the query message. 0 means the query message is successful, non-0 means the query message fails. If the query message fails, the developer should check the official website error code document to query the solution.

Related APIs: The [queryPinnedMessageList] interface is used to query the list of pinned messages. The queried message list is notified through this callback.

ZIMMessageReactionAddedCallback

Methods

onMessageReactionAdded

public onMessageReactionAdded

The addition of return for message reactions.

Parameters

Name	Type	Description
reaction	ZIMMessageReaction	reaction data.
errorInfo	ZIMError	The error code of the message reaction addition. 0 represents the operation success, non-0 represents the operation failure, please refer to the Error codes doc (https://docs.zegocloud.com/article/13791) for solutions.

Trigger: After reacting to a message.

Related API: [addMessageReaction]

ZIMMessageReactionDeletedCallback

Methods

onMessageReactionDeleted

public onMessageReactionDeleted

The delete of return for message reactions.

Parameters

Name	Type	Description
reaction	ZIMMessageReaction	reaction data.
errorInfo	ZIMError	The error code of the message reaction addition. 0 represents the operation success, non-0 represents the operation failure, please refer to the Error codes doc (https://docs.zegocloud.com/article/13791) for solutions.

Trigger: After deleting a message reaction.

Related API: [deleteMessageReaction]

ZIMMessageReactionUserListQueriedCallback

Methods

onMessageReactionUserListQueried

public onMessageReactionUserListQueried

The return of the query for the details of the reaction.

Parameters

Name	Type	Description
message	ZIMMessage	message.
userList	ArrayList<ZIMMessageReactionUserInfo>	Query the detailed list of users' reactions.
reactionType	String	Types of reaction.
nextFlag	long	Query anchor, used for the next page to be passed to [ZIMMessageReactionUserQueryConfig] for querying.
totalCount	int	The total number of users who reaction.
error	ZIMError	错误信息

Trigger: After querying the user info related to a message reaction.

Related API: [queryMessageReactionUserList]

ZIMMessageReceiptsInfoQueriedCallback

Methods

onMessageReceiptsInfoQueried

public onMessageReceiptsInfoQueried

Callback interface for query receipt message read.

Parameters

Name	Type	Description
infos	ArrayList<ZIMMessageReceiptInfo>	Query receipt information.
errorMessageIDs	ArrayList<Long>	Query the wrong message ID of the message receipt information.
errorInfo	ZIMError	Query the error code of the message receipt. 0 means the query is successful, and non-zero means the query failed. If the query fails, the developer should check the official website error code document for solutions.

Details

Callback interface for querying receipt message information.

Use cases: Developers can judge whether the sending is successful through [errorCode] in the callback.

Notification timing: When the developer calls the [queryMessageReceiptsInfo] interface, this callback will be triggered.

Related APIs: through [queryMessageReceiptsInfo], whether the result of querying the receipt information is successful or not will be notified through this callback.

Available since: 2.5.0 and above.

ZIMMessageReceiptsReadSentCallback

Methods

onMessageReceiptsReadSent

public onMessageReceiptsReadSent

Callback interface for setting the read receipt message.

Parameters

Name	Type	Description
conversationID	String	ConversationID.
conversationType	ZIMConversationType	Conversation Type.
errorMessageIDs	ArrayList<Long>	Set the message ID corresponding to the message receipt failure.
errorInfo	ZIMError	Set the error code of the receipt message read. 0 indicates that the setting is successful, and non-zero indicates that the setting fails. If the setting fails, the developer should check the official website error code document for solutions.

Details

Set the callback interface for the read receipt message.

Use cases: Developers can judge whether the setting is successful through [errorCode] in the callback.

Notification timing: When the developer calls the [sendMessageReceiptsRead] interface, this callback will be triggered.

Related APIs: The success or failure of the message read result set by [sendMessageReceiptsRead] will be notified through this callback.

Available since: 2.5.0 and above.

ZIMMessageRepliedListQueriedCallback

Methods

onMessageRepliedListQueried

public onMessageRepliedListQueried

The callback for querying the reply message list result.

Name	Type	Description
messageList	ArrayList<ZIMMessage>	List of messages retrieved.
nextFlag	long	Query anchor, used for the next page to be passed to [ZIMMessageRepliedListQueryConfig] for querying.
rootRepliedInfo	ZIMMessageRootRepliedInfo	Reply information for the root message.
error	ZIMError	error info.

ZIMMessageRevokedCallback

Methods

onMessageRevoked

public onMessageRevoked

Retracted news consequential reconciliation.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Retraction notice. 0 representative withdraw successfully, non 0 withdraw unsuccessful. When the withdrawal fails, the developer responds to the official website Review the solution.

Use cases: Developer allowed through this process during response [errorCode] Successful delivery.
Trigger: For our developers [revokeMessage] When contacting, this revoke will be sent.
Related APIs: If the revoked message is the latest message of the session, the [conversationChanged] callback will be triggered, and if the message is unread, the [conversationTotalUnreadMessageCountUpdated] callback will be triggered.

ZIMMessageSentCallback

A callback interface for sending messages

Details

A callback interface for sending messages

Declared in ZIM.java

Methods

onMessageSent

public void onMessageSent(ZIMMessage message, ZIMError errorInfo)

Callback of the result of sending the message.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMessage	Description: ZIMMessage Object.
errorInfo	ZIMError

Details

Supported Versions: 1.1.0 and above.

Detail description: The callback for the result of sending the message.

Business scenario: The developer can judge whether the sending is successful through the [errorCode] in the callback.

Notification timing: This callback is triggered when the developer calls the [sendMessage] interfaces.

Related interfaces: Send messages through [sendMessage] , and the success of sending messages will be notified through this callback.

onMessageAttached

public void onMessageAttached(ZIMMessage message)

The incoming message object is given a localMessgeID and returned.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMessage	Description: ZIMMessage object with the same address as the object passed in.

Details

Supported version: 2.4 and later.

The incoming message object is given a localMessgeID and returned.

Service scenario: Before a message is successfully sent, it can correspond to its localMessageID to implement loading before sending.

Notification time: Triggered after the message is sent and before the message is successfully sent.

ZIMMessageSentFullCallback

A callback interface for sending messages

Details

A callback interface for sending messages

Declared in ZIM.java

Methods

onMessageSent

public void onMessageSent(ZIMMessage message, ZIMError errorInfo)

Callback of the result of sending the message.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMessage	Description: ZIMMessage Object.
errorInfo	ZIMError

Details

Supported Versions: 1.1.0 and above.

Detail description: The callback for the result of sending the message.

Business scenario: The developer can judge whether the sending is successful through the [errorCode] in the callback.

Notification timing: This callback is triggered when the developer calls the [sendMessage] interfaces.

Related interfaces: Send messages through [sendMessage] , and the success of sending messages will be notified through this callback.

onMessageAttached

public void onMessageAttached(ZIMMessage message)

The incoming message object is given a localMessgeID and returned.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMessage	Description: ZIMMessage object with the same address as the object passed in.

Details

Supported version: 2.4 and later.

The incoming message object is given a localMessgeID and returned.

Service scenario: Before a message is successfully sent, it can correspond to its localMessageID to implement loading before sending.

Notification time: Triggered after the message is sent and before the message is successfully sent.

onMediaUploadingProgress

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

Progress callback for sending media messages.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMediaMessage	Description: The message object for the current file upload.
currentFileSize	long	The current progress, that is, the real-time size of the current file upload.
totalFileSize	long	Total progress, which is the total size of the current file.

Details

The progress callback for sending media messages.

Business scenario: The developer can obtain the sending progress of the media message through this callback.

Available since: 2.17.0 and above.

onMultipleMediaUploadingProgress

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

An upload progress callback that sends a multiple message containing the media file.

Declared in ZIM.java

Parameters

Name	Type	Description
message	ZIMMultipleMessage	The currently sent message object.
currentFileSize	long	The current total uploaded size.
totalFileSize	long	The total size of files to be uploaded.
messageInfoIndex	int	The index of the array where the currently uploaded file is located.
currentIndexFileSize	long	The uploaded size of the currently uploaded file.
totalIndexFileSize	long	The total size of the files currently being uploaded.

Details

Through this notification, developers can obtain the progress callback of the media file upload in the multiple message.

Use cases: Developers can use it to display the upload progress of each media file and the total upload progress to improve the UI interaction experience.

Available since: 2.19.0 and above.

ZIMMessagesGlobalSearchedCallback

Methods

onMessagesGlobalSearched

public onMessagesGlobalSearched

Return of local message search results.

Parameters

Name	Type	Description
messageList	ArrayList<ZIMMessage>	List of searched messages.
nextMessage	ZIMMessage	Pagination retrieval flag, message anchor for searching the next page.
errorInfo	ZIMError	Error codes for global search of local messages. 0 represents a successful global search of local messages, while non-zero indicates a failed global search of local messages. If a failure occurs during the global search of local messages, developers should refer to the official error code documentation for solutions.

Details

Detailed description: Return of search results for local messages.

Use cases: After performing a local message search operation, the success or failure can be determined through this callback.

Related API: [searchLocalMessages], search for local messages.

ZIMMessagesSearchedCallback

Methods

onMessagesSearched

public onMessagesSearched

Return of local message search results.

Parameters

Name	Type	Description
conversationID	String	Conversation ID, in the case of one-on-one chat, the conversationID is the userID of the other party. In the case of a group chat, the conversationID is the groupID of the group.
conversationType	ZIMConversationType	Conversation types. 0: One-on-one chat, 1: Room, 2: Group. Note: In the "Room" scenario, caching and searching for offline messages are not supported by default.
messageList	ArrayList<ZIMMessage>	List of searched messages.
nextMessage	ZIMMessage	Pagination retrieval flag, message anchor for searching the next page.
errorInfo	ZIMError	Search local message error codes. 0 represents a successful search for local messages, and non-zero values indicate a failure to search for local messages. If a failure to search for local messages occurs, developers should refer to the official website's error code documentation for solutions.

Details

Detailed description: Return of search results for local messages.

Use cases: After performing a local message search operation, the success or failure can be determined through this callback.

Related API: [searchLocalMessages], search for local messages.

ZIMRoomAttributesBatchOperatedCallback

Methods

ZIMRoomAttributesBatchOperatedCallback

public ZIMRoomAttributesBatchOperatedCallback

The return of the result of the room attribute combination operation.

Parameters

Name	Type	Description
roomID	String	Room ID
errorInfo	ZIMError	Error code for room property batch operations. 0 means the room attribute batch operation is successful, non-0 means the room attribute batch operation fails. If the room attribute batch operation fails, the developer should check the official website error code document to query the solution.

Details

The return of the result of the room attribute combination operation.

Available since: 1.3.0.

ZIMRoomAttributesOperatedCallback

Methods

ZIMRoomAttributesOperatedCallback

public ZIMRoomAttributesOperatedCallback

The return of the operation result of the room attribute.

Parameters

Name	Type	Description
roomID	String	Room ID.
errorKeys	ArrayList<String>	Keys for failed operation.
errorInfo	ZIMError	Error code for room attribute operation. 0 means the room property operation is successful, non-0 means the room property operation fails. If the room attribute operation fails, the developer should check the official website error code document to query the solution.

Details

The return of the operation result of the room attribute.

Available since: 1.3.0.

ZIMRoomAttributesQueriedCallback

Methods

ZIMRoomAttributesQueriedCallback

public ZIMRoomAttributesQueriedCallback

Return of room attribute query results.

Parameters

Name	Type	Description
roomID	String	Room ID
roomAttributes	HashMap<String, String>	Room attributes in the room.
errorInfo	ZIMError	Error code for querying all properties of the room. 0 means that the query of all properties of the room is successful, and non-0 means that the query of all the properties of the room fails. If the query of all the properties of the room fails, the developer should check the official website for the error code document query solution.

Details

Return of room attribute query results.

Available since: 1.3.0.

ZIMRoomCreatedCallback

Methods

onRoomCreated

public onRoomCreated

Callback of the result of creating the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Details of the room created. If the creation fails, the roomID parameter in roomInfo will be an empty string.
errorInfo	ZIMError	Error information.

Details

The callback of the result of creating the room.

Related APIs: Create a room through [createRoom], and the result of the creation will be notified through this callback.

Available since: 1.1.0 or above.

ZIMRoomEnteredCallback

Methods

onRoomEntered

public onRoomEntered

Callback of the result of entering the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Details of the room created. If the creation fails, the roomID parameter in roomInfo will be an empty string.
errorInfo	ZIMError	Error information.

Related APIs: Create a room through [enterRoom], and the entry result will be notified through this callback.

ZIMRoomJoinedCallback

Methods

onRoomJoined

public onRoomJoined

Callback of the result of joining the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Details of the room joined. If the join fails, the roomID parameter in roomInfo will be an empty string.
errorInfo	ZIMError	Error code to join room. 0 means join the room successfully, non-0 means join the room failed. If there is a failure to join the room, the developer should check the official website error code document to query the solution.

Details

The callback of the result of joining the room.

Related APIs: Join the room through [joinRoom], and the result of joining will be notified through this callback.

Available since: 1.1.0 or above.

ZIMRoomLeftCallback

Methods

onRoomLeft

public onRoomLeft

Callback of the result of leaving the room.

Parameters

Name	Type	Description
roomID	String	Room ID
errorInfo	ZIMError	Error code to leave the room. 0 means leaving the room successfully, non-0 means leaving the room failed. If there is a failure to leave the room, the developer should check the official website error code document to query the solution.

Details

The callback of the result of leaving the room.

Related APIs: Leave the room through [leaveRoom], and the result of leaving will be notified through this callback.

Available since: 1.1.0 or above.

ZIMRoomMemberAttributesListQueriedCallback

Methods

ZIMRoomMemberAttributesListQueriedCallback

public ZIMRoomMemberAttributesListQueriedCallback

Returns the query result of the user attribute list in the room.

Parameters

Name	Type	Description
roomID	String	Room ID.
infos	ArrayList<ZIMRoomMemberAttributesInfo>	List of room user attributes.
nextFlag	String	The anchor of the next paging query. If it is empty, it means that the query has been completed.
errorInfo	ZIMError	Error code for querying room user attributes. 0 means the query of room user attributes is successful, non-0 means the query of room user attributes fails. If there is a failure to query the room user attributes, the developer should check the https://doc-zh.zego.im/article/11606 query solution.

Details

Supported version: 2.4.0 and later.

Detail description: Returns the result of paging query of all user attribute lists in the room.

Business scenario: After querying room user attributes, the success or failure and query results can be known through this callback.

Notification timing: The result will be returned after the room user attribute query is completed.

Related interface: [queryRoomMemberAttributesList], query room user attributes.

ZIMRoomMemberQueriedCallback

Methods

onRoomMemberQueried

public onRoomMemberQueried

Callback of the result of querying the room members list.

Parameters

Name	Type	Description
roomID	String	Room ID
memberList	ArrayList<ZIMUserInfo>	List of members in the room.
nextFlag	String	The flag of the paging query. If this field is an empty string, the query has been completed. Otherwise, you need to set this value to the "nextFlag" field of ZIMQueryMemberConfig for the next page query.
errorInfo	ZIMError	Query the error code of room members. 0 means querying room members successfully, non-0 means querying room members failed. If there is a failure to query room members, the developer should check the official website for the error code document query solution.

Details

Callback for the result of querying the room member list.

Related APIs: Query the list of room members through [queryRoomMember], and the query result will be notified through this callback.

Available since: 1.1.0 or above.

ZIMRoomMembersAttributesQueriedCallback

Methods

ZIMRoomMembersAttributesQueriedCallback

public ZIMRoomMembersAttributesQueriedCallback

Returns the results of batch query of room user attributes.

Parameters

Name	Type	Description
roomID	String	Room ID.
infos	ArrayList<ZIMRoomMemberAttributesInfo>	List of room user attributes.
errorInfo	ZIMError	Error code for querying room user attributes. 0 means the query of room user attributes is successful, non-0 means the query of room user attributes fails. If there is a failure to query the room user attributes, the developer should check the https://doc-zh.zego.im/article/11606 query solution.

Details

Supported version: 2.4.0 and later.

Detailed description: According to the UserID list, batch query results of room user attributes are returned.

Business scenario: After querying room user attributes, the success or failure and query results can be known through this callback.

Notification timing: The result will be returned after the room user attribute query is completed.

Related interface: [queryRoomMembersAttributes], query room user attributes.

ZIMRoomMembersQueriedCallback

Methods

ZIMRoomMembersQueriedCallback

public ZIMRoomMembersQueriedCallback

Callback for the result of querying the specified member of the room.

Parameters

Name	Type	Description
roomID	String	Room ID.
memberList	ArrayList<ZIMRoomMemberInfo>	List of user information.
errorUserList	ArrayList<ZIMErrorUserInfo>	List of users whose query failed.
errorInfo	ZIMError	error info.

Details

After querying room user information, the query result is returned through this callback.

Use cases: The logic after querying room user information can be done in this callback.
When to call /Trigger: Triggered after querying room user information.

Available since: 2.8.0 and above.

ZIMRoomOnlineMemberCountQueriedCallback

Methods

onRoomOnlineMemberCountQueried

public onRoomOnlineMemberCountQueried

Callback of the result of querying the online members count in the room.

Parameters

Name	Type	Description
roomID	String	Room ID
count	int	The number of online members of the room.
errorInfo	ZIMError	Query the error code of the online member of the room. 0 means the query of online members of the room is successful, and non-0 means the query of online members of the room fails. If there is a failure to query the online members of the room, the developer should check the official website for the error code document query solution.

Details

Callback of the result of querying the online members count in the room.

Related APIs: You can check the online number of people in the room through [queryRoomOnlineMemberCount].

Available since: 1.1.0 or above.

ZIMRoomSwitchedCallback

Methods

onRoomSwitched

public onRoomSwitched

Callback of the result of switched rooms.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Full info of the room switched.
errorInfo	ZIMError	Error information.

Related APIs: Switched rooms through [switchRoom], and the result will be notified through this callback.

ZIMSelfUserInfoQueriedCallback

Methods

ZIMSelfUserInfoQueriedCallback

public ZIMSelfUserInfoQueriedCallback

Callback result of querying personal user information and rules.

Parameters

Name	Type	Description
selfUserInfo	ZIMSelfUserInfo	Own user information, rule data class.
errorInfo	ZIMError	Contains error codes and error messages.

Details

Callback result of querying personal user information and rules.

ZIMSendingMessageCancelledCallback

Methods

ZIMSendingMessageCancelledCallback

public ZIMSendingMessageCancelledCallback

Callback of the result of cancel sending the message.

Parameters

Name	Type	Description
errorInfo	ZIMError	The error code of the cancel sending message.

Details

Supported Versions: 2.22.0 and above.

Detail description: The callback for the result of cancel sending the message.

Business scenario: The developer can judge whether the cancel sending is successful through the [errorCode] in the callback.

Notification timing: This callback is triggered when the developer calls the [cancelSendingMessage] interfaces.

ZIMSubscribedUserStatusListQueriedCallback

Methods

onSubscribedUserStatusListQueried

public onSubscribedUserStatusListQueried

QuerySubscribedUserStatusList query for the current user subscription list operation results callback.

Parameters

Name	Type	Description
userStatusSubscriptionList	ArrayList< ZIMUserStatusSubscription >	Subscription information for users in the subscription list.

Details

QuerySubscribedUserStatusList query for the current user subscription list operation results callback.

ZIMTokenRenewedCallback

Methods

onTokenRenewed

public onTokenRenewed

Callback of the result of renewing the token.

Parameters

Name	Type	Description
token	String	The renewed token.
errorInfo	ZIMError	Error code.

Details

After the developer updates the Token, execute the callback of the result.

Use cases: The developer can use [errorCode] in this callback to determine whether the Token was successfully updated.
When to call: This callback is triggered when a developer invokes the [renewToken] interface.
Caution: Renew tokens through [renewToken]. Success or failure to renew tokens will be notified through this callback.

Available since: 1.1.0 or above.

ZIMUserAvatarUrlUpdatedCallback

Methods

onUserAvatarUrlUpdated

public onUserAvatarUrlUpdated

Callback for updating the user avatar URL.

Parameters

Name	Type	Description
userAvatarUrl	String	The updated user avatar URL.
errorInfo	ZIMError	Error code.

Details

Supported versions: 2.3.0 and above.

Detail description: The callback after the developer updates the user avatar URL.

Business scenario: The developer can judge whether the operation is successful through the [errorCode] in the callback.

Notification timing: This callback is triggered when the developer calls the [updateUserAvatarUrl] interface.

Related interface: [updateUserAvatarUrl] .

ZIMUserExtendedDataUpdatedCallback

Methods

onUserExtendedDataUpdated

public onUserExtendedDataUpdated

Update the user extended data callback.

Parameters

Name	Type	Description
extendedData	String	Updated of the user extended data.
errorInfo	ZIMError	Error code.

Use cases: The developer can check whether the operation succeeded by using [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [updateUserExtendedData] interface.

Related interface: Run the updateUserExtendedData command to query information.

ZIMUserNameUpdatedCallback

Methods

onUserNameUpdated

public onUserNameUpdated

Update the user name callback.

Parameters

Name	Type	Description
userName	String	Updated of the user name.
errorInfo	ZIMError	Error code.

Use cases: The developer can check whether the operation succeeded by using [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [updateUserName] interface.

Related interface: [updateUserName].

ZIMUserOfflinePushRuleUpdatedCallback

Methods

ZIMUserOfflinePushRuleUpdatedCallback

public ZIMUserOfflinePushRuleUpdatedCallback

Update the result callback of the user offline push rule.

Parameters

Name	Type	Description
offlinePushRule	ZIMUserOfflinePushRule	Updated offline push rules.
errorInfo	ZIMError	Contains error codes and details.

Details

Update the result callback of the user offline push rule.

ZIMUsersInfoQueriedCallback

Methods

onUsersInfoQueried

public onUsersInfoQueried

Query the userInfo callback.

Parameters

Name	Type	Description
userList	ArrayList<ZIMUserFullInfo>	List of the userInfo queried.
errorUserList	ArrayList<ZIMErrorUserInfo>	Failed to query the userInfo list.
errorInfo	ZIMError	Error code.

Use cases: The developer can check whether the queried succeeded by using [errorCode] in this callback.

Notification timing: This callback is triggered when a developer invokes the [queryUsersInfo] interface.

Related interface: Run the queryUsersInfo command to query information.

ZIMUsersStatusQueriedCallback

Methods

onUsersStatusSubscribed

public onUsersStatusSubscribed

Result callback of the queryUsersStatus interface for batch querying user online status.

Parameters

Name	Type	Description
userStatusList	ArrayList<ZIMUserStatus>	Indicates the online status of the user to be queried.
errorUserList	ArrayList< ZIMErrorUserInfo >	Query the list of failed users.
errorInfo	ZIMError	The query result contains error codes and error information.

Details

Result callback of the queryUsersStatus interface for batch querying user online status.

ZIMUsersStatusSubscribedCallback

Methods

onUsersStatusSubscribed

public onUsersStatusSubscribed

subscribeUsersStatus Callback for the operation results of the batch subscription interface.

Parameters

Name	Type	Description
errorUserList	ArrayList<ZIMErrorUserInfo>	List of users who failed to subscribe.
errorInfo	ZIMError	Operation result, including error codes and error information.

Details

subscribeUsersStatus Callback for the operation results of the batch subscription interface.

ZIMUsersStatusUnsubscribedCallback

Methods

onUsersStatusUnsubscribed

public onUsersStatusUnsubscribed

unsubscribeUsersStatus Callback for canceling the operations of subscribing interfaces in a batch.

Parameters

Name	Type	Description
errorUserList	ArrayList<ZIMErrorUserInfo>	Cancels the list of failed users.
errorInfo	ZIMError	The result of the batch cancellation operation contains error messages and error codes.

Details

unsubscribeUsersStatus Callback for canceling the operations of subscribing interfaces in a batch.