In-app Chat
On this page

Interface

2026-07-24
ZIMLogUploadedCallbackZIMLoggedInCallback
ZIMTokenRenewedCallbackZIMExperimentalAPICalledCallback
ZIMUserNameUpdatedCallbackZIMUserAvatarUrlUpdatedCallback
ZIMUserExtendedDataUpdatedCallbackZIMUserCustomStatusUpdatedCallback
ZIMUserBadgeUpdatedCallbackZIMUsersInfoQueriedCallback
ZIMUserOfflinePushRuleUpdatedCallbackZIMSelfUserInfoQueriedCallback
ZIMUsersStatusQueriedCallbackZIMUsersStatusSubscribedCallback
ZIMUsersStatusUnsubscribedCallbackZIMSubscribedUserStatusListQueriedCallback
ZIMConversationQueriedCallbackZIMConversationListQueriedCallback
ZIMConversationTotalUnreadMessageCountQueriedCallbackZIMConversationDeletedCallback
ZIMConversationsAllDeletedCallbackZIMConversationUnreadMessageCountClearedCallback
ZIMConversationTotalUnreadMessageCountClearedCallbackZIMConversationNotificationStatusSetCallback
ZIMConversationMessageReceiptReadSentCallbackZIMConversationPinnedStateUpdatedCallback
ZIMConversationPinnedListQueriedCallbackZIMConversationDraftSetCallback
ZIMConversationMarkSetCallbackZIMConversationMessageDestructDurationSetCallback
ZIMConversationsSearchedCallbackZIMMessageSentCallback
ZIMMediaMessageSentCallbackZIMMessageSentFullCallback
ZIMMessageQueriedCallbackZIMMessageDeletedCallback
ZIMConversationMessagesAllDeletedCallbackZIMMessageRevokedCallback
ZIMMessageInsertedCallbackZIMMessageLocalExtendedDataUpdatedCallback
ZIMMessageReceiptsReadSentCallbackZIMMessageReceiptsInfoQueriedCallback
ZIMMediaDownloadedCallbackZIMMessagesSearchedCallback
ZIMMessagesGlobalSearchedCallbackZIMMessageReactionAddedCallback
ZIMMessageReactionDeletedCallbackZIMMessageReactionsAllDeletedCallback
ZIMMessageReactionUserListQueriedCallbackZIMCombineMessageDetailQueriedCallback
ZIMMessageRepliedListQueriedCallbackZIMSendingMessageCancelledCallback
ZIMMessagePinnedCallbackZIMPinnedMessageListQueriedCallback
ZIMFileCacheQueriedCallbackZIMFileCacheClearedCallback
ZIMRoomCreatedCallbackZIMRoomJoinedCallback
ZIMRoomEnteredCallbackZIMRoomSwitchedCallback
ZIMRoomLeftCallbackZIMRoomAllLeftCallback
ZIMRoomMemberQueriedCallbackZIMRoomMembersQueriedCallback
ZIMRoomOnlineMemberCountQueriedCallbackZIMRoomAttributesOperatedCallback
ZIMRoomAttributesBatchOperatedCallbackZIMRoomAttributesQueriedCallback
ZIMRoomMembersAttributesOperatedCallbackZIMRoomMembersAttributesQueriedCallback
ZIMRoomMemberAttributesListQueriedCallbackZIMGroupCreatedCallback
ZIMGroupDismissedCallbackZIMGroupJoinedCallback
ZIMGroupLeftCallbackZIMGroupUsersInvitedCallback
ZIMGroupMemberKickedCallbackZIMGroupOwnerTransferredCallback
ZIMGroupNameUpdatedCallbackZIMGroupAvatarUrlUpdatedCallback
ZIMGroupNoticeUpdatedCallbackZIMGroupAliasUpdatedCallback
ZIMGroupInfoQueriedCallbackZIMGroupAttributesOperatedCallback
ZIMGroupAttributesQueriedCallbackZIMGroupMemberRoleUpdatedCallback
ZIMGroupMemberNicknameUpdatedCallbackZIMGroupMemberInfoQueriedCallback
ZIMGroupListQueriedCallbackZIMGroupMemberListQueriedCallback
ZIMGroupMemberCountQueriedCallbackZIMGroupMessageReceiptMemberListQueriedCallback
ZIMGroupMutedCallbackZIMGroupMembersMutedCallback
ZIMGroupMemberMutedListQueriedCallbackZIMGroupsSearchedCallback
ZIMGroupMembersSearchedCallbackZIMGroupJoinModeUpdatedCallback
ZIMGroupInviteModeUpdatedCallbackZIMGroupBeInviteModeUpdatedCallback
ZIMGroupJoinApplicationSentCallbackZIMGroupJoinApplicationAcceptedCallback
ZIMGroupJoinApplicationRejectedCallbackZIMGroupInviteApplicationsSentCallback
ZIMGroupInviteApplicationAcceptedCallbackZIMGroupInviteApplicationRejectedCallback
ZIMGroupApplicationListQueriedCallbackZIMCallInvitationSentCallback
ZIMCallingInvitationSentCallbackZIMCallCancelSentCallback
ZIMCallAcceptanceSentCallbackZIMCallRejectionSentCallback
ZIMCallJoinSentCallbackZIMCallQuitSentCallback
ZIMCallEndSentCallbackZIMCallInvitationListQueriedCallback
ZIMFriendAddedCallbackZIMFriendsDeletedCallback
ZIMFriendListQueriedCallbackZIMFriendsInfoQueriedCallback
ZIMFriendsRelationCheckedCallbackZIMFriendApplicationSentCallback
ZIMFriendApplicationAcceptedCallbackZIMFriendApplicationRejectedCallback
ZIMFriendApplicationListQueriedCallbackZIMFriendAliasUpdatedCallback
ZIMFriendAttributesUpdatedCallbackZIMFriendsSearchedCallback
ZIMBlacklistUsersAddedCallbackZIMBlacklistUsersRemovedCallback
ZIMBlacklistQueriedCallbackZIMBlacklistCheckedCallback
ZIMCommunityCreatedCallbackZIMCommunityDismissedCallback
ZIMCommunityJoinedCallbackZIMCommunityLeftCallback
ZIMCommunityListQueriedCallbackZIMCommunityNameUpdatedCallback
ZIMCommunityAvatarUrlUpdatedCallbackZIMCommunityNoticeUpdatedCallback
ZIMCommunityAttributesOperatedCallbackZIMCommunityNotificationStatusSetCallback
ZIMCommunityInfoQueriedCallbackZIMCommunityUsersInvitedCallback
ZIMCommunityMembersKickedCallbackZIMCommunityMemberRoleUpdatedCallback
ZIMCommunityOwnerTransferredCallbackZIMCommunityMemberListQueriedCallback
ZIMCommunityMembersQueriedCallbackZIMCommunityChannelCreatedCallback
ZIMCommunityChannelDismissedCallbackZIMCommunityChannelNameUpdatedCallback
ZIMCommunityChannelAvatarUrlUpdatedCallbackZIMCommunityChannelNoticeUpdatedCallback
ZIMCommunityChannelAttributesOperatedCallbackZIMCommunityChannelsInfoQueriedCallback
ZIMCommunityChannelListQueriedCallbackZIMCommunityMembersMutedCallback
ZIMCommunityChannelsMutedCallback

ZIMLogUploadedCallback

Methods

onLogUploaded

onLogUploaded
Callback of the log upload result.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMLoggedInCallback

Methods

onLoggedIn

onLoggedIn
public onLoggedIn
Callback of the login result.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

Details

After the developer login, execute the callback of the result.

  • Use cases:Developers can use the [errorCode] in the callback to determine whether the login is successful.
  • Triggered when:When the developer calls the [login] interface, the callback will be triggered.
  • Available since:1.2.0 and above.

ZIMTokenRenewedCallback

Methods

onTokenRenewed

onTokenRenewed
Callback of the result of renewing the token.

Parameters

NameTypeDescription
tokenStringThe renewed token.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMExperimentalAPICalledCallback

Methods

onExperimentalAPICalled

onExperimentalAPICalled
The result of called the experimental API.

Parameters

NameTypeDescription
resultStringThe result returned by calling the experimental API in JSON string format. For details, please consult ZEGO technical support.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserNameUpdatedCallback

Methods

onUserNameUpdated

onUserNameUpdated
Update the user name callback.

Parameters

NameTypeDescription
userNameStringThe updated user name.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserAvatarUrlUpdatedCallback

Methods

onUserAvatarUrlUpdated

onUserAvatarUrlUpdated
Callback for updating the user avatar URL.

Parameters

NameTypeDescription
userAvatarUrlStringThe updated user avatar URL.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserExtendedDataUpdatedCallback

Methods

onUserExtendedDataUpdated

onUserExtendedDataUpdated
Update the user extended data callback.

Parameters

NameTypeDescription
extendedDataStringThe updated user extended data.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserCustomStatusUpdatedCallback

Methods

onUserCustomStatusUpdated

onUserCustomStatusUpdated
The callback of the custom status update.

Parameters

NameTypeDescription
customStatusStringThe updated user custom status.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserBadgeUpdatedCallback

Methods

onUserBadgeUpdated

onUserBadgeUpdated
Update the user badge callback.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersInfoQueriedCallback

Methods

onUsersInfoQueried

onUsersInfoQueried
Query the userInfo callback.

Parameters

NameTypeDescription
userListArrayList<ZIMUserFullInfo>The queried user information list.
errorUserListArrayList<ZIMErrorUserInfo>The list of user IDs that failed to be queried.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserOfflinePushRuleUpdatedCallback

Methods

onUserOfflinePushRuleUpdated

onUserOfflinePushRuleUpdated
Update the result callback of the user offline push rule.

Parameters

NameTypeDescription
offlinePushRuleZIMUserOfflinePushRuleThe updated user offline push rule.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMSelfUserInfoQueriedCallback

Methods

onSelfUserInfoQueried

onSelfUserInfoQueried
Callback result of querying personal user information and rules.

Parameters

NameTypeDescription
selfUserInfoZIMSelfUserInfoThe current user information and rules.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersStatusQueriedCallback

Methods

onUsersStatusQueried

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

Parameters

NameTypeDescription
userStatusListArrayList<ZIMUserStatus>The queried user status list.
errorUserListArrayList<ZIMErrorUserInfo>The list of user IDs that failed to be queried.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersStatusSubscribedCallback

Methods

onUsersStatusSubscribed

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

Parameters

NameTypeDescription
errorUserListArrayList<ZIMErrorUserInfo>The list of user IDs that failed to subscribe.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersStatusUnsubscribedCallback

Methods

onUsersStatusUnsubscribed

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

Parameters

NameTypeDescription
errorUserListArrayList<ZIMErrorUserInfo>The list of user IDs that failed to unsubscribe.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMSubscribedUserStatusListQueriedCallback

Methods

onSubscribedUserStatusListQueried

onSubscribedUserStatusListQueried
Query for the current user subscription list operation results callback.

Parameters

NameTypeDescription
userStatusSubscriptionListArrayList<ZIMUserStatusSubscription>The user status subscription list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationQueriedCallback

Methods

onConversationQueried

onConversationQueried
Conversation query callback.

Parameters

NameTypeDescription
conversationZIMConversationThe queried conversation object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationListQueriedCallback

Methods

onConversationListQueried

onConversationListQueried
Session list query callback.

Parameters

NameTypeDescription
conversationListArrayList<ZIMConversation>The queried conversation list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationTotalUnreadMessageCountQueriedCallback

Methods

onConversationTotalUnreadMessageCountQueried

onConversationTotalUnreadMessageCountQueried
Query conversation unread total count callback.

Parameters

NameTypeDescription
unreadMessageCountintThe total count of unread messages across all conversations.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationDeletedCallback

Methods

onConversationDeleted

onConversationDeleted
Callback for conversation deletion.

Parameters

NameTypeDescription
conversationIDStringThe ID of the deleted conversation.
conversationTypeZIMConversationTypeThe type of the deleted conversation.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationsAllDeletedCallback

Methods

onConversationsAllDeleted

onConversationsAllDeleted
Callback for conversations deletion.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationUnreadMessageCountClearedCallback

Methods

onConversationUnreadMessageCountCleared

onConversationUnreadMessageCountCleared
Callback for session unread clearing.

Parameters

NameTypeDescription
conversationIDStringThe conversation ID whose unread message count was cleared.
conversationTypeZIMConversationTypeThe conversation type whose unread message count was cleared.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationTotalUnreadMessageCountClearedCallback

Methods

onConversationTotalUnreadMessageCountCleared

onConversationTotalUnreadMessageCountCleared
Callback for sessions unread clearing.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationNotificationStatusSetCallback

Methods

onConversationNotificationStatusSet

onConversationNotificationStatusSet
Callback for conversation notification state settings.

Parameters

NameTypeDescription
conversationIDStringThe conversation ID for which the notification status was set.
conversationTypeZIMConversationTypeThe conversation type for which the notification status was set.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMessageReceiptReadSentCallback

Methods

onConversationMessageReceiptReadSent

onConversationMessageReceiptReadSent
Callback interface for setting the read receipt conversation.

Parameters

NameTypeDescription
conversationIDStringThe conversation ID for which the receipt was sent.
conversationTypeZIMConversationTypeThe conversation type for which the receipt was sent.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationPinnedStateUpdatedCallback

Methods

onConversationPinnedStateUpdated

onConversationPinnedStateUpdated
Callback for conversation pinned state updated.

Parameters

NameTypeDescription
conversationIDStringThe conversation ID whose pinned state was updated.
conversationTypeZIMConversationTypeThe conversation type whose pinned state was updated.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationPinnedListQueriedCallback

Methods

onConversationPinnedListQueried

onConversationPinnedListQueried
Callback for querying the pinned conversation list.

Parameters

NameTypeDescription
conversationListArrayList<ZIMConversation>The queried pinned conversation list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationDraftSetCallback

Methods

onConversationDraftSet

onConversationDraftSet
Sets the callback for the session draft.

Parameters

NameTypeDescription
conversationIDStringThe conversation ID for which the draft was set.
conversationTypeZIMConversationTypeThe conversation type for which the draft was set.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMarkSetCallback

Methods

onConversationMarkSet

onConversationMarkSet
Callback for conversation mark set.

Parameters

NameTypeDescription
failedConversationInfosArrayList<ZIMConversationBaseInfo>The list of conversation info objects that failed to have marks set.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMessageDestructDurationSetCallback

Methods

onConversationMessageDestructDurationSet

onConversationMessageDestructDurationSet
Callback for the result of setting the message self-destruction duration in a conversation.

Parameters

NameTypeDescription
conversationIDStringThe ID of the conversation for which the setting was applied.
conversationTypeZIMConversationTypeThe type of the conversation for which the setting was applied.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationsSearchedCallback

Methods

onConversationsSearched

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

Parameters

NameTypeDescription
conversationSearchInfoListArrayList<ZIMConversationSearchInfo>The list of searched conversation results.
nextFlagintAnchor for the next page query.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageSentCallback

Methods

onMessageSent

onMessageSent
Callback of the result of sending the message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

onMessageAttached

onMessageAttached
Callback triggered when a message is attached before being sent.

Parameters

NameTypeDescription
messageZIMMessageMessage object.

ZIMMediaMessageSentCallback

Methods

onMessageSent

onMessageSent
Callback of the result of sending the message.

Parameters

NameTypeDescription
messageZIMMediaMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

onMessageAttached

onMessageAttached
Callback triggered when a message is attached before being sent.

Parameters

NameTypeDescription
messageZIMMediaMessageMessage object.

onMediaUploadingProgress

onMediaUploadingProgress
Callback triggered during media file upload progress.

Parameters

NameTypeDescription
messageZIMMediaMessageMedia message object.
currentFileSizelongCurrent upload progress of the media file.
totalFileSizelongTotal size of the media file.

ZIMMessageSentFullCallback

Methods

onMessageSent

onMessageSent
Callback of the result of sending the message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

onMessageAttached

onMessageAttached
Callback triggered when a message is attached before being sent.

Parameters

NameTypeDescription
messageZIMMessageMessage object.

onMediaUploadingProgress

onMediaUploadingProgress
Callback triggered during media file upload progress.

Parameters

NameTypeDescription
messageZIMMediaMessageMedia message object.
currentFileSizelongCurrent upload progress of the media file.
totalFileSizelongTotal size of the media file.

onMultipleMediaUploadingProgress

onMultipleMediaUploadingProgress
Callback triggered during multiple media file upload progress.

Parameters

NameTypeDescription
messageZIMMultipleMessageMultiple message object.
currentFileSizelongTotal upload progress of media files in the multiple message.
totalFileSizelongTotal size of media files in the multiple message.
messageInfoIndexintContent index of the multiple message.
currentIndexFileSizelongUpload progress of a single media file in the combined message.
totalIndexFileSizelongSize of a single media file in the combined message.

ZIMMessageQueriedCallback

Methods

onMessageQueried

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

Parameters

NameTypeDescription
conversationIDStringConversation ID.
conversationTypeZIMConversationTypeConversation type.
messageListArrayList<ZIMMessage>Message list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageDeletedCallback

Methods

onMessageDeleted

onMessageDeleted
A callback to delete a message.

Parameters

NameTypeDescription
conversationIDStringConversation ID.
conversationTypeZIMConversationTypeConversation type.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMessagesAllDeletedCallback

Methods

onConversationMessagesAllDeleted

onConversationMessagesAllDeleted
Deletes callbacks of all messages for all sessions.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageRevokedCallback

Methods

onMessageRevoked

onMessageRevoked
Retracted news consequential reconciliation.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageInsertedCallback

Methods

onMessageInserted

onMessageInserted
Callback of the result of inserting the message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageLocalExtendedDataUpdatedCallback

Methods

onMessageLocalExtendedDataUpdated

onMessageLocalExtendedDataUpdated
Callback for updating message local extension fields.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReceiptsReadSentCallback

Methods

onMessageReceiptsReadSent

onMessageReceiptsReadSent
Callback interface for setting the read receipt message.

Parameters

NameTypeDescription
conversationIDStringConversation ID.
conversationTypeZIMConversationTypeConversation type.
errorMessageIDsArrayList<Long>Error message ID list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReceiptsInfoQueriedCallback

Methods

onMessageReceiptsInfoQueried

onMessageReceiptsInfoQueried
Callback interface for query receipt message read.

Parameters

NameTypeDescription
infosArrayList<ZIMMessageReceiptInfo>Message receipt information list.
errorMessageIDsArrayList<Long>Error message ID list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMediaDownloadedCallback

Methods

onMediaDownloaded

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

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

onMediaDownloadingProgress

onMediaDownloadingProgress
Media file download progress.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
currentFileSizelongCurrent download progress of the media file.
totalFileSizelongTotal size of the media file.

ZIMMessagesSearchedCallback

Methods

onMessagesSearched

onMessagesSearched
Return of local message search results.

Parameters

NameTypeDescription
conversationIDStringConversation ID.
conversationTypeZIMConversationTypeConversation type.
messageListArrayList<ZIMMessage>Message list.
nextMessageZIMMessageNext message object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessagesGlobalSearchedCallback

Methods

onMessagesGlobalSearched

onMessagesGlobalSearched
Return of local message search results.

Parameters

NameTypeDescription
messageListArrayList<ZIMMessage>Message list.
nextMessageZIMMessageNext message object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionAddedCallback

Methods

onMessageReactionAdded

onMessageReactionAdded
The addition of return for message reactions.

Parameters

NameTypeDescription
reactionZIMMessageReactionMessage reaction object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionDeletedCallback

Methods

onMessageReactionDeleted

onMessageReactionDeleted
The delete of return for message reactions.

Parameters

NameTypeDescription
reactionZIMMessageReactionMessage reaction object.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionsAllDeletedCallback

Methods

onMessageReactionsAllDeleted

onMessageReactionsAllDeleted
The delete of return for message reactions.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionUserListQueriedCallback

Methods

onMessageReactionUserListQueried

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

Parameters

NameTypeDescription
messageZIMMessageMessage object.
userInfoListArrayList<ZIMMessageReactionUserFullInfo>List of user reaction information.
reactionTypeStringMessage reaction type.
nextFlaglongList query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out.
totalCountintTotal user count.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCombineMessageDetailQueriedCallback

Methods

onCombineMessageDetailQueried

onCombineMessageDetailQueried
Result callback for querying merge message details.

Parameters

NameTypeDescription
messageZIMCombineMessageCombine message object. The messageList in this object already contains the sub-message list of the merged message.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageRepliedListQueriedCallback

Methods

onMessageRepliedListQueried

onMessageRepliedListQueried
The callback for querying the reply message list result.

Parameters

NameTypeDescription
messageListArrayList<ZIMMessage>Message list.
nextFlaglongList query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out.
rootRepliedInfoZIMMessageRootRepliedInfoRoot message reply information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMSendingMessageCancelledCallback

Methods

onSendingMessageCancelled

onSendingMessageCancelled
Callback of the result of cancel sending the message.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessagePinnedCallback

Methods

onMessagePinned

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

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMPinnedMessageListQueriedCallback

Methods

onPinnedMessageListQueried

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

Parameters

NameTypeDescription
messageListArrayList<ZIMMessage>Message list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFileCacheQueriedCallback

Methods

onFileCacheQueried

onFileCacheQueried
Callback for querying the results of the local cache.

Parameters

NameTypeDescription
fileCacheInfoZIMFileCacheInfoFile cache information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFileCacheClearedCallback

Methods

onFileCacheCleared

onFileCacheCleared
Clears the callback of the local cache result.

Parameters

NameTypeDescription
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomCreatedCallback

Methods

onRoomCreated

onRoomCreated
Callback of the result of creating the room.

Parameters

NameTypeDescription
roomInfoZIMRoomFullInfoRoom information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomJoinedCallback

Methods

onRoomJoined

onRoomJoined
Callback of the result of joining the room.

Parameters

NameTypeDescription
roomInfoZIMRoomFullInfoRoom information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomEnteredCallback

Methods

onRoomEntered

onRoomEntered
Callback of the result of entering the room.

Parameters

NameTypeDescription
roomInfoZIMRoomFullInfoRoom information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomSwitchedCallback

Methods

onRoomSwitched

onRoomSwitched
Callback of the result of switched rooms.

Parameters

NameTypeDescription
roomInfoZIMRoomFullInfoRoom information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomLeftCallback

Methods

onRoomLeft

onRoomLeft
public onRoomLeft
Callback of the result of leaving the room.

Parameters

NameTypeDescription
roomIDStringRoom ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAllLeftCallback

Methods

onRoomAllLeft

onRoomAllLeft
Callback for the results of leaving all rooms.

Parameters

NameTypeDescription
roomIDsArrayList<String>Room ID list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMemberQueriedCallback

Methods

onRoomMemberQueried

onRoomMemberQueried
Callback of the result of querying the room members list.

Parameters

NameTypeDescription
roomIDStringRoom ID.
memberListArrayList<ZIMUserInfo>Room member list.
nextFlagStringUsed to query the next page. The current value returns an empty string, which means that the list has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMembersQueriedCallback

Methods

onRoomMembersQueried

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

Parameters

NameTypeDescription
roomIDStringRoom ID.
memberListArrayList<ZIMRoomMemberInfo>Room member list.
errorUserListArrayList<ZIMErrorUserInfo>Error member list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomOnlineMemberCountQueriedCallback

Methods

onRoomOnlineMemberCountQueried

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

Parameters

NameTypeDescription
roomIDStringRoom ID.
countintOnline member count.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAttributesOperatedCallback

Methods

onRoomAttributesOperated

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

Parameters

NameTypeDescription
roomIDStringRoom ID.
errorKeysArrayList<String>Error key list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAttributesBatchOperatedCallback

Methods

onRoomAttributesBatchOperated

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

Parameters

NameTypeDescription
roomIDStringRoom ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAttributesQueriedCallback

Methods

onRoomAttributesQueried

onRoomAttributesQueried
Return of room attribute query results.

Parameters

NameTypeDescription
roomIDStringRoom ID.
roomAttributesHashMap<String, String>Room attributes.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMembersAttributesOperatedCallback

Methods

onRoomMembersAttributesOperated

onRoomMembersAttributesOperated
Callback of the result of setting room member attributes.

Parameters

NameTypeDescription
roomIDStringRoom ID.
infosArrayList<ZIMRoomMemberAttributesOperatedInfo>Room member attribute operation information list.
errorUserListArrayList<String>Error member list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMembersAttributesQueriedCallback

Methods

onRoomMembersAttributesQueried

onRoomMembersAttributesQueried
Returns the results of batch query of room user attributes.

Parameters

NameTypeDescription
roomIDStringRoom ID.
infosArrayList<ZIMRoomMemberAttributesInfo>Room member attribute information list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMemberAttributesListQueriedCallback

Methods

onRoomMemberAttributesListQueried

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

Parameters

NameTypeDescription
roomIDStringRoom ID.
infosArrayList<ZIMRoomMemberAttributesInfo>Room member attribute information list.
nextFlagStringUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupCreatedCallback

Methods

onGroupCreated

onGroupCreated
Returns the result of creating a group.

Parameters

NameTypeDescription
groupInfoZIMGroupFullInfoGroup information.
userListArrayList<ZIMGroupMemberInfo>Group member information list.
errorUserListArrayList<ZIMErrorUserInfo>Error member list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupDismissedCallback

Methods

onGroupDismissed

onGroupDismissed
Returns the result of dismissing the group.

Parameters

NameTypeDescription
groupIDStringGroup ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinedCallback

Methods

onGroupJoined

onGroupJoined
Returns the result of joining the group.

Parameters

NameTypeDescription
groupInfoZIMGroupFullInfoGroup information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupLeftCallback

Methods

onGroupLeft

onGroupLeft
Return of the result of leaving the group.

Parameters

NameTypeDescription
groupIDStringGroup ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupUsersInvitedCallback

Methods

onGroupUsersInvited

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
userListArrayList<ZIMGroupMemberInfo>Group member information list.
errorUserListArrayList<ZIMErrorUserInfo>Error member list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberKickedCallback

Methods

onGroupMemberKicked

onGroupMemberKicked
Returns the result of kicking out a group member.

Parameters

NameTypeDescription
groupIDStringGroup ID.
kickedUserIDListArrayList<String>List of user IDs kicked out.
errorUserListArrayList<ZIMErrorUserInfo>Error member list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupOwnerTransferredCallback

Methods

onGroupOwnerTransferred

onGroupOwnerTransferred
Returns the result of the group owner assignment.

Parameters

NameTypeDescription
groupIDStringGroup ID.
toUserIDStringNew group owner user ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupNameUpdatedCallback

Methods

onGroupNameUpdated

onGroupNameUpdated
Returns the result of the group name update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
groupNameStringGroup name.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAvatarUrlUpdatedCallback

Methods

onGroupAvatarUrlUpdated

onGroupAvatarUrlUpdated
Returns the result of the group avatar URL update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
groupAvatarUrlStringGroup avatar URL.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupNoticeUpdatedCallback

Methods

onGroupNoticeUpdated

onGroupNoticeUpdated
The return of the results of the group announcement update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
groupNoticeStringGroup notice.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAliasUpdatedCallback

Methods

onGroupAliasUpdated

onGroupAliasUpdated
Returns the result of the group alias update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
groupAliasStringGroup alias.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInfoQueriedCallback

Methods

onGroupInfoQueried

onGroupInfoQueried
Returns the result of querying group information.

Parameters

NameTypeDescription
groupInfoZIMGroupFullInfoGroup information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAttributesOperatedCallback

Methods

onGroupAttributesOperated

onGroupAttributesOperated
Returns the result of a group attribute operation.

Parameters

NameTypeDescription
groupIDStringGroup ID.
errorKeysArrayList<String>Error keys.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAttributesQueriedCallback

Methods

onGroupAttributesQueried

onGroupAttributesQueried
The return of query group attribute results.

Parameters

NameTypeDescription
groupIDStringGroup ID.
groupAttributesHashMap<String, String>Group attributes.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberRoleUpdatedCallback

Methods

onGroupMemberRoleUpdated

onGroupMemberRoleUpdated
Returns the result of the member role update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
forUserIDStringUser ID.
roleintUser role.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberNicknameUpdatedCallback

Methods

onGroupMemberNicknameUpdated

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
forUserIDStringUser ID.
nicknameStringUser nickname.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberInfoQueriedCallback

Methods

onGroupMemberInfoQueried

onGroupMemberInfoQueried
Returns the result of the group member query.

Parameters

NameTypeDescription
groupIDStringGroup ID.
userInfoZIMGroupMemberInfoGroup member user information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupListQueriedCallback

Methods

onGroupListQueried

onGroupListQueried
Returns the results of the query group list.

Parameters

NameTypeDescription
groupListArrayList<ZIMGroup>Group list.
nextFlaglongThe pagination anchor returned by the SDK is 0 if it means the list has been completely queried, and non-0 if it means there is still data to be queried.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberListQueriedCallback

Methods

onGroupMemberListQueried

onGroupMemberListQueried
Returns the result of querying the group member list.

Parameters

NameTypeDescription
groupIDStringGroup ID.
userListArrayList<ZIMGroupMemberInfo>Group member list.
nextFlagintUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberCountQueriedCallback

Methods

onGroupMemberCountQueried

onGroupMemberCountQueried
Returns the result of querying the group member count.

Parameters

NameTypeDescription
groupIDStringGroup ID.
countintGroup member count.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMessageReceiptMemberListQueriedCallback

Methods

onGroupMessageReceiptMemberListQueried

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
userListArrayList<ZIMGroupMemberInfo>Group member list.
nextFlagintUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMutedCallback

Methods

onGroupMuted

onGroupMuted
Returns the result of the group mute info update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
isMutebooleanWhether to mute.
mutedInfoZIMGroupMuteInfoGroup mute information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMembersMutedCallback

Methods

onGroupMembersMuted

onGroupMembersMuted
Returns the result of the group members mute info update.

Parameters

NameTypeDescription
groupIDStringGroup ID.
isMutebooleanWhether to mute.
durationintMute duration.
mutedUserIDsArrayList<String>List of muted member userIDs.
errorUserListArrayList<ZIMErrorUserInfo>List of user information that failed to be muted.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberMutedListQueriedCallback

Methods

onGroupMemberMutedListQueried

onGroupMemberMutedListQueried
Returns the result of querying the group muted member list.

Parameters

NameTypeDescription
groupIDStringGroup ID.
nextFlaglongUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
userListArrayList<ZIMGroupMemberInfo>Group member list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupsSearchedCallback

Methods

onGroupsSearched

onGroupsSearched
Returns the result of search a group.

Parameters

NameTypeDescription
groupSearchInfoListArrayList<ZIMGroupSearchInfo>Group search information list.
nextFlagintUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMembersSearchedCallback

Methods

onGroupMembersSearched

onGroupMembersSearched
Returns the result of search a group members.

Parameters

NameTypeDescription
groupIDStringGroup ID.
userListArrayList<ZIMGroupMemberInfo>Group member list.
nextFlagintUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinModeUpdatedCallback

Methods

onGroupJoinModeUpdated

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
modeZIMGroupJoinModeGroup join mode.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteModeUpdatedCallback

Methods

onGroupInviteModeUpdated

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
modeZIMGroupInviteModeGroup invite mode.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupBeInviteModeUpdatedCallback

Methods

onGroupBeInviteModeUpdated

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
modeZIMGroupBeInviteModeGroup be invite mode.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinApplicationSentCallback

Methods

onGroupJoinApplicationSent

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinApplicationAcceptedCallback

Methods

onGroupJoinApplicationAccepted

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
userIDStringUser ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinApplicationRejectedCallback

Methods

onGroupJoinApplicationRejected

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
userIDStringUser ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteApplicationsSentCallback

Methods

onGroupInviteApplicationsSent

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

Parameters

NameTypeDescription
groupIDStringGroup ID.
errorUserListArrayList<ZIMErrorUserInfo>Invite failed user information list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteApplicationAcceptedCallback

Methods

onGroupInviteApplicationAccepted

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

Parameters

NameTypeDescription
groupInfoZIMGroupFullInfoGroup information.
inviterUserIDStringInviter user ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteApplicationRejectedCallback

Methods

onGroupInviteApplicationRejected

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

Parameters

NameTypeDescription
groupIDStringGroup information.
inviterUserIDStringInviter user ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupApplicationListQueriedCallback

Methods

onGroupApplicationListQueried

onGroupApplicationListQueried
Query the callback of group application list.

Parameters

NameTypeDescription
applicationListArrayList<ZIMGroupApplicationInfo>Group application information list.
nextFlaglongPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallInvitationSentCallback

Methods

onCallInvitationSent

onCallInvitationSent
Action callback for sending a call invitation.

Parameters

NameTypeDescription
callIDStringCall ID.
infoZIMCallInvitationSentInfoCall invitation information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallingInvitationSentCallback

Methods

onCallingInvitationSent

onCallingInvitationSent
Callback result of inviting the current call.

Parameters

NameTypeDescription
callIDStringCall ID.
infoZIMCallingInvitationSentInfoCalling invitation information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallCancelSentCallback

Methods

onCallCancelSent

onCallCancelSent
Callback for the action to cancel the call invitation.

Parameters

NameTypeDescription
callIDStringCall ID.
errorInviteesArrayList<String>Call invitation failed user ID list.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallAcceptanceSentCallback

Methods

onCallAcceptanceSent

onCallAcceptanceSent
Action callback for accepting call invitations.

Parameters

NameTypeDescription
callIDStringCall ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallRejectionSentCallback

Methods

onCallRejectionSent

onCallRejectionSent
Action callback for rejecting a call invitation.

Parameters

NameTypeDescription
callIDStringCall ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallJoinSentCallback

Methods

onCallJoinSent

onCallJoinSent
Result callback of joining the call invitation.

Parameters

NameTypeDescription
callIDStringCall ID.
infoZIMCallJoinSentInfoCall join information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallQuitSentCallback

Methods

onCallQuitSent

onCallQuitSent
Quit the callback closure of the call invitation operation.

Parameters

NameTypeDescription
callIDStringCall ID.
infoZIMCallQuitSentInfoCall quit information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallEndSentCallback

Methods

onCallEndSent

onCallEndSent
Result callback of ending the call invitation.

Parameters

NameTypeDescription
callIDStringCall ID.
infoZIMCallEndedSentInfoCall end information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallInvitationListQueriedCallback

Methods

onCallInvitationListQueried

onCallInvitationListQueried
Result Callback of querying the call list.

Parameters

NameTypeDescription
callListArrayList<ZIMCallInfo>Call information list.
nextFlaglongPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendAddedCallback

Methods

onFriendAdded

onFriendAdded
Add a friend result callback.

Parameters

NameTypeDescription
friendInfoZIMFriendInfoFriend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsDeletedCallback

Methods

onFriendsDeleted

onFriendsDeleted
Return results of deleting friends.

Parameters

NameTypeDescription
errorUserListArrayList<ZIMErrorUserInfo>Friend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendListQueriedCallback

Methods

onFriendListQueried

onFriendListQueried
The returned result of querying the friends list.

Parameters

NameTypeDescription
friendListArrayList<ZIMFriendInfo>Friend information list.
nextFlagintPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsInfoQueriedCallback

Methods

onFriendsInfoQueried

onFriendsInfoQueried
Return results of querying friend information in batches.

Parameters

NameTypeDescription
friendInfosArrayList<ZIMFriendInfo>Friend information list.
errorUserListArrayList<ZIMErrorUserInfo>Friend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsRelationCheckedCallback

Methods

onFriendsRelationChecked

onFriendsRelationChecked
Check the friend relationship result.

Parameters

NameTypeDescription
relationInfosArrayList<ZIMFriendRelationInfo>Friend relationship information list.
errorUserListArrayList<ZIMErrorUserInfo>Friend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationSentCallback

Methods

onFriendApplicationSent

onFriendApplicationSent
The result of sending a friend application.

Parameters

NameTypeDescription
applicationInfoZIMFriendApplicationInfoFriend application information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationAcceptedCallback

Methods

onFriendApplicationAccepted

onFriendApplicationAccepted
Accept the returned result of friend application.

Parameters

NameTypeDescription
friendInfoZIMFriendInfoFriend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationRejectedCallback

Methods

onFriendApplicationRejected

onFriendApplicationRejected
Accept the returned result of friend application.

Parameters

NameTypeDescription
userInfoZIMUserInfoUser information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationListQueriedCallback

Methods

onFriendApplicationListQueried

onFriendApplicationListQueried
The result of sending a friend application.

Parameters

NameTypeDescription
applicationListArrayList<ZIMFriendApplicationInfo>Friend application information list.
nextFlagintPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendAliasUpdatedCallback

Methods

onFriendAliasUpdated

onFriendAliasUpdated
Return results of updating friend alias.

Parameters

NameTypeDescription
friendInfoZIMFriendInfoFriend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendAttributesUpdatedCallback

Methods

onFriendAttributesUpdated

onFriendAttributesUpdated
Return results of updating friend attributes.

Parameters

NameTypeDescription
friendInfoZIMFriendInfoFriend information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsSearchedCallback

Methods

onFriendsSearched

onFriendsSearched
Search results returned by local friends.

Parameters

NameTypeDescription
friendInfosArrayList<ZIMFriendInfo>Friend information list.
nextFlagintPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistUsersAddedCallback

Methods

onBlacklistUsersAdded

onBlacklistUsersAdded
Callback for operation results of adding users to the blacklist.

Parameters

NameTypeDescription
errorUserListArrayList<ZIMErrorUserInfo>User information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistUsersRemovedCallback

Methods

onBlacklistUsersRemoved

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

Parameters

NameTypeDescription
errorUserListArrayList<ZIMErrorUserInfo>User information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistQueriedCallback

Methods

onBlacklistQueried

onBlacklistQueried
Query the blacklist result callback.

Parameters

NameTypeDescription
blacklistArrayList<ZIMUserInfo>Blacklist user information list.
nextFlagintPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistCheckedCallback

Methods

onBlacklistChecked

onBlacklistChecked
Blacklist check result callback.

Parameters

NameTypeDescription
isUserInBlacklistbooleanWhether in blacklist.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityCreatedCallback

Methods

onCommunityCreated

onCommunityCreated
Callback of the result of creating a community.

Parameters

NameTypeDescription
communityInfoZIMCommunityFullInfoCommunity information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityDismissedCallback

Methods

onCommunityDismissed

onCommunityDismissed
Callback of the result of dismissing a community.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityJoinedCallback

Methods

onCommunityJoined

onCommunityJoined
Callback of the result of joining a community.

Parameters

NameTypeDescription
communityInfoZIMCommunityFullInfoCommunity information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityLeftCallback

Methods

onCommunityLeft

onCommunityLeft
Callback of the result of leaving a community.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityListQueriedCallback

Methods

onCommunityListQueried

onCommunityListQueried
Callback of the result of querying the community list.

Parameters

NameTypeDescription
communityListArrayList<ZIMCommunity>Community list.
nextFlaglongNext query community list flag.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityNameUpdatedCallback

Methods

onCommunityNameUpdated

onCommunityNameUpdated
Callback of the result of updating the community name.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
communityNameStringCommunity name.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityAvatarUrlUpdatedCallback

Methods

onCommunityAvatarUrlUpdated

onCommunityAvatarUrlUpdated
Callback of the result of updating the community avatar URL.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
communityAvatarUrlStringCommunity avatar URL.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityNoticeUpdatedCallback

Methods

onCommunityNoticeUpdated

onCommunityNoticeUpdated
Callback of the result of updating the community notice.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
communityNoticeStringCommunity notice.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityAttributesOperatedCallback

Methods

onCommunityAttributesOperated

onCommunityAttributesOperated
Callback of the result of operating community attributes.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
errorKeysArrayList<String>Error keys.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityNotificationStatusSetCallback

Methods

onCommunityNotificationStatusSet

onCommunityNotificationStatusSet
Callback of the result of setting the community notification status.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityInfoQueriedCallback

Methods

onCommunityInfoQueried

onCommunityInfoQueried
Callback of the result of querying community information.

Parameters

NameTypeDescription
communityInfoZIMCommunityFullInfoCommunity information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityUsersInvitedCallback

Methods

onCommunityUsersInvited

onCommunityUsersInvited
Callback of the result of inviting users into the community.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
errorUserListArrayList<ZIMErrorUserInfo>The error userID list
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMembersKickedCallback

Methods

onCommunityMembersKicked

onCommunityMembersKicked
Callback of the result of kicking members from the community.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
errorUserListArrayList<ZIMErrorUserInfo>The error userID list
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMemberRoleUpdatedCallback

Methods

onCommunityMemberRoleUpdated

onCommunityMemberRoleUpdated
Callback of the result of updating a community member's role.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
forUserIDStringThe user ID of the target user.
memberRoleintmember role value
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityOwnerTransferredCallback

Methods

onCommunityOwnerTransferred

onCommunityOwnerTransferred
Callback of the result of transferring the community owner.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
toUserIDStringThe user ID of the new community owner.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMemberListQueriedCallback

Methods

onCommunityMemberListQueried

onCommunityMemberListQueried
Callback of the result of querying the community member list.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
memberListArrayList<ZIMCommunityMemberInfo>Community member list.
nextFlaglongAnchor for the next community member list query.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMembersQueriedCallback

Methods

onCommunityMembersQueried

onCommunityMembersQueried
Callback of the result of querying specific community members.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
memberListArrayList<ZIMCommunityMemberInfo>List of queried community members.
errorUserListArrayList<ZIMErrorUserInfo>List of users that failed to be queried.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelCreatedCallback

Methods

onCommunityChannelCreated

onCommunityChannelCreated
Callback of the result of creating a community channel.

Parameters

NameTypeDescription
channelInfoZIMCommunityChannelFullInfoCommunity channel information.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelDismissedCallback

Methods

onCommunityChannelDismissed

onCommunityChannelDismissed
Callback of the result of dismissing a community channel.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelIDStringCommunity channel ID
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelNameUpdatedCallback

Methods

onCommunityChannelNameUpdated

onCommunityChannelNameUpdated
Callback of the result of updating the community channel name.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelIDStringCommunity channel ID
channelNameStringCommunity channel name.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelAvatarUrlUpdatedCallback

Methods

onCommunityChannelAvatarUrlUpdated

onCommunityChannelAvatarUrlUpdated
Callback of the result of updating the community channel avatar URL.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelIDStringCommunity channel ID
channelAvatarUrlStringCommunity avatar URL.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelNoticeUpdatedCallback

Methods

onCommunityChannelNoticeUpdated

onCommunityChannelNoticeUpdated
Callback of the result of updating the community channel notice.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelIDStringCommunity channel ID
channelNoticeStringCommunity channel notice.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelAttributesOperatedCallback

Methods

onCommunityChannelAttributesOperated

onCommunityChannelAttributesOperated
Callback of the result of operating community channel attributes.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelIDStringCommunity channel ID.
errorKeysArrayList<String>Error keys.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelsInfoQueriedCallback

Methods

onCommunityChannelsInfoQueried

onCommunityChannelsInfoQueried
Callback of the result of querying community channel information.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelInfosArrayList<ZIMCommunityChannelFullInfo>List of queried community channels.
errorChannelIDsArrayList<String>List of channel IDs that failed to be queried.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelListQueriedCallback

Methods

onCommunityChannelListQueried

onCommunityChannelListQueried
Callback of the result of querying the community channel list.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelListArrayList<ZIMCommunityChannel>Community channel list.
nextFlaglongAnchor for the next channel list query.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMembersMutedCallback

Methods

onCommunityMembersMuted

onCommunityMembersMuted
Callback of the result of muting community members.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
channelIDStringThe channel ID. Empty means muted at the community level.
isMutebooleanWhether to mute the members.
errorUserListArrayList<ZIMErrorUserInfo>List of users that failed to be muted.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelsMutedCallback

Methods

onCommunityChannelsMuted

onCommunityChannelsMuted
Callback of the result of muting community channels.

Parameters

NameTypeDescription
communityIDStringCommunity ID.
isMutebooleanWhether to mute the channels.
errorChannelIDsArrayList<String>List of channel IDs that failed to be muted.
errorInfoZIMErrorError code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

Previous

Class

Next

Struct

On this page

Back to top