Interface

2026-01-23


ZIM	ZIMDefines

ZIM

Methods

ZIMMessageAttachedCallback

public void ZIMMessageAttachedCallback(ZIMMessage message)

The incoming message object is given a localMessgeID and returned.

Parameters

Name	Type	Description
message	ZIMMessage	The currently sent message object.

Details

Supported version: 2.4.0 and above.

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.

ZIMMultipleMediaUploadingProgress

public void ZIMMultipleMediaUploadingProgress(ZIMMultipleMessage message,ulong currentFileSize,ulong totalFileSize,int messageInfoIndex,ulong currentIndexFileSize,ulong totalIndexFileSize)

Progress callback for sending multiple messages.

Parameters

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

Details

Supported versions: 2.19.0 and above.

Detail description: The progress callback for sending multiple messages.

Business scenario: Developers can use this callback to obtain the upload progress of the media files in the multiple message.

Notification timing: When the developer calls the [sendMessage] interface, the callback will be triggered, and will be triggered multiple times during the sending process.

Related interface: Through [sendMessage], the sending progress will be notified through this callback.

ZIMMessageImportingProgress

public void ZIMMessageImportingProgress(ulong importedMessageCount,ulong totalMessageCount)

Progress callback of the imported message.

Parameters

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

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

ZIMDefines

Methods

ZIMSubscribedUserStatusListQueriedCallback

public void ZIMSubscribedUserStatusListQueriedCallback(List< ZIMUserStatusSubscription > userStatusSubscriptionList)

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

Parameters

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

Details

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

ZIMUsersStatusQueriedCallback

public void ZIMUsersStatusQueriedCallback(List<ZIMUserStatus> userStatusList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

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

Parameters

Name	Type	Description
userStatusList	List<ZIMUserStatus>	Indicates the online status of the user to be queried.
errorUserList	List<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.

ZIMTokenRenewedCallback

public void ZIMTokenRenewedCallback(string token,ZIMError errorInfo)

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.

ZIMUsersInfoQueriedCallback

public void ZIMUsersInfoQueriedCallback(List<ZIMUserFullInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

Query the userInfo callback.

Parameters

Name	Type	Description
userList	List<ZIMUserFullInfo>	List of the userInfo queried.
errorUserList	List<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.

ZIMUserNameUpdatedCallback

public void ZIMUserNameUpdatedCallback(string userName,ZIMError errorInfo)

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].

ZIMUserAvatarUrlUpdatedCallback

public void ZIMUserAvatarUrlUpdatedCallback(string userAvatarUrl,ZIMError errorInfo)

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

public void ZIMUserExtendedDataUpdatedCallback(string extendedData,ZIMError errorInfo)

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.

ZIMLoggedInCallback

public void ZIMLoggedInCallback(ZIMError errorInfo)

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.

ZIMLogUploadedCallback

public void ZIMLogUploadedCallback(ZIMError errorInfo)

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.

ZIMSelfUserInfoQueriedCallback

public void ZIMSelfUserInfoQueriedCallback(ZIMSelfUserInfo selfUserInfo,ZIMError errorInfo)

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.

ZIMUserOfflinePushRuleUpdatedCallback

public void ZIMUserOfflinePushRuleUpdatedCallback(ZIMUserOfflinePushRule offlinePushRule,ZIMError errorInfo)

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.

ZIMCallInvitationListQueriedCallback

public void ZIMCallInvitationListQueriedCallback(List<ZIMCallInfo> callList,long nextFlag,ZIMError errorInfo)

Result Callback of querying the call list.

Parameters

Name	Type	Description
callList	List<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.

ZIMCallingInvitationSentCallback

public void ZIMCallingInvitationSentCallback(string callID,ZIMCallingInvitationSentInfo info,ZIMError errorInfo)

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.

ZIMCallQuitSentCallback

public void ZIMCallQuitSentCallback(string callID,ZIMCallQuitSentInfo info,ZIMError errorInfo)

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.

ZIMCallEndSentCallback

public void ZIMCallEndSentCallback(string callID,ZIMCallInvitationEndedInfo info,ZIMError errorInfo)

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.

ZIMCallJoinSentCallback

public void ZIMCallJoinSentCallback(string callID,ZIMCallJoinSentInfo info,ZIMError errorInfo)

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.

ZIMCallInvitationSentCallback

public void ZIMCallInvitationSentCallback(string callID,ZIMCallInvitationSentInfo info,ZIMError errorInfo)

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.

ZIMCallCancelSentCallback

public void ZIMCallCancelSentCallback(string callID,List\<string> errorInvitees,ZIMError errorInfo)

Callback for the action to cancel the call invitation.

Parameters

Name	Type	Description
callID	string	Call ID
errorInvitees	List<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.

ZIMCallAcceptanceSentCallback

public void ZIMCallAcceptanceSentCallback(string callID,ZIMError errorInfo)

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.

ZIMCallRejectionSentCallback

public void ZIMCallRejectionSentCallback(string callID,ZIMError errorInfo)

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.

ZIMGroupCreatedCallback

public void ZIMGroupCreatedCallback(ZIMGroupFullInfo groupInfo,List<ZIMGroupMemberInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

Returns the result of creating a group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	groupInfo.
userList	List<ZIMGroupMemberInfo>	user list.
errorUserList	List<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.

ZIMGroupsSearchedCallback

public void ZIMGroupsSearchedCallback(List<ZIMGroupSearchInfo> groupSearchInfoList,int nextFlag,ZIMError errorInfo)

Returns the result of search a group.

Parameters

Name	Type	Description
groupSearchInfoList	List<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.

ZIMGroupMembersSearchedCallback

public void ZIMGroupMembersSearchedCallback(string groupID,List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)

Returns the result of search a group members.

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	List<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.

ZIMGroupJoinedCallback

public void ZIMGroupJoinedCallback(ZIMGroupFullInfo groupInfo,ZIMError errorInfo)

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

public void ZIMGroupLeftCallback(string groupID,ZIMError errorInfo)

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.

ZIMGroupDismissedCallback

public void ZIMGroupDismissedCallback(string groupID,ZIMError errorInfo)

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.

ZIMGroupUsersInvitedCallback

public void ZIMGroupUsersInvitedCallback(string groupID,List<ZIMGroupMemberInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

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

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	List<ZIMGroupMemberInfo>	user list.
errorUserList	List<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.

ZIMGroupMemberKickedCallback

public void ZIMGroupMemberKickedCallback(List\<string> kickedUserIDList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

Returns the result of kicking out a group member.

Parameters

Name	Type	Description
kickedUserIDList	List<string>	List of kicked members.
errorUserList	List<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.

ZIMGroupOwnerTransferredCallback

public void ZIMGroupOwnerTransferredCallback(string groupID,string toUserID,ZIMError errorInfo)

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.

ZIMGroupNameUpdatedCallback

public void ZIMGroupNameUpdatedCallback(string groupID,string groupName,ZIMError errorInfo)

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.

ZIMGroupAvatarUrlUpdatedCallback

public void ZIMGroupAvatarUrlUpdatedCallback(string groupID,string groupAvatarUrl,ZIMError errorInfo)

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].

ZIMGroupNoticeUpdatedCallback

public void ZIMGroupNoticeUpdatedCallback(string groupNotice,ZIMError errorInfo)

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.

ZIMGroupJoinModeUpdatedCallback

public void ZIMGroupJoinModeUpdatedCallback(string groupID,ZIMGroupJoinMode mode,ZIMError errorInfo)

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.

ZIMGroupInviteModeUpdatedCallback

public void ZIMGroupInviteModeUpdatedCallback(string groupID,ZIMGroupInviteMode mode,ZIMError errorInfo)

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.

ZIMGroupBeInviteModeUpdatedCallback

public void ZIMGroupBeInviteModeUpdatedCallback(string groupID,ZIMGroupBeInviteMode mode,ZIMError errorInfo)

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.

ZIMGroupJoinApplicationSentCallback

public void ZIMGroupJoinApplicationSentCallback(string groupID,ZIMError errorInfo)

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.

ZIMGroupJoinApplicationAcceptedCallback

public void ZIMGroupJoinApplicationAcceptedCallback(string groupID,string userID,ZIMError errorInfo)

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

public void ZIMGroupJoinApplicationRejectedCallback(string groupID,string userID,ZIMError errorInfo)

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.

ZIMGroupInviteApplicationsSentCallback

public void ZIMGroupInviteApplicationsSentCallback(string groupID,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

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

Parameters

Name	Type	Description
groupID	string	Group ID.
errorUserList	List<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.

ZIMGroupInviteApplicationAcceptedCallback

public void ZIMGroupInviteApplicationAcceptedCallback(string groupID,string inviterUserID,ZIMError errorInfo)

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.

ZIMGroupApplicationListQueriedCallback

public void ZIMGroupApplicationListQueriedCallback(List<ZIMGroupApplicationInfo> applicationList,uint nextFlag,ZIMError errorInfo)

Query the callback of group application list.

Parameters

Name	Type	Description
applicationList	List<ZIMGroupApplicationInfo>	Group application list.
nextFlag	uint	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.

ZIMGroupInviteApplicationRejectedCallback

public void ZIMGroupInviteApplicationRejectedCallback(string groupID,string inviterUserID,ZIMError errorInfo)

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.

ZIMGroupInfoQueriedCallback

public void ZIMGroupInfoQueriedCallback(ZIMGroupFullInfo groupInfo,ZIMError errorInfo)

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.

ZIMGroupListQueriedCallback

public void ZIMGroupListQueriedCallback(List<ZIMGroup> groupList,ZIMError errorInfo)

Returns the results of the query group list.

Parameters

Name	Type	Description
groupList	List<ZIMGroup>	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.

ZIMGroupAttributesOperatedCallback

public void ZIMGroupAttributesOperatedCallback(string groupID,List<string> errorKeys,ZIMError errorInfo)

Returns the result of a group attribute operation.

Parameters

Name	Type	Description
groupID	string	groupID.
errorKeys	List<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

public void ZIMGroupAttributesQueriedCallback(string groupID,Dictionary<string, string> groupAttributes,ZIMError errorInfo)

The return of query group attribute results.

Parameters

Name	Type	Description
groupID	string	Group ID.
groupAttributes	Dictionary<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.

ZIMGroupMemberRoleUpdatedCallback

public void ZIMGroupMemberRoleUpdatedCallback(string groupID,string forUserID,int role,ZIMError errorInfo)

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.

ZIMGroupMemberNicknameUpdatedCallback

public void ZIMGroupMemberNicknameUpdatedCallback(string groupID,string forUserID,string nickname,ZIMError errorInfo)

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.

ZIMGroupMemberInfoQueriedCallback

public void ZIMGroupMemberInfoQueriedCallback(string groupID,ZIMGroupMemberInfo userInfo,ZIMError errorInfo)

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.

ZIMGroupMemberListQueriedCallback

public void ZIMGroupMemberListQueriedCallback(List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)

Returns the result of querying the group member list.

Parameters

Name	Type	Description
userList	List<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.

ZIMGroupMemberCountQueriedCallback

public void ZIMGroupMemberCountQueriedCallback(string groupID,int count,ZIMError errorInfo)

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.

ZIMConversationPinnedListQueriedCallback

public void ZIMConversationPinnedListQueriedCallback(List<ZIMConversation> conversationList,ZIMError errorInfo)

Callback for querying the pinned conversation list.

Parameters

Name	Type	Description
conversationList	List<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

public void ZIMConversationPinnedStateUpdatedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

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

public void ZIMConversationQueriedCallback(ZIMConversation conversation,ZIMError errorInfo)

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.

ZIMConversationListQueriedCallback

public void ZIMConversationListQueriedCallback(List<ZIMConversation> conversationList,ZIMError errorInfo)

Session list query callback.

Parameters

Name	Type	Description
conversationList	List<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.

ZIMConversationDeletedCallback

public void ZIMConversationDeletedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

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

public void ZIMConversationDraftSetCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

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.

ZIMConversationsAllDeletedCallback

public void ZIMConversationsAllDeletedCallback(ZIMError errorInfo)

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.

ZIMConversationTotalUnreadMessageCountClearedCallback

public void ZIMConversationTotalUnreadMessageCountClearedCallback(ZIMError errorInfo)

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.

ZIMConversationUnreadMessageCountClearedCallback

public void ZIMConversationUnreadMessageCountClearedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

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.

ZIMConversationNotificationStatusSetCallback

public void ZIMConversationNotificationStatusSetCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

Callback for conversation notification state settings.

Parameters

Name	Type	Description
conversationID	string	conversationID.
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.

ZIMMessageInsertedCallback

public void ZIMMessageInsertedCallback(ZIMMessage message,ZIMError errorInfo)

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.

ZIMMessageImportedCallback

public void ZIMMessageImportedCallback(ZIMError errorInfo)

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.

ZIMMessageExportedCallback

public void ZIMMessageExportedCallback(ZIMError errorInfo)

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.

ZIMMessageReactionAddedCallback

public void ZIMMessageReactionAddedCallback(ZIMMessageReaction reaction,ZIMError errorInfo)

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

public void ZIMMessageReactionDeletedCallback(ZIMMessageReaction reaction,ZIMError errorInfo)

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

public void ZIMMessageReactionUserListQueriedCallback(ZIMMessage message,List<ZIMMessageReactionUserInfo> userList,string reactionType,ulong nextFlag,int totalCount,ZIMError error)

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

Parameters

Name	Type	Description
message	ZIMMessage	message.
userList	List<ZIMMessageReactionUserInfo>	Query the detailed list of users' reactions.
reactionType	string	Types of reaction.
nextFlag	ulong	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]

ZIMMessageRepliedListQueriedCallback

public void ZIMMessageRepliedListQueriedCallback(List<ZIMMessage> messageList,ulong nextFlag,ZIMMessageRootRepliedInfo rootRepliedInfo,ZIMError error)

The callback for querying the reply message list result.

Name	Type	Description
messageList	List<ZIMMessage>	List of messages retrieved.
nextFlag	ulong	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.

ZIMMessageSentCallback

public void ZIMMessageSentCallback(ZIMMessage message,ZIMError errorInfo)

Callback of the result of sending the message.

Parameters

Name	Type	Description
message	ZIMMessage	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	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.

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 [SendPeerMessage] and [SendRoomMessage] interfaces.

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

ZIMConversationMessageReceiptReadSentCallback

public void ZIMConversationMessageReceiptReadSentCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

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.

ZIMMessageReceiptsReadSentCallback

public void ZIMMessageReceiptsReadSentCallback(zim_handle handle,string conversationID,ZIMConversationType conversationType,List\<long> errorMessageIDs,ZIMError errorInfo)

Callback interface for setting the read receipt message.

Parameters

Name	Type	Description
handle	zim_handle	The handle of the instance.
conversationID	string	ConversationID.
conversationType	ZIMConversationType	Conversation Type.
errorMessageIDs	List<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.

ZIMMessageReceiptsInfoQueriedCallback

public void ZIMMessageReceiptsInfoQueriedCallback(List<ZIMMessageReceiptInfo> infos,List\<long> errorMessageIDs,ZIMError errorInfo)

Callback interface for query receipt message read.

Parameters

Name	Type	Description
infos	List<ZIMMessageReceiptInfo>	Query receipt information.
errorMessageIDs	List<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.

ZIMGroupMessageReceiptMemberListQueriedCallback

public void ZIMGroupMessageReceiptMemberListQueriedCallback(string groupID,List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)

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

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	List<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.

ZIMMessageRevokedCallback

public void ZIMMessageRevokedCallback(ZIMMessage message,ZIMError errorInfo)

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.

ZIMMessageQueriedCallback

public void ZIMMessageQueriedCallback(string conversationID,ZIMConversationType conversationType,List<ZIMMessage> messageList,uint message_list_length,ZIMError errorInfo)

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	List<ZIMMessage>	The message list of the query result.
message_list_length	uint	The length of the message list.
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.

ZIMConversationMessagesAllDeletedCallback

public void ZIMConversationMessagesAllDeletedCallback(ZIMError errorInfo)

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].

ZIMMessageDeletedCallback

public void ZIMMessageDeletedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)

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].

ZIMMediaDownloadedCallback

public void ZIMMediaDownloadedCallback(ZIMMessage message,ZIMError errorInfo)

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

Parameters

Name	Type	Description
message	ZIMMessage	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	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.

ZIMMediaUploadingProgress

public void ZIMMediaUploadingProgress(ZIMMediaMessage * message,ulong currentFileSize,ulong totalFileSize)

Progress callback for sending media messages.

Parameters

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

Details

Supported versions: 2.1.0 and above.

Detail description: The progress callback for sending media messages.

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

Notification timing: When the developer calls the [SendMediaMessage] interface, the callback will be triggered, and will be triggered multiple times during the sending process.

Related interface: Through [SendMediaMessage], the sending progress will be notified through this callback.

ZIMMessageExportingProgress

public void ZIMMessageExportingProgress(ulong exportedMessageCount,ulong totalMessageCount)

Progress callback of the exported message.

Parameters

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

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

ZIMMediaDownloadingProgress

public void ZIMMediaDownloadingProgress(ZIMMessage * message,ulong currentFileSize,ulong totalFileSize)

Progress callback for downloading media file messages.

Parameters

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

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

ZIMMessageLocalExtendedDataUpdatedCallback

public void ZIMMessageLocalExtendedDataUpdatedCallback(ZIMMessage message,ZIMError errorInfo)

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.

ZIMMessagesSearchedCallback

public void ZIMMessagesSearchedCallback(string conversationID,ZIMConversationType conversationType,List<ZIMMessage>  messageList,ZIMMessage nextMessage,ZIMError errorInfo)

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	List<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.

ZIMMessagesGlobalSearchedCallback

public void ZIMMessagesGlobalSearchedCallback(List<ZIMMessage> messageList,ZIMMessage nextMessage,ZIMError errorInfo)

Return of local message search results.

Parameters

Name	Type	Description
messageList	List<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.

ZIMConversationsSearchedCallback

public void ZIMConversationsSearchedCallback(List<ZIMConversationSearchInfo>  conversationSearchInfoList,int nextFlag,ZIMError errorInfo)

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

Parameters

Name	Type	Description
conversationSearchInfoList	List<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.

ZIMRoomMembersQueriedCallback

public void ZIMRoomMembersQueriedCallback(string roomID,List<ZIMRoomMemberInfo> memberList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)

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

Parameters

Name	Type	Description
roomID	string	Room ID.
memberList	List<ZIMRoomMemberInfo>	List of user information.
errorUserList	List<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.

ZIMRoomMembersAttributesQueriedCallback

public void ZIMRoomMembersAttributesQueriedCallback(string roomID,List<ZIMRoomMemberAttributesInfo> infos,ZIMError errorInfo)

Returns the results of batch query of room user attributes.

Parameters

Name	Type	Description
roomID	string	Room ID.
infos	List<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.

ZIMRoomMemberAttributesListQueriedCallback

public void ZIMRoomMemberAttributesListQueriedCallback(string roomID,List<ZIMRoomMemberAttributesInfo> infos,string nextFlag,ZIMError errorInfo)

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

Parameters

Name	Type	Description
roomID	string	Room ID.
infos	List<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.

ZIMRoomCreatedCallback

public void ZIMRoomCreatedCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)

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

public void ZIMRoomEnteredCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)

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

public void ZIMRoomJoinedCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)

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

public void ZIMRoomLeftCallback(string roomID,ZIMError errorInfo)

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.

ZIMRoomMemberQueriedCallback

public void ZIMRoomMemberQueriedCallback(string roomID,List<ZIMUserInfo> memberList,string nextFlag,ZIMError errorInfo)

Callback of the result of querying the room members list.

Parameters

Name	Type	Description
roomID	string	Room ID
memberList	List<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.

ZIMRoomOnlineMemberCountQueriedCallback

public void ZIMRoomOnlineMemberCountQueriedCallback(string roomID,uint count,ZIMError errorInfo)

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

Parameters

Name	Type	Description
roomID	string	Room ID
count	uint	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.

ZIMRoomAttributesQueriedCallback

public void ZIMRoomAttributesQueriedCallback(string roomID,Dictionary<string, string> roomAttributes,ZIMError errorInfo)

Return of room attribute query results.

Parameters

Name	Type	Description
roomID	string	Room ID
roomAttributes	Dictionary<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.

ZIMRoomAttributesOperatedCallback

public void ZIMRoomAttributesOperatedCallback(string roomID,List\<string> errorKeys,ZIMError errorInfo)

The return of the operation result of the room attribute.

Parameters

Name	Type	Description
roomID	string	Room ID.
errorKeys	List<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.

ZIMRoomAttributesBatchOperatedCallback

public void ZIMRoomAttributesBatchOperatedCallback(string roomID,ZIMError errorInfo)

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.