logo
即时通讯
当前页

Interface

2026-01-21
ZIMZIMDefines

ZIM

方法

ZIMMessageAttachedCallback

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

参数

名称类型描述
messageZIMMessage当前发送的消息对象。

详情

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

  • 业务场景:在消息发送成功前,可以对应其消息 localMessageID,实现发送前 loading 的效果。
  • 通知时机:发送消息后,消息发送成功前触发。
  • 支持版本:2.4.0 及以上。

ZIMMultipleMediaUploadingProgress

ZIMMultipleMediaUploadingProgress
public void ZIMMultipleMediaUploadingProgress(ZIMMultipleMessage message,ulong currentFileSize,ulong totalFileSize,int messageInfoIndex,ulong currentIndexFileSize,ulong totalIndexFileSize)
发送组合消息的进度回调。

参数

名称类型描述
messageZIMMultipleMessage当前发送的消息对象。
currentFileSizeulong当前总共已上传的大小。
totalFileSizeulong待上传的总共的文件的大小。
messageInfoIndexint当前上传的文件所在数组的索引。
currentIndexFileSizeulong当前上传的文件的已上传的大小。
totalIndexFileSizeulong当前上传的文件的总的大小。

详情

发送组合消息的进度回调。

  • 业务场景:开发者可以通过该回调获得组合消息里的媒体文件的上传进度。
  • 通知时机:当开发者调用 [sendMessage] 接口时,会触发该回调,且在发送的过程中将会多次触发。
  • 相关接口:通过 [sendMessage],发送进度情况会通过本回调通知。
  • 支持版本:2.19.0 及以上。

ZIMMessageImportingProgress

ZIMMessageImportingProgress
public void ZIMMessageImportingProgress(ulong importedMessageCount,ulong totalMessageCount)
导入消息的进度回调。

参数

名称类型描述
importedMessageCountulong当前进度,即当前导入的消息数。
totalMessageCountulong总进度,即导入消息的总数目。

详情

导入消息的进度回调。

  • 业务场景:开发者可以通过该回调获得导入消息的进度。
  • 通知时机:当开发者调用 [ImportLocalMessages] 接口时,会触发该回调,且在导入的过程中将会多次触发。
  • 相关接口:通过 [ImportLocalMessages],导入进度情况会通过本回调通知。
  • 支持版本:2.15.0 及以上。

ZIMDefines

方法

ZIMSubscribedUserStatusListQueriedCallback

ZIMSubscribedUserStatusListQueriedCallback
public void ZIMSubscribedUserStatusListQueriedCallback(List< ZIMUserStatusSubscription > userStatusSubscriptionList)
querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

参数

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

详情

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

ZIMUsersStatusQueriedCallback

ZIMUsersStatusQueriedCallback
public void ZIMUsersStatusQueriedCallback(List<ZIMUserStatus> userStatusList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
批量查询用户在线状态接口 queryUsersStatus 的结果回调。

参数

名称类型描述
userStatusListList<ZIMUserStatus>被查询用户的在线状态信息列表。
errorUserListList<ZIMErrorUserInfo>查询失败的用户列表。
errorInfoZIMError查询操作的结果,包含错误码与错误信息。

详情

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

ZIMTokenRenewedCallback

ZIMTokenRenewedCallback
public void ZIMTokenRenewedCallback(string token,ZIMError errorInfo)
更新 Token 的结果的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否更新 Token 成功。
  • 通知时机:当开发者调用 [RenewToken] 接口时,会触发该回调。
  • 相关接口:通过 [RenewToken] 更新 Token,更新 Token 的成功与否会通过本回调通知。
  • 支持版本:1.1.0 及以上。

ZIMUsersInfoQueriedCallback

ZIMUsersInfoQueriedCallback
public void ZIMUsersInfoQueriedCallback(List<ZIMUserFullInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
查询 userInfo 的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否登录成功。
  • 通知时机:当开发者调用 [QueryUsersInfo] 接口时,会触发该回调。
  • 相关接口:通过 [QueryUsersInfo] 查询。
  • 支持版本:2.2.0 及以上。

ZIMUserNameUpdatedCallback

ZIMUserNameUpdatedCallback
public void ZIMUserNameUpdatedCallback(string userName,ZIMError errorInfo)
更新 user name 的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否操作成功。
  • 通知时机:当开发者调用 [UpdateUserName] 接口时,会触发该回调。
  • 相关接口:[UpdateUserName]。
  • 支持版本:2.2.0 及以上。

ZIMUserAvatarUrlUpdatedCallback

ZIMUserAvatarUrlUpdatedCallback
public void ZIMUserAvatarUrlUpdatedCallback(string userAvatarUrl,ZIMError errorInfo)
更新 user avatar URL 的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否操作成功。
  • 通知时机:当开发者调用 [UpdateUserAvatarUrl] 接口时,会触发该回调。
  • 相关接口:[UpdateUserAvatarUrl] 。
  • 支持版本:2.3.0 及以上。

ZIMUserExtendedDataUpdatedCallback

ZIMUserExtendedDataUpdatedCallback
public void ZIMUserExtendedDataUpdatedCallback(string extendedData,ZIMError errorInfo)
更新 user extended data 的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否操作成功。
  • 通知时机:当开发者调用 [UpdateUserExtendedData] 接口时,会触发该回调。
  • 相关接口:通过 [UpdateUserExtendedData] 查询。
  • 支持版本:2.2.0 及以上。

ZIMLoggedInCallback

ZIMLoggedInCallback
public void ZIMLoggedInCallback(ZIMError errorInfo)
登录结果的回调。

参数

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

详情

开发者登录结果的回调。

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否登录成功。
  • 通知时机:当开发者调用 [Login] 接口时,会触发该回调。
  • 支持版本:1.2.0 及以上。

ZIMLogUploadedCallback

ZIMLogUploadedCallback
public void ZIMLogUploadedCallback(ZIMError errorInfo)
日志上传结果的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否上传成功。
  • 通知时机:当开发者调用 [UploadLog] 接口时,会触发该回调。
  • 相关接口:通过 [UploadLog] 调用日志上传,成功与否会通过本回调通知。
  • 支持版本:1.2.0 及以上。

ZIMSelfUserInfoQueriedCallback

ZIMSelfUserInfoQueriedCallback
public void ZIMSelfUserInfoQueriedCallback(ZIMSelfUserInfo selfUserInfo,ZIMError errorInfo)
查询个人用户信息、规则的结果回调。

参数

名称类型描述
selfUserInfoZIMSelfUserInfo自身用户信息、规则数据类。
errorInfoZIMError包含错误码,错误信息。

详情

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

ZIMUserOfflinePushRuleUpdatedCallback

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

参数

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

详情

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

ZIMCallInvitationListQueriedCallback

ZIMCallInvitationListQueriedCallback
public void ZIMCallInvitationListQueriedCallback(List<ZIMCallInfo> callList,long nextFlag,ZIMError errorInfo)
查询呼叫列表的结果回调。

参数

名称类型描述
callListList<ZIMCallInfo>查询返回的呼叫信息列表
nextFlaglong分页查询返回的锚点,下次查询时传入可在上次查询的基础上继续查询。
errorInfoZIMError查询返回的错误信息。

详情

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

ZIMCallingInvitationSentCallback

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

参数

名称类型描述
callIDstring当前呼叫邀请的 callID。
infoZIMCallingInvitationSentInfo呼叫中邀请已发送信息。
errorInfoZIMError错误信息,详情请参考常见错误码文档。

详情

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

ZIMCallQuitSentCallback

ZIMCallQuitSentCallback
public void ZIMCallQuitSentCallback(string callID,ZIMCallQuitSentInfo info,ZIMError errorInfo)
退出呼叫操作的回调闭包。

参数

名称类型描述
callIDstring退出的 callID。
infoZIMCallQuitSentInfo退出的信息。
errorInfoZIMError错误信息。

详情

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

ZIMCallEndSentCallback

ZIMCallEndSentCallback
public void ZIMCallEndSentCallback(string callID,ZIMCallInvitationEndedInfo info,ZIMError errorInfo)
结束呼叫的结果回调。

参数

名称类型描述
callIDstring呼叫的 callID。
infoZIMCallInvitationEndedInfo结束呼叫返回的信息。
errorInfoZIMError结束呼叫返回的错误信息。

详情

结束呼叫的结果回调。

ZIMCallJoinSentCallback

ZIMCallJoinSentCallback
public void ZIMCallJoinSentCallback(string callID,ZIMCallJoinSentInfo info,ZIMError errorInfo)
加入呼叫的结果回调。
名称类型描述
callIDstring呼叫的 callID。
infoZIMCallJoinSentInfo加入呼叫返回的信息。
errorInfoZIMError加入呼叫返回的错误信息。

ZIMCallInvitationSentCallback

ZIMCallInvitationSentCallback
public void ZIMCallInvitationSentCallback(string callID,ZIMCallInvitationSentInfo info,ZIMError errorInfo)
发送呼叫邀请的操作回调。

参数

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

详情

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

  • 业务场景:进行发送呼叫邀请操作后,成功与否可以通过该回调得知。
  • 通知时机:发送呼叫邀请操作结束后的结果返回。
  • 相关接口:[CallInvite],发送呼叫邀请。
  • 支持版本:2.0.0。

ZIMCallCancelSentCallback

ZIMCallCancelSentCallback
public void ZIMCallCancelSentCallback(string callID,List\<string> errorInvitees,ZIMError errorInfo)
取消呼叫邀请的操作回调。

参数

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

详情

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

  • 业务场景:进行取消呼叫邀请操作后,成功与否可以通过该回调得知。
  • 通知时机:取消呼叫邀请操作结束后的结果返回。
  • 相关接口:[CallCancel],取消呼叫邀请。
  • 支持版本:2.0.0。

ZIMCallAcceptanceSentCallback

ZIMCallAcceptanceSentCallback
public void ZIMCallAcceptanceSentCallback(string callID,ZIMError errorInfo)
接受呼叫邀请的操作回调。

参数

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

详情

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

  • 业务场景:进行接受呼叫邀请操作后,成功与否可以通过该回调得知。
  • 通知时机:接受呼叫邀请操作结束后的结果返回。
  • 相关接口:[CallAccept],接受呼叫邀请。
  • 支持版本:2.0.0。

ZIMCallRejectionSentCallback

ZIMCallRejectionSentCallback
public void ZIMCallRejectionSentCallback(string callID,ZIMError errorInfo)
拒绝呼叫邀请的操作回调。

参数

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

详情

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

  • 业务场景:进行拒绝呼叫邀请操作后,成功与否可以通过该回调得知。
  • 通知时机:拒绝呼叫邀请操作结束后的结果返回。
  • 相关接口:[CallReject],拒绝呼叫邀请。
  • 支持版本:2.0.0。

ZIMGroupCreatedCallback

ZIMGroupCreatedCallback
public void ZIMGroupCreatedCallback(ZIMGroupFullInfo groupInfo,List<ZIMGroupMemberInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
创建群的结果的返回。

参数

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

详情

群创建操作结果的返回。

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

ZIMGroupsSearchedCallback

ZIMGroupsSearchedCallback
public void ZIMGroupsSearchedCallback(List<ZIMGroupSearchInfo> groupSearchInfoList,int nextFlag,ZIMError errorInfo)
搜索群的结果的返回。

参数

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

详情

搜索群操作结果的返回。

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

ZIMGroupMembersSearchedCallback

ZIMGroupMembersSearchedCallback
public void ZIMGroupMembersSearchedCallback(string groupID,List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)
搜索群成员的结果的返回。

参数

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

详情

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

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

ZIMGroupJoinedCallback

ZIMGroupJoinedCallback
public void ZIMGroupJoinedCallback(ZIMGroupFullInfo groupInfo,ZIMError errorInfo)
加入群的结果的返回。

参数

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

详情

群加入操作结果的返回。

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

ZIMGroupLeftCallback

ZIMGroupLeftCallback
public void ZIMGroupLeftCallback(string groupID,ZIMError errorInfo)
离开群的结果的返回。

参数

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

详情

群离开操作结果的返回。

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

ZIMGroupDismissedCallback

ZIMGroupDismissedCallback
public void ZIMGroupDismissedCallback(string groupID,ZIMError errorInfo)
解散群的结果的返回。

参数

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

详情

群解散操作结果的返回。

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

ZIMGroupUsersInvitedCallback

ZIMGroupUsersInvitedCallback
public void ZIMGroupUsersInvitedCallback(string groupID,List<ZIMGroupMemberInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
用户被邀请进群的结果的返回。

参数

名称类型描述
groupIDstring群组 ID。
userListList<ZIMGroupMemberInfo>用户列表。
errorUserListList<ZIMErrorUserInfo>邀请失败的用户列表。
errorInfoZIMError邀请用户入群的错误码。0 代表邀请用户入群,非 0为邀请用户入群失败。若出现邀请用户入群失败时,开发者应查看官网错误码文档查询解决方案。

详情

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

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

ZIMGroupMemberKickedCallback

ZIMGroupMemberKickedCallback
public void ZIMGroupMemberKickedCallback(List\<string> kickedUserIDList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
踢出群成员的结果的返回。

参数

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

详情

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

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

ZIMGroupOwnerTransferredCallback

ZIMGroupOwnerTransferredCallback
public void ZIMGroupOwnerTransferredCallback(string groupID,string toUserID,ZIMError errorInfo)
群主转让的结果的返回。

参数

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

详情

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

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

ZIMGroupNameUpdatedCallback

ZIMGroupNameUpdatedCallback
public void ZIMGroupNameUpdatedCallback(string groupID,string groupName,ZIMError errorInfo)
群名称更新的结果的返回。

参数

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

详情

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

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

ZIMGroupAvatarUrlUpdatedCallback

ZIMGroupAvatarUrlUpdatedCallback
public void ZIMGroupAvatarUrlUpdatedCallback(string groupID,string groupAvatarUrl,ZIMError errorInfo)
群头像 URL 更新的结果的返回。

参数

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

详情

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

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

ZIMGroupNoticeUpdatedCallback

ZIMGroupNoticeUpdatedCallback
public void ZIMGroupNoticeUpdatedCallback(string groupNotice,ZIMError errorInfo)
群公告更新的结果的返回。

参数

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

详情

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

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

ZIMGroupJoinModeUpdatedCallback

ZIMGroupJoinModeUpdatedCallback
public void ZIMGroupJoinModeUpdatedCallback(string groupID,ZIMGroupJoinMode mode,ZIMError errorInfo)
加群验证模式更新的回调。

参数

名称类型描述
groupIDstring群组ID。
modeZIMGroupJoinMode加群验证模式。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupInviteModeUpdatedCallback

ZIMGroupInviteModeUpdatedCallback
public void ZIMGroupInviteModeUpdatedCallback(string groupID,ZIMGroupInviteMode mode,ZIMError errorInfo)
邀请入群验证模式更新的回调。

参数

名称类型描述
groupIDstring群组ID。
modeZIMGroupInviteMode邀请入群验证模式。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupBeInviteModeUpdatedCallback

ZIMGroupBeInviteModeUpdatedCallback
public void ZIMGroupBeInviteModeUpdatedCallback(string groupID,ZIMGroupBeInviteMode mode,ZIMError errorInfo)
被邀请入群验证模式更新的回调。

参数

名称类型描述
groupIDstring群组ID。
modeZIMGroupBeInviteMode被邀请入群验证模式。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupJoinApplicationSentCallback

ZIMGroupJoinApplicationSentCallback
public void ZIMGroupJoinApplicationSentCallback(string groupID,ZIMError errorInfo)
发送加群申请的回调。

参数

名称类型描述
groupIDstring群组ID。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupJoinApplicationAcceptedCallback

ZIMGroupJoinApplicationAcceptedCallback
public void ZIMGroupJoinApplicationAcceptedCallback(string groupID,string userID,ZIMError errorInfo)
接受加群申请的回调。

参数

名称类型描述
groupIDstring群组ID。
userIDstring申请人ID。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupJoinApplicationRejectedCallback

ZIMGroupJoinApplicationRejectedCallback
public void ZIMGroupJoinApplicationRejectedCallback(string groupID,string userID,ZIMError errorInfo)
拒绝加群申请的回调。

参数

名称类型描述
groupIDstring群组ID。
userIDstring申请人ID。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupInviteApplicationsSentCallback

ZIMGroupInviteApplicationsSentCallback
public void ZIMGroupInviteApplicationsSentCallback(string groupID,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
发送邀请入群申请的回调。

参数

名称类型描述
groupIDstring群组ID。
errorUserListList<ZIMErrorUserInfo>邀请失败的用户列表。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupInviteApplicationAcceptedCallback

ZIMGroupInviteApplicationAcceptedCallback
public void ZIMGroupInviteApplicationAcceptedCallback(string groupID,string inviterUserID,ZIMError errorInfo)
接受邀请入群申请的回调。

参数

名称类型描述
groupIDstring群组ID。
inviterUserIDstring邀请人ID。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupApplicationListQueriedCallback

ZIMGroupApplicationListQueriedCallback
public void ZIMGroupApplicationListQueriedCallback(List<ZIMGroupApplicationInfo> applicationList,uint nextFlag,ZIMError errorInfo)
查询入群申请列表的回调。

参数

名称类型描述
applicationListList<ZIMGroupApplicationInfo>入群申请列表。
nextFlaguint下一个标志。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupInviteApplicationRejectedCallback

ZIMGroupInviteApplicationRejectedCallback
public void ZIMGroupInviteApplicationRejectedCallback(string groupID,string inviterUserID,ZIMError errorInfo)
拒绝邀请入群申请的回调。

参数

名称类型描述
groupIDstring群组ID。
inviterUserIDstring邀请人ID。
errorInfoZIMError更新操作的错误码。0 代表更新成功,非 0为更新失败。

详情

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

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

ZIMGroupInfoQueriedCallback

ZIMGroupInfoQueriedCallback
public void ZIMGroupInfoQueriedCallback(ZIMGroupFullInfo groupInfo,ZIMError errorInfo)
查询群信息的结果的返回。

参数

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

详情

群信息查询结果的返回。

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

ZIMGroupListQueriedCallback

ZIMGroupListQueriedCallback
public void ZIMGroupListQueriedCallback(List<ZIMGroup> groupList,ZIMError errorInfo)
查询群列表的结果的返回。

参数

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

详情

群列表查询结果的返回。

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

ZIMGroupAttributesOperatedCallback

ZIMGroupAttributesOperatedCallback
public void ZIMGroupAttributesOperatedCallback(string groupID,List<string> errorKeys,ZIMError errorInfo)
群属性操作结果的返回。

参数

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

详情

群属性操作结果的返回。

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

ZIMGroupAttributesQueriedCallback

ZIMGroupAttributesQueriedCallback
public void ZIMGroupAttributesQueriedCallback(string groupID,Dictionary<string, string> groupAttributes,ZIMError errorInfo)
查询群属性结果的返回。

参数

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

详情

群属性查询结果的返回。

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

ZIMGroupMemberRoleUpdatedCallback

ZIMGroupMemberRoleUpdatedCallback
public void ZIMGroupMemberRoleUpdatedCallback(string groupID,string forUserID,int role,ZIMError errorInfo)
成员角色更新的结果的返回。

参数

名称类型描述
groupIDstring群组 ID。
forUserIDstring用户ID。
roleint角色。
errorInfoZIMError群成员角色更新的错误码。0 代表群成员角色更新成功,非 0为 群成员角色更新失败。若出现群成员角色更新失败时,开发者应查看官网错误码文档查询解决方案。

详情

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

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

ZIMGroupMemberNicknameUpdatedCallback

ZIMGroupMemberNicknameUpdatedCallback
public void ZIMGroupMemberNicknameUpdatedCallback(string groupID,string forUserID,string nickname,ZIMError errorInfo)
群成员昵称更新的结果的返回。

参数

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

详情

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

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

ZIMGroupMemberInfoQueriedCallback

ZIMGroupMemberInfoQueriedCallback
public void ZIMGroupMemberInfoQueriedCallback(string groupID,ZIMGroupMemberInfo userInfo,ZIMError errorInfo)
群成员查询的结果的返回。

参数

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

详情

群成员查询结果的返回。

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

ZIMGroupMemberListQueriedCallback

ZIMGroupMemberListQueriedCallback
public void ZIMGroupMemberListQueriedCallback(List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)
查询群成员列表的结果的返回。

参数

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

详情

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

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

ZIMGroupMemberCountQueriedCallback

ZIMGroupMemberCountQueriedCallback
public void ZIMGroupMemberCountQueriedCallback(string groupID,int count,ZIMError errorInfo)
查询群成员数量的结果的返回。

参数

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

详情

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

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

ZIMConversationPinnedListQueriedCallback

ZIMConversationPinnedListQueriedCallback
public void ZIMConversationPinnedListQueriedCallback(List<ZIMConversation> conversationList,ZIMError errorInfo)
置顶会话列表查询回调。

参数

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

详情

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

  • 业务场景:可在该回调内做置顶会话列表查询后的逻辑。
  • 通知时机:查询置顶会话列表后触发。
  • 支持版本:2.8.0 及以上。

ZIMConversationPinnedStateUpdatedCallback

ZIMConversationPinnedStateUpdatedCallback
public void ZIMConversationPinnedStateUpdatedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
会话置顶状态变更回调。

参数

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

详情

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

  • 业务场景:可在该回调内做更新会话置顶状态后的逻辑。
  • 通知时机:调用 [UpdateConversationPinnedState] 接口更新会话置顶状态后触发。
  • 支持版本:2.8.0 及以上。

ZIMConversationQueriedCallback

ZIMConversationQueriedCallback
public void ZIMConversationQueriedCallback(ZIMConversation conversation,ZIMError errorInfo)
会话查询回调。

参数

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

详情

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

  • 业务场景:可在该回调内做会话查询后的逻辑。
  • 通知时机:调用 [QueryConversation] 接口查询会话后触发。
  • 支持版本:2.8.0 及以上。

ZIMConversationListQueriedCallback

ZIMConversationListQueriedCallback
public void ZIMConversationListQueriedCallback(List<ZIMConversation> conversationList,ZIMError errorInfo)
会话列表查询回调。

参数

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

详情

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

  • 业务场景:可在该回调内做会话列表查询后的逻辑。
  • 通知时机:查询会话列表后触发。
  • 相关接口:[QueryConversationList]
  • 支持版本:2.0.0 及以上。

ZIMConversationDeletedCallback

ZIMConversationDeletedCallback
public void ZIMConversationDeletedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
会话删除的回调。

参数

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

详情

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

  • 业务场景:可在该回调内做会话删除后的逻辑。
  • 通知时机:删除会话后触发。
  • 相关接口:[DeleteConversation]。
  • 支持版本:2.0.0 及以上。

ZIMConversationDraftSetCallback

ZIMConversationDraftSetCallback
public void ZIMConversationDraftSetCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
设置会话草稿的回调。

参数

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

详情

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

  • 业务场景:可在该回调内做设置会话草稿后的逻辑。
  • 通知时机:设置会话草稿后触发。
  • 相关接口:[setConversationDraft]。
  • 支持版本:2.14.0 及以上。

ZIMConversationsAllDeletedCallback

ZIMConversationsAllDeletedCallback
全部会话删除的回调。

参数

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

详情

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

  • 业务场景:可在该回调内做全部会话删除后的逻辑。
  • 通知时机:删除全部会话后触发。
  • 相关接口:[DeleteAllConversations]。
  • 支持版本:2.12.0 及以上。

ZIMConversationTotalUnreadMessageCountClearedCallback

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

参数

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

详情

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

  • 业务场景:可在该回调内做清除全部未读数后的逻辑。
  • 通知时机:清除全部会话未读数后触发。
  • 相关接口:[ClearConversationTotalUnreadMessageCount]
  • 支持版本:2.12.0 及以上。

ZIMConversationUnreadMessageCountClearedCallback

ZIMConversationUnreadMessageCountClearedCallback
public void ZIMConversationUnreadMessageCountClearedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
会话未读数清除的回调。

参数

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

详情

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

  • 业务场景:可在该回调内做清除未读数后的逻辑。
  • 通知时机:清除会话未读数后触发。
  • 相关接口:[ClearConversationUnreadMessageCount]
  • 支持版本:2.0.0 及以上。

ZIMConversationNotificationStatusSetCallback

ZIMConversationNotificationStatusSetCallback
public void ZIMConversationNotificationStatusSetCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
会话通知状态设置的回调。

参数

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

详情

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

  • 业务场景:可在该回调内做设置群通知状态后的逻辑。
  • 通知时机:设置群通知状态后触发。
  • 相关接口:[SetConversationNotificationStatus]。
  • 支持版本:2.0.0 及以上。

ZIMMessageInsertedCallback

ZIMMessageInsertedCallback
public void ZIMMessageInsertedCallback(ZIMMessage message,ZIMError errorInfo)
插入本地消息的结果的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否插入成功。
  • 通知时机:当开发者调用 [InsertMessageToLocalDB] 接口时,会触发该回调。
  • 相关接口:通过 [InsertMessageToLocalDB] 插入本地消息,成功与否会通过本回调通知。
  • 支持版本:2.4.0 及以上。

ZIMMessageImportedCallback

ZIMMessageImportedCallback
public void ZIMMessageImportedCallback(ZIMError errorInfo)
导入消息的结果的回调。

参数

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

详情

导入消息的结果的回调。

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

ZIMMessageExportedCallback

ZIMMessageExportedCallback
public void ZIMMessageExportedCallback(ZIMError errorInfo)
导出消息的结果的回调。

参数

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

详情

导出消息的结果的回调。

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

ZIMMessageReactionAddedCallback

ZIMMessageReactionAddedCallback
消息表态新增的返回。

参数

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

详情

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

  • 通知时机:对消息进行表态后。
  • 相关接口:[AddMessageReaction]
  • 支持版本:2.10.0 及以上。

ZIMMessageReactionDeletedCallback

ZIMMessageReactionDeletedCallback
消息表态删除的返回。

参数

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

详情

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

  • 通知时机:删除消息表态后。
  • 相关接口:[DeleteMessageReaction]
  • 支持版本:2.10.0 及以上。

ZIMMessageReactionUserListQueriedCallback

ZIMMessageReactionUserListQueriedCallback
public void ZIMMessageReactionUserListQueriedCallback(ZIMMessage message,List<ZIMMessageReactionUserInfo> userList,string reactionType,ulong nextFlag,int totalCount,ZIMError error)
消息表态详情查询的返回。

参数

名称类型描述
messageZIMMessage表态相关的消息。
userListList<ZIMMessageReactionUserInfo>查询出来的表态用户详情列表。
reactionTypestring表态的类型。
nextFlagulong查询锚点,用于下一次分页传给 [ZIMMessageReactionUserQueryConfig] 查询使用。
totalCountint表态的用户总数。
errorZIMError错误信息。

详情

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

  • 通知时机:查询消息表态的用户信息后。
  • 相关接口:[QueryMessageReactionUserList]
  • 支持版本:2.10.0 及以上。

ZIMMessageRepliedListQueriedCallback

ZIMMessageRepliedListQueriedCallback
public void ZIMMessageRepliedListQueriedCallback(List<ZIMMessage> messageList,ulong nextFlag,ZIMMessageRootRepliedInfo rootRepliedInfo,ZIMError error)
查询回复消息列表的结果的回调。
名称类型描述
messageListList<ZIMMessage>查询出来的消息列表。
nextFlagulong查询锚点,用于下一次分页传给 [ZIMMessageRepliedListQueryConfig] 查询使用。
rootRepliedInfoZIMMessageRootRepliedInfo根消息的回复信息。
errorZIMError错误信息。

ZIMMessageSentCallback

ZIMMessageSentCallback
public void ZIMMessageSentCallback(ZIMMessage message,ZIMError errorInfo)
发送消息的结果的回调。

参数

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

详情

发送消息的结果的回调。

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
  • 通知时机:当开发者调用 [SendPeerMessage] 与 [sendRoomMessage] 接口时,会触发该回调。
  • 相关接口:通过 [SendPeerMessage] 与 [SendRoomMessage] 发送消息,发送消息的成功与否会通过本回调通知。
  • 支持版本:1.1.0 及以上。

ZIMConversationMessageReceiptReadSentCallback

ZIMConversationMessageReceiptReadSentCallback
public void ZIMConversationMessageReceiptReadSentCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
设置回执会话已读的回调接口。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否设置成功。
  • 通知时机:当开发者调用 [SendConversationMessageReceiptRead] 接口时,会触发该回调。
  • 相关接口:通过 [SendConversationMessageReceiptRead] 设置回执的会话已读的结果成功与否会通过本回调通知。
  • 支持版本:2.5.0 及以上。

ZIMMessageReceiptsReadSentCallback

ZIMMessageReceiptsReadSentCallback
public void ZIMMessageReceiptsReadSentCallback(zim_handle handle,string conversationID,ZIMConversationType conversationType,List\<long> errorMessageIDs,ZIMError errorInfo)
设置回执消息已读的回调接口。

参数

名称类型描述
handlezim_handle实例的句柄。
conversationIDstring会话 ID。
conversationTypeZIMConversationType会话类型。
errorMessageIDsList<long>设置消息回执失败对应的消息ID。
errorInfoZIMError设置回执消息已读的错误码。0 代表设置成功,非 0为设置失败。若出现设置失败时,开发者应查看 官网错误码文档 查询解决方案。

详情

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

  • 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
  • 通知时机:当开发者调用 [SendMessageReceiptsRead] 接口时,会触发该回调。
  • 相关接口:通过 [SendMessageReceiptsRead] 设置回执的消息已读的结果成功与否会通过本回调通知。
  • 支持版本:2.5.0 及以上。

ZIMMessageReceiptsInfoQueriedCallback

ZIMMessageReceiptsInfoQueriedCallback
public void ZIMMessageReceiptsInfoQueriedCallback(List<ZIMMessageReceiptInfo> infos,List\<long> errorMessageIDs,ZIMError errorInfo)
查询回执消息信息的回调接口。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
  • 通知时机:当开发者调用 [QueryMessageReceiptsInfo] 接口时,会触发该回调。
  • 相关接口:通过 [QueryMessageReceiptsInfo] 查询回执的信息的结果成功与否会通过本回调通知。
  • 支持版本:2.5.0 及以上。

ZIMGroupMessageReceiptMemberListQueriedCallback

ZIMGroupMessageReceiptMemberListQueriedCallback
public void ZIMGroupMessageReceiptMemberListQueriedCallback(string groupID,List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)
查询群回执消息具体已读/未读成员列表的回调接口。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
  • 通知时机:当开发者调用 [QueryGroupMessageReceiptReadMemberList] / [QueryGroupMessageReceiptUnreadMemberList] 接口时,会触发该回调。
  • 支持版本:2.5.0 及以上。

ZIMMessageRevokedCallback

ZIMMessageRevokedCallback
public void ZIMMessageRevokedCallback(ZIMMessage message,ZIMError errorInfo)
撤回消息的结果的回调。

参数

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

详情

撤回消息的结果的回调。

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
  • 通知时机:当开发者调用 [RevokeMessage] 接口时,会触发该回调。
  • 相关接口:通过 [RevokeMessage] 撤回消息,发送消息的成功与否会通过本回调通知。
  • 支持版本:2.5.0 及以上。

ZIMMessageQueriedCallback

ZIMMessageQueriedCallback
public void ZIMMessageQueriedCallback(string conversationID,ZIMConversationType conversationType,List<ZIMMessage> messageList,uint message_list_length,ZIMError errorInfo)
开发者通过该回调获取查询到的消息列表,可以做历史消息显示。

参数

名称类型描述
conversationIDstring会话 ID。
conversationTypeZIMConversationType会话类型。
messageListList<ZIMMessage>查询结果的消息列表。
message_list_lengthuint消息列表的长度。
errorInfoZIMError查询消息的错误码。0 代表查询消息成功,非 0为查询消息失败。若出现查询消息失败时,开发者应查看官网错误码文档查询解决方案。

详情

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

  • 业务场景:开发者通过该回调获取查询到的消息列表,可以做历史消息显示。
  • 通知时机:调用查询历史消息接口 [QueryHistoryMessage] 后,查询到的消息列表会通过本回调通知。
  • 相关接口:通过 [QueryHistoryMessage] 查询历史消息,查询到的消息列表会通过本回调通知。
  • 支持版本:2.0.0 及以上。

ZIMConversationMessagesAllDeletedCallback

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

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
  • 通知时机:调用删除消息接口 [DeleteAllConversationMessages] 后触发。
  • 相关接口:[DeleteAllConversationMessages]。
  • 支持版本:2.14.0 及以上。

ZIMMessageDeletedCallback

ZIMMessageDeletedCallback
public void ZIMMessageDeletedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)
删除消息的回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否删除成功。
  • 通知时机:调用删除消息接口 [DeleteMessage] 后触发。
  • 相关接口:[DeleteMessage]。
  • 支持版本:2.0.0 及以上。

ZIMMediaDownloadedCallback

ZIMMediaDownloadedCallback
public void ZIMMediaDownloadedCallback(ZIMMessage message,ZIMError errorInfo)
下载媒体消息的结果回调。

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否下载成功。
  • 通知时机:当开发者调用 [DownloadMediaFile] 接口时,会触发该回调。
  • 相关接口:通过 [DownloadMediaFile] 下载媒体消息,成功与否会通过本回调通知。
  • 支持版本:2.1.0 及以上。

ZIMMediaUploadingProgress

ZIMMediaUploadingProgress
public void ZIMMediaUploadingProgress(ZIMMediaMessage * message,ulong currentFileSize,ulong totalFileSize)
发送媒体消息的进度回调。

参数

名称类型描述
messageZIMMediaMessage *当前文件上传的消息对象。
currentFileSizeulong当前进度,即当前文件上传的实时大小。
totalFileSizeulong总进度,即当前文件的总大小。

详情

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

  • 业务场景:开发者可以通过该回调获得媒体消息的发送进度。
  • 通知时机:当开发者调用 [SendMediaMessage] 接口时,会触发该回调,且在发送的过程中将会多次触发。
  • 相关接口:通过 [SendMediaMessage],发送进度情况会通过本回调通知。
  • 支持版本:2.1.0 及以上。

ZIMMessageExportingProgress

ZIMMessageExportingProgress
public void ZIMMessageExportingProgress(ulong exportedMessageCount,ulong totalMessageCount)
导出消息的进度回调。

参数

名称类型描述
exportedMessageCountulong当前进度,即当前导出的消息数。
totalMessageCountulong总进度,即导出消息的总数目。

详情

导出消息的进度回调。

  • 业务场景:开发者可以通过该回调获得导出消息的进度。
  • 通知时机:当开发者调用 [ExportLocalMessages] 接口时,会触发该回调,且在导出的过程中将会多次触发。
  • 相关接口:通过 [ExportLocalMessages],导出进度情况会通过本回调通知。
  • 支持版本:2.15.0 及以上。

ZIMMediaDownloadingProgress

ZIMMediaDownloadingProgress
public void ZIMMediaDownloadingProgress(ZIMMessage * message,ulong currentFileSize,ulong totalFileSize)
下载媒体文件的进度回调。

参数

名称类型描述
messageZIMMessage *当前文件下载的消息对象。
currentFileSizeulong当前进度,即当前文件下载的实时大小。
totalFileSizeulong总进度,即当前文件的总大小。

详情

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

  • 业务场景:开发者可以通过该回调获得媒体消息的下载进度。
  • 通知时机:当开发者调用 [DownloadMediaFile] 接口时,会触发该回调,且在下载的过程中将会多次触发。
  • 相关接口:通过 [DownloadMediaFile],下载进度情况会通过本回调通知。
  • 支持版本:2.1.0 及以上。

ZIMMessageLocalExtendedDataUpdatedCallback

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

参数

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

详情

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

  • 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
  • 通知时机:当开发者调用 [UpdateMessageLocalExtendedData] 接口时,会触发该回调。
  • 支持版本:2.9.0 及以上。

ZIMMessagesSearchedCallback

ZIMMessagesSearchedCallback
public void ZIMMessagesSearchedCallback(string conversationID,ZIMConversationType conversationType,List<ZIMMessage> messageList,ZIMMessage nextMessage,ZIMError errorInfo)
搜索本地消息结果的返回。

参数

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

详情

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

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

ZIMMessagesGlobalSearchedCallback

ZIMMessagesGlobalSearchedCallback
public void ZIMMessagesGlobalSearchedCallback(List<ZIMMessage> messageList,ZIMMessage nextMessage,ZIMError errorInfo)
全局搜索本地消息结果的返回。

参数

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

详情

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

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

ZIMConversationsSearchedCallback

ZIMConversationsSearchedCallback
public void ZIMConversationsSearchedCallback(List<ZIMConversationSearchInfo> conversationSearchInfoList,int nextFlag,ZIMError errorInfo)
基于本地消息搜索本地会话结果的返回。

参数

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

详情

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

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

ZIMRoomMembersQueriedCallback

ZIMRoomMembersQueriedCallback
public void ZIMRoomMembersQueriedCallback(string roomID,List<ZIMRoomMemberInfo> memberList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)
查询房间指定成员的结果回调。

参数

名称类型描述
roomIDstring房间 ID。
memberListList<ZIMRoomMemberInfo>查询成功的用户信息列表。
errorUserListList<ZIMErrorUserInfo>查询失败的用户列表。
errorInfoZIMError错误信息。

详情

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

  • 业务场景:可在该回调内做查询房间用户信息后的逻辑。
  • 通知时机:调用 [QueryRoomMembers] 接口查询房间用户信息后触发。
  • 支持版本:2.8.0 及以上。

ZIMRoomMembersAttributesQueriedCallback

ZIMRoomMembersAttributesQueriedCallback
public void ZIMRoomMembersAttributesQueriedCallback(string roomID,List<ZIMRoomMemberAttributesInfo> infos,ZIMError errorInfo)
房间用户属性批量查询结果的返回。

参数

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

详情

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

  • 业务场景:进行房间用户属性查询后,成功与否以及查询结果可以通过该回调得知。
  • 通知时机:房间用户属性查询结束后的结果返回。
  • 相关接口:[QueryRoomMembersAttributes],查询房间用户属性。
  • 支持版本:2.4.0 及以上。

ZIMRoomMemberAttributesListQueriedCallback

ZIMRoomMemberAttributesListQueriedCallback
public void ZIMRoomMemberAttributesListQueriedCallback(string roomID,List<ZIMRoomMemberAttributesInfo> infos,string nextFlag,ZIMError errorInfo)
房间内用户属性列表查询结果的返回。

参数

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

详情

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

  • 业务场景:进行房间用户属性查询后,成功与否以及查询结果可以通过该回调得知。
  • 通知时机:房间用户属性查询结束后的结果返回。
  • 相关接口:[QueryRoomMemberAttributesList],查询房间用户属性。
  • 支持版本:2.4.0 及以上。

ZIMRoomCreatedCallback

ZIMRoomCreatedCallback
public void ZIMRoomCreatedCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)
创建房间的结果的回调。

参数

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

详情

创建房间的结果回调。

  • 业务场景:当开发者创建房间时可以通过该回调来判断是否创建成功,并执行相应的业务逻辑。
  • 通知时机:当调用 [CreateRoom] 创建房间后结果会触发本回调通知。
  • 相关接口:通过 [CreateRoom] 创建房间,创建结果会通过本回调通知。
  • 支持版本:1.1.0 及以上。

ZIMRoomEnteredCallback

ZIMRoomEnteredCallback
public void ZIMRoomEnteredCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)
进入房间的结果的回调。

参数

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

详情

进入房间的结果回调。

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

ZIMRoomJoinedCallback

ZIMRoomJoinedCallback
public void ZIMRoomJoinedCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)
加入房间的结果的回调。

参数

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

详情

加入房间的结果的回调。

  • 业务场景:当开发者加入房间时,开发者可以通过该回调判断是否加入成功。
  • 通知时机:当有人加入房间时,会通过该回调通知。
  • 相关接口:通过 [JoinRoom] 加入房间,加入结果会通过本回调通知。
  • 支持版本:1.1.0 及以上。

ZIMRoomLeftCallback

ZIMRoomLeftCallback
public void ZIMRoomLeftCallback(string roomID,ZIMError errorInfo)
离开房间的结果的回调。

参数

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

详情

离开房间的结果的回调。

  • 业务场景:当用户本人需要离开房间时,开发者可以在该回调里进行业务逻辑处理。
  • 通知时机:当用户 调用 [LeaveRoom],则会触发该回调返回结果。
  • 相关接口:通过 [LeaveRoom] 离开房间,离开结果会通过本回调通知。
  • 支持版本:1.1.0 及以上。

ZIMRoomMemberQueriedCallback

ZIMRoomMemberQueriedCallback
public void ZIMRoomMemberQueriedCallback(string roomID,List<ZIMUserInfo> memberList,string nextFlag,ZIMError errorInfo)
查询房间成员列表的结果回调。

参数

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

详情

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

  • 通知时机:当调用 [QueryRoomMember] 接口进行房间成员查询时候,会触发该回调。
  • 相关接口:通过 [QueryRoomMember] 查询房间成员列表,查询结果会通过本回调通知。
  • 支持版本:1.1.0 及以上。

ZIMRoomOnlineMemberCountQueriedCallback

ZIMRoomOnlineMemberCountQueriedCallback
public void ZIMRoomOnlineMemberCountQueriedCallback(string roomID,uint count,ZIMError errorInfo)
查询房间在线成员数量回调。

参数

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

详情

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

  • 通知时机:当调用 [QueryRoomOnlineMemberCount] 接口进行查询房间成员人数时,会触发该回调。
  • 相关接口:可通过 [QueryRoomOnlineMemberCount] 查询房间在线人数。
  • 支持版本:1.1.0 及以上。

ZIMRoomAttributesQueriedCallback

ZIMRoomAttributesQueriedCallback
public void ZIMRoomAttributesQueriedCallback(string roomID,Dictionary<string, string> roomAttributes,ZIMError errorInfo)
房间属性查询结果的返回。

参数

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

详情

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

  • 业务场景:进行自定义属性查询后,成功与否以及查询结果可以通过该回调得知。
  • 通知时机:房间属性查询结束后的结果返回。
  • 相关接口:[QueryRoomAllAttributes],查询房间属性。
  • 支持版本:1.3.0。

ZIMRoomAttributesOperatedCallback

ZIMRoomAttributesOperatedCallback
public void ZIMRoomAttributesOperatedCallback(string roomID,List\<string> errorKeys,ZIMError errorInfo)
房间属性操作结果的返回。

参数

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

详情

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

  • 业务场景:进行自定义属性操作后,成功与否可以通过该回调得知。
  • 通知时机:房间属性操作结束后的结果返回。
  • 相关接口:[SetRoomAttributes],设置房间属性。[DeleteRoomAttributes],删除房间属性。
  • 支持版本:1.3.0。

ZIMRoomAttributesBatchOperatedCallback

ZIMRoomAttributesBatchOperatedCallback
public void ZIMRoomAttributesBatchOperatedCallback(string roomID,ZIMError errorInfo)
房间属性组合操作结果的返回。

参数

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

详情

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

  • 业务场景:进行自定义属性组合操作后,成功与否可以通过该回调得知。
  • 通知时机:房间属性组合操作结束后的结果返回。
  • 相关接口:[BeginRoomAttributesBatchOperation],开始房间属性组合操作。[EndRoomAttributesBatchOperation],完成房间属性组合操作。
  • 支持版本:1.3.0。

上一篇

Class

下一篇

Struct

当前页

返回到顶部