Interface
| ZIM | ZIMDefines |
ZIM
方法
ZIMMessageAttachedCallback
public void ZIMMessageAttachedCallback(ZIMMessage message)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 当前发送的消息对象。 |
详情
为传入的消息对象赋予 localMessgeID 并返回。
- 业务场景:在消息发送成功前,可以对应其消息 localMessageID,实现发送前 loading 的效果。
- 通知时机:发送消息后,消息发送成功前触发。
- 支持版本:2.4.0 及以上。
ZIMMultipleMediaUploadingProgress
public void ZIMMultipleMediaUploadingProgress(ZIMMultipleMessage message,ulong currentFileSize,ulong totalFileSize,int messageInfoIndex,ulong currentIndexFileSize,ulong totalIndexFileSize)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMultipleMessage | 当前发送的消息对象。 |
| currentFileSize | ulong | 当前总共已上传的大小。 |
| totalFileSize | ulong | 待上传的总共的文件的大小。 |
| messageInfoIndex | int | 当前上传的文件所在数组的索引。 |
| currentIndexFileSize | ulong | 当前上传的文件的已上传的大小。 |
| totalIndexFileSize | ulong | 当前上传的文件的总的大小。 |
详情
发送组合消息的进度回调。
- 业务场景:开发者可以通过该回调获得组合消息里的媒体文件的上传进度。
- 通知时机:当开发者调用 [sendMessage] 接口时,会触发该回调,且在发送的过程中将会多次触发。
- 相关接口:通过 [sendMessage],发送进度情况会通过本回调通知。
- 支持版本:2.19.0 及以上。
ZIMMessageImportingProgress
public void ZIMMessageImportingProgress(ulong importedMessageCount,ulong totalMessageCount)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| importedMessageCount | ulong | 当前进度,即当前导入的消息数。 |
| totalMessageCount | ulong | 总进度,即导入消息的总数目。 |
详情
导入消息的进度回调。
- 业务场景:开发者可以通过该回调获得导入消息的进度。
- 通知时机:当开发者调用 [ImportLocalMessages] 接口时,会触发该回调,且在导入的过程中将会多次触发。
- 相关接口:通过 [ImportLocalMessages],导入进度情况会通过本回调通知。
- 支持版本:2.15.0 及以上。
ZIMDefines
方法
ZIMSubscribedUserStatusListQueriedCallback
public void ZIMSubscribedUserStatusListQueriedCallback(List< ZIMUserStatusSubscription > userStatusSubscriptionList)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userStatusSubscriptionList | List< ZIMUserStatusSubscription > | 订阅列表中用户的订阅信息。 |
详情
querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。
ZIMUsersStatusQueriedCallback
public void ZIMUsersStatusQueriedCallback(List<ZIMUserStatus> userStatusList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userStatusList | List<ZIMUserStatus> | 被查询用户的在线状态信息列表。 |
| errorUserList | List<ZIMErrorUserInfo> | 查询失败的用户列表。 |
| errorInfo | ZIMError | 查询操作的结果,包含错误码与错误信息。 |
详情
批量查询用户在线状态接口 queryUsersStatus 的结果回调。
ZIMTokenRenewedCallback
public void ZIMTokenRenewedCallback(string token,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| token | string | 需要更新的鉴权 Token。 |
| errorInfo | ZIMError | 错误信息。错误码值为 0 时更新成功,非 0 时更新失败。若出现返回非 0 错误码的时候,开发者应到官网错误码文档中查询解决方案。 |
详情
开发者更新 Token 后,执行结果的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否更新 Token 成功。
- 通知时机:当开发者调用 [RenewToken] 接口时,会触发该回调。
- 相关接口:通过 [RenewToken] 更新 Token,更新 Token 的成功与否会通过本回调通知。
- 支持版本:1.1.0 及以上。
ZIMUsersInfoQueriedCallback
public void ZIMUsersInfoQueriedCallback(List<ZIMUserFullInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userList | List<ZIMUserFullInfo> | 查询到的 userInfo 列表。 |
| errorUserList | List<ZIMErrorUserInfo> | 查询失败的 userInfo 列表。 |
| errorInfo | ZIMError | 查询的错误码。0 代表登录成功,非 0 为登录失败。若出现查询失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者查询用户信息后的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否登录成功。
- 通知时机:当开发者调用 [QueryUsersInfo] 接口时,会触发该回调。
- 相关接口:通过 [QueryUsersInfo] 查询。
- 支持版本:2.2.0 及以上。
ZIMUserNameUpdatedCallback
public void ZIMUserNameUpdatedCallback(string userName,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userName | string | 更新后的 user name。 |
| errorInfo | ZIMError | 查询的错误码。0 代表登录成功,非 0 为登录失败。若出现查询失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者更新用户名称后的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否操作成功。
- 通知时机:当开发者调用 [UpdateUserName] 接口时,会触发该回调。
- 相关接口:[UpdateUserName]。
- 支持版本:2.2.0 及以上。
ZIMUserAvatarUrlUpdatedCallback
public void ZIMUserAvatarUrlUpdatedCallback(string userAvatarUrl,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userAvatarUrl | string | 更新后的 user avatar URL。 |
| errorInfo | ZIMError | 查询的错误码。0 代表登录成功,非 0 为登录失败。若出现查询失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者更新用户头像 URL 后的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否操作成功。
- 通知时机:当开发者调用 [UpdateUserAvatarUrl] 接口时,会触发该回调。
- 相关接口:[UpdateUserAvatarUrl] 。
- 支持版本:2.3.0 及以上。
ZIMUserExtendedDataUpdatedCallback
public void ZIMUserExtendedDataUpdatedCallback(string extendedData,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| extendedData | string | 更新后的 user extended data。 |
| errorInfo | ZIMError | 查询的错误码。0 代表登录成功,非 0 为登录失败。若出现查询失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者修改用户扩展信息后的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否操作成功。
- 通知时机:当开发者调用 [UpdateUserExtendedData] 接口时,会触发该回调。
- 相关接口:通过 [UpdateUserExtendedData] 查询。
- 支持版本:2.2.0 及以上。
ZIMLoggedInCallback
public void ZIMLoggedInCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 日志上传结果的错误信息。信息中的错误码值 0 代表成功,非 0 为失败。若出现上传失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者登录结果的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否登录成功。
- 通知时机:当开发者调用 [Login] 接口时,会触发该回调。
- 支持版本:1.2.0 及以上。
ZIMLogUploadedCallback
public void ZIMLogUploadedCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 日志上传结果的错误信息。信息中的错误码值 0 代表成功,非 0 为失败。若出现上传失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者进行上传日志后,执行结果的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否上传成功。
- 通知时机:当开发者调用 [UploadLog] 接口时,会触发该回调。
- 相关接口:通过 [UploadLog] 调用日志上传,成功与否会通过本回调通知。
- 支持版本:1.2.0 及以上。
ZIMSelfUserInfoQueriedCallback
public void ZIMSelfUserInfoQueriedCallback(ZIMSelfUserInfo selfUserInfo,ZIMError errorInfo)ZIMUserOfflinePushRuleUpdatedCallback
public void ZIMUserOfflinePushRuleUpdatedCallback(ZIMUserOfflinePushRule offlinePushRule,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| offlinePushRule | ZIMUserOfflinePushRule | 更新后的离线推送规则。 |
| errorInfo | ZIMError | 包含错误码与详细信息。 |
详情
更新用户离线推送规则的结果回调。
ZIMCallInvitationListQueriedCallback
public void ZIMCallInvitationListQueriedCallback(List<ZIMCallInfo> callList,long nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callList | List<ZIMCallInfo> | 查询返回的呼叫信息列表 |
| nextFlag | long | 分页查询返回的锚点,下次查询时传入可在上次查询的基础上继续查询。 |
| errorInfo | ZIMError | 查询返回的错误信息。 |
详情
查询呼叫列表的结果回调。
ZIMCallingInvitationSentCallback
public void ZIMCallingInvitationSentCallback(string callID,ZIMCallingInvitationSentInfo info,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 当前呼叫邀请的 callID。 |
| info | ZIMCallingInvitationSentInfo | 呼叫中邀请已发送信息。 |
| errorInfo | ZIMError | 错误信息,详情请参考常见错误码文档。 |
详情
邀请加入当前呼叫的结果回调。
ZIMCallQuitSentCallback
public void ZIMCallQuitSentCallback(string callID,ZIMCallQuitSentInfo info,ZIMError errorInfo)ZIMCallEndSentCallback
public void ZIMCallEndSentCallback(string callID,ZIMCallInvitationEndedInfo info,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 呼叫的 callID。 |
| info | ZIMCallInvitationEndedInfo | 结束呼叫返回的信息。 |
| errorInfo | ZIMError | 结束呼叫返回的错误信息。 |
详情
结束呼叫的结果回调。
ZIMCallJoinSentCallback
public void ZIMCallJoinSentCallback(string callID,ZIMCallJoinSentInfo info,ZIMError errorInfo)| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 呼叫的 callID。 |
| info | ZIMCallJoinSentInfo | 加入呼叫返回的信息。 |
| errorInfo | ZIMError | 加入呼叫返回的错误信息。 |
ZIMCallInvitationSentCallback
public void ZIMCallInvitationSentCallback(string callID,ZIMCallInvitationSentInfo info,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 已创建的呼叫邀请ID。 |
| info | ZIMCallInvitationSentInfo | 发送呼叫邀请信息。 |
| errorInfo | ZIMError | 发送呼叫邀请的错误码。0 代表发送呼叫邀请成功,非 0 为发送呼叫邀请失败。若出现发送呼叫邀请失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
发送呼叫邀请的操作回调。
- 业务场景:进行发送呼叫邀请操作后,成功与否可以通过该回调得知。
- 通知时机:发送呼叫邀请操作结束后的结果返回。
- 相关接口:[CallInvite],发送呼叫邀请。
- 支持版本:2.0.0。
ZIMCallCancelSentCallback
public void ZIMCallCancelSentCallback(string callID,List\<string> errorInvitees,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 呼叫邀请唯一 ID |
| errorInvitees | List<string> | 取消呼叫邀请失败的用户。 |
| errorInfo | ZIMError | 取消呼叫邀请的错误码。0 代表取消呼叫邀请成功,非 0 为取消呼叫邀请失败。若出现取消呼叫邀请失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
取消呼叫邀请的操作回调。
- 业务场景:进行取消呼叫邀请操作后,成功与否可以通过该回调得知。
- 通知时机:取消呼叫邀请操作结束后的结果返回。
- 相关接口:[CallCancel],取消呼叫邀请。
- 支持版本:2.0.0。
ZIMCallAcceptanceSentCallback
public void ZIMCallAcceptanceSentCallback(string callID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 呼叫邀请唯一ID |
| errorInfo | ZIMError | 接受呼叫邀请的错误码。0 代表接受呼叫邀请成功,非 0 为接受呼叫邀请失败。若出现接受呼叫邀请失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
接受呼叫邀请的操作回调。
- 业务场景:进行接受呼叫邀请操作后,成功与否可以通过该回调得知。
- 通知时机:接受呼叫邀请操作结束后的结果返回。
- 相关接口:[CallAccept],接受呼叫邀请。
- 支持版本:2.0.0。
ZIMCallRejectionSentCallback
public void ZIMCallRejectionSentCallback(string callID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| callID | string | 呼叫邀请唯一ID |
| errorInfo | ZIMError | 拒绝呼叫邀请的错误码。0 代表拒绝呼叫邀请成功,非 0 为拒绝呼叫邀请失败。若出现拒绝呼叫邀请失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
拒绝呼叫邀请的操作回调。
- 业务场景:进行拒绝呼叫邀请操作后,成功与否可以通过该回调得知。
- 通知时机:拒绝呼叫邀请操作结束后的结果返回。
- 相关接口:[CallReject],拒绝呼叫邀请。
- 支持版本:2.0.0。
ZIMGroupCreatedCallback
public void ZIMGroupCreatedCallback(ZIMGroupFullInfo groupInfo,List<ZIMGroupMemberInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupInfo | ZIMGroupFullInfo | 群组信息。 |
| userList | List<ZIMGroupMemberInfo> | 用户列表。 |
| errorUserList | List<ZIMErrorUserInfo> | 错误用户列表。 |
| errorInfo | ZIMError | 创建群组的错误码。0 代表创建群组成功,非 0 为创建群组失败。若出现创建群组失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群创建操作结果的返回。
- 业务场景:进行群创建操作后,成功与否可以通过该回调得知。
- 通知时机:群创建操作结束后的结果返回。
- 相关接口:[CreateGroup],创建群组。
ZIMGroupsSearchedCallback
public void ZIMGroupsSearchedCallback(List<ZIMGroupSearchInfo> groupSearchInfoList,int nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupSearchInfoList | List<ZIMGroupSearchInfo> | 群组信息。 |
| nextFlag | int | 分页拉取标志,搜索下一页的锚点。 |
| errorInfo | ZIMError | 搜索群组的错误码。0 代表搜索群组成功,非 0 为搜索群组失败。若出现搜索群组失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
搜索群操作结果的返回。
- 业务场景:进行群搜索操作后,成功与否可以通过该回调得知。
- 相关接口:[SearchLocalGroups],搜索群组。
ZIMGroupMembersSearchedCallback
public void ZIMGroupMembersSearchedCallback(string groupID,List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群 ID。 |
| userList | List<ZIMGroupMemberInfo> | 符合搜索条件的群成员列表。 |
| nextFlag | int | 分页拉取标志,搜索下一页的锚点。 |
| errorInfo | ZIMError | 搜索群成员的错误码。0 代表搜索群成员成功,非 0 为搜索群成员失败。若出现搜索群成员失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
搜索群成员的结果的返回。
- 业务场景:进行群成员搜索操作后,成功与否可以通过该回调得知。
- 相关接口:[SearchLocalGroupMembers],搜索群成员。
ZIMGroupJoinedCallback
public void ZIMGroupJoinedCallback(ZIMGroupFullInfo groupInfo,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupInfo | ZIMGroupFullInfo | 群信息。 |
| errorInfo | ZIMError | 加入群组的错误码。0 代表加入群组成功,非 0 为加入群组失败。若出现加入群组失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群加入操作结果的返回。
- 业务场景:进行群加入操作后,成功与否可以通过该回调得知。
- 通知时机:群加入操作结束后的结果返回。
- 相关接口:[JoinGroup],加入群组。[LeaveGroup],离开群组。
ZIMGroupLeftCallback
public void ZIMGroupLeftCallback(string groupID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| errorInfo | ZIMError | 离开群组的错误码。0 代表离开群组成功,非 0 为离开群组失败。若出现离开群组失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群离开操作结果的返回。
- 业务场景:进行群离开操作后,成功与否可以通过该回调得知。
- 通知时机:群离开操作结束后的结果返回。
- 相关接口:[LeaveGroup],离开群组。[JoinGroup],进入群组。
ZIMGroupDismissedCallback
public void ZIMGroupDismissedCallback(string groupID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| errorInfo | ZIMError | 解散群组的错误码。0 代表解散群组成功,非 0 为解散群组失败。若出现解散群组失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群解散操作结果的返回。
- 业务场景:进行群解散操作后,成功与否可以通过该回调得知。
- 通知时机:群解散操作结束后的结果返回。
- 相关接口:[CreateGroup],创建群组。[DismissGroup],解散群租。
ZIMGroupUsersInvitedCallback
public void ZIMGroupUsersInvitedCallback(string groupID,List<ZIMGroupMemberInfo> userList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| userList | List<ZIMGroupMemberInfo> | 用户列表。 |
| errorUserList | List<ZIMErrorUserInfo> | 邀请失败的用户列表。 |
| errorInfo | ZIMError | 邀请用户入群的错误码。0 代表邀请用户入群,非 0为邀请用户入群失败。若出现邀请用户入群失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
邀请用户进群操作结果的返回。
- 业务场景:用户被邀请进群后,成功与否可以通过该回调得知。
- 通知时机:用户被邀请进群后的结果返回。
- 相关接口:[InviteUsersIntoGroup],邀请用户进群。
ZIMGroupMemberKickedCallback
public void ZIMGroupMemberKickedCallback(List\<string> kickedUserIDList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| kickedUserIDList | List<string> | 被踢出的成员列表。 |
| errorUserList | List<ZIMErrorUserInfo> | 错误的用户列表。 |
| errorInfo | ZIMError | 踢出群成员的错误码。0 代表踢出群成员成功,非 0 为踢出群成员失败。若出现踢出群成员时,开发者应查看官网错误码文档查询解决方案。 |
详情
踢出群成员操作结果的返回。
- 业务场景:进行踢出群成员操作后,成功与否可以通过该回调得知。
- 通知时机:踢出群成员操作结束后的结果返回。
- 相关接口:[KickGroupMembers],踢出群成员。
ZIMGroupOwnerTransferredCallback
public void ZIMGroupOwnerTransferredCallback(string groupID,string toUserID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| toUserID | string | 用户ID。 |
| errorInfo | ZIMError | 转让群主的错误码。0 代表转让群主成功,非 0为转让群主失败。若出现转让群主失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群主转让操作结果的返回。
- 业务场景:进行群主转让操作后,成功与否可以通过该回调得知。
- 通知时机:群主转让操作结束后的结果返回。
- 相关接口:[TransferGroupOwner],群主转让。
ZIMGroupNameUpdatedCallback
public void ZIMGroupNameUpdatedCallback(string groupID,string groupName,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| groupName | string | 群名称。 |
| errorInfo | ZIMError | 更新群名称的错误码。0 代表更新群名称成功,非 0为更新群名称失败。若出现更新群名称失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群名称更新操作结果的返回。
- 业务场景:进行群名称更新操作后,成功与否可以通过该回调得知。
- 通知时机:群名称更新操作结束后的结果返回。
- 相关接口:[UpdateGroupName],群名称更新。
ZIMGroupAvatarUrlUpdatedCallback
public void ZIMGroupAvatarUrlUpdatedCallback(string groupID,string groupAvatarUrl,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| groupAvatarUrl | string | 群头像 URL。 |
| errorInfo | ZIMError | 更新群头像 URL 的错误码。0 代表更新成功,非 0为更新群名称失败。若出现失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群头像 URL 更新操作结果的返回。
- 业务场景:进行群头像 URL 更新操作后,成功与否可以通过该回调得知。
- 通知时机:群头像 URL 更新操作结束后的结果返回。
- 相关接口:[UpdateGroupAvatarUrl]。
ZIMGroupNoticeUpdatedCallback
public void ZIMGroupNoticeUpdatedCallback(string groupNotice,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupNotice | string | 群公告。 |
| errorInfo | ZIMError | 更新群公告的错误码。0 代表更新群公告成功,非 0为更新群公告失败。若出现更新群公告失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群公告更新操作结果的返回。
- 业务场景:进行群公告更新操作后,成功与否可以通过该回调得知。
- 通知时机:群公告更新操作结束后的结果返回。
- 相关接口:[UpdateGroupNotice],群公告更新。
ZIMGroupJoinModeUpdatedCallback
public void ZIMGroupJoinModeUpdatedCallback(string groupID,ZIMGroupJoinMode mode,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| mode | ZIMGroupJoinMode | 加群验证模式。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
加群验证模式更新操作结果的返回。
- 业务场景:进行加群验证模式更新操作后,成功与否可以通过该回调得知。
- 通知时机:加群验证模式更新操作结束后的结果返回。
- 相关接口:[updateGroupJoinMode],加群验证模式更新。
ZIMGroupInviteModeUpdatedCallback
public void ZIMGroupInviteModeUpdatedCallback(string groupID,ZIMGroupInviteMode mode,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| mode | ZIMGroupInviteMode | 邀请入群验证模式。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
邀请入群证模式更新操作结果的返回。
- 业务场景:进行邀请入群验证模式更新操作后,成功与否可以通过该回调得知。
- 通知时机:邀请入群验证模式更新操作结束后的结果返回。
- 相关接口:[updateGroupInviteMode],邀请入群验证模式更新。
ZIMGroupBeInviteModeUpdatedCallback
public void ZIMGroupBeInviteModeUpdatedCallback(string groupID,ZIMGroupBeInviteMode mode,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| mode | ZIMGroupBeInviteMode | 被邀请入群验证模式。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
被邀请入群证模式更新操作结果的返回。
- 业务场景:进行被邀请入群验证模式更新操作后,成功与否可以通过该回调得知。
- 通知时机:被邀请入群验证模式更新操作结束后的结果返回。
- 相关接口:[updateGroupBeInviteMode],被邀请入群验证模式更新。
ZIMGroupJoinApplicationSentCallback
public void ZIMGroupJoinApplicationSentCallback(string groupID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
发送加群申请的操作结果的返回。
- 业务场景:发送加群申请的操作后,成功与否可以通过该回调得知。
- 相关接口:[sendGroupJoinApplication],发送加群申请。
ZIMGroupJoinApplicationAcceptedCallback
public void ZIMGroupJoinApplicationAcceptedCallback(string groupID,string userID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| userID | string | 申请人ID。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
接受加群申请的操作结果的返回。
- 业务场景:接受加群申请的操作后,成功与否可以通过该回调得知。
- 相关接口:[acceptGroupJoinApplication],接受加群申请。
ZIMGroupJoinApplicationRejectedCallback
public void ZIMGroupJoinApplicationRejectedCallback(string groupID,string userID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| userID | string | 申请人ID。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
拒绝加群申请的操作结果的返回。
- 业务场景:拒绝加群申请的操作后,成功与否可以通过该回调得知。
- 相关接口:[rejectGroupJoinApplication],拒绝加群申请。
ZIMGroupInviteApplicationsSentCallback
public void ZIMGroupInviteApplicationsSentCallback(string groupID,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| errorUserList | List<ZIMErrorUserInfo> | 邀请失败的用户列表。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
发送邀请入群申请的操作结果的返回。
- 业务场景:发送邀请入群申请的操作后,成功与否可以通过该回调得知。
- 相关接口:[sendGroupInviteApplications],发送邀请入群申请。
ZIMGroupInviteApplicationAcceptedCallback
public void ZIMGroupInviteApplicationAcceptedCallback(string groupID,string inviterUserID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| inviterUserID | string | 邀请人ID。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
接受邀请入群申请的操作结果的返回。
- 业务场景:接受邀请入群申请的操作后,成功与否可以通过该回调得知。
- 相关接口:[acceptGroupInviteApplication],接受邀请入群申请。
ZIMGroupApplicationListQueriedCallback
public void ZIMGroupApplicationListQueriedCallback(List<ZIMGroupApplicationInfo> applicationList,uint nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| applicationList | List<ZIMGroupApplicationInfo> | 入群申请列表。 |
| nextFlag | uint | 下一个标志。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
入群申请列表查询结果的返回。
- 业务场景:进行入群申请列表查询后,成功与否可以通过该回调得知。
- 相关接口:[queryGroupApplicationList],查询入群申请列表。
ZIMGroupInviteApplicationRejectedCallback
public void ZIMGroupInviteApplicationRejectedCallback(string groupID,string inviterUserID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| inviterUserID | string | 邀请人ID。 |
| errorInfo | ZIMError | 更新操作的错误码。0 代表更新成功,非 0为更新失败。 |
详情
拒绝邀请入群申请的操作结果的返回。
- 业务场景:拒绝邀请入群申请的操作后,成功与否可以通过该回调得知。
- 相关接口:[rejectGroupInviteApplication],拒绝邀请入群申请。
ZIMGroupInfoQueriedCallback
public void ZIMGroupInfoQueriedCallback(ZIMGroupFullInfo groupInfo,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupInfo | ZIMGroupFullInfo | 群信息。 |
| errorInfo | ZIMError | 查询群组信息的错误码。0 代表查询群组信息成功,非 0 为查询群组信息失败。若出现查询群组信息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群信息查询结果的返回。
- 业务场景:进行群信息查询后,成功与否可以通过该回调得知。
- 通知时机:群信息查询结束后的结果返回。
- 相关接口:[QueryGroupInfo], 群信息查询。
ZIMGroupListQueriedCallback
public void ZIMGroupListQueriedCallback(List<ZIMGroup> groupList,ZIMError errorInfo)ZIMGroupAttributesOperatedCallback
public void ZIMGroupAttributesOperatedCallback(string groupID,List<string> errorKeys,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组ID。 |
| errorKeys | List<string> | 错误的键。 |
| errorInfo | ZIMError | 设置群组属性的错误码。0 代表设置群组属性成功,非 0 为设置群组属性失败。若出现设置群组属性失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群属性操作结果的返回。
- 业务场景:进行自定义属性操作后,成功与否可以通过该回调得知。
- 通知时机:群属性操作结束后的结果返回。
- 相关接口:[SetGroupAttributes],设置房间属性。[DeleteGroupAttributes],删除房间属性。
ZIMGroupAttributesQueriedCallback
public void ZIMGroupAttributesQueriedCallback(string groupID,Dictionary<string, string> groupAttributes,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| groupAttributes | Dictionary<string, string> | 群属性。 |
| errorInfo | ZIMError | 查询群组属性的错误码。0 代表查询群组属性成功,非 0 为查询群组属性失败。若出现查询群组属性失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群属性查询结果的返回。
- 业务场景:进行自定义属性查询后,成功与否可以通过该回调得知。
- 通知时机:群属性查询后的结果返回。
- 相关接口:[QueryGroupAttributes],查询房间属性。
ZIMGroupMemberRoleUpdatedCallback
public void ZIMGroupMemberRoleUpdatedCallback(string groupID,string forUserID,int role,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| forUserID | string | 用户ID。 |
| role | int | 角色。 |
| errorInfo | ZIMError | 群成员角色更新的错误码。0 代表群成员角色更新成功,非 0为 群成员角色更新失败。若出现群成员角色更新失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
成员角色更新操作结果的返回。
- 业务场景:进行成员角色更新操作后,成功与否可以通过该回调得知。
- 通知时机:成员角色更新操作结束后的结果返回。
- 相关接口:[SetGroupMemberRole],成员角色更新。
ZIMGroupMemberNicknameUpdatedCallback
public void ZIMGroupMemberNicknameUpdatedCallback(string groupID,string forUserID,string nickname,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| forUserID | string | 用户ID。 |
| nickname | string | 用户昵称。 |
| errorInfo | ZIMError | 设置群成员昵称的错误码。0 代表设置群成员昵称成功,非 0 为设置群成员昵称失败。若出现设置群成员昵称失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群成员昵称更新操作结果的返回。
- 业务场景:进行群成员昵称更新操作后,成功与否可以通过该回调得知。
- 通知时机:群成员昵称更新操作结束后的结果返回。
- 相关接口:[SetGroupMemberNickname], 群成员昵称更新。
ZIMGroupMemberInfoQueriedCallback
public void ZIMGroupMemberInfoQueriedCallback(string groupID,ZIMGroupMemberInfo userInfo,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| userInfo | ZIMGroupMemberInfo | 群成员信息。 |
| errorInfo | ZIMError | 查询群组成员的错误码。0 代表查询群组成员成功,非 0 为查询群组成员失败。若出现查询群组成员失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
群成员查询结果的返回。
- 业务场景:进行群成员查询后,成功与否可以通过该回调得知。
- 通知时机:群成员查询后的结果返回。
- 相关接口:[QueryGroupMemberInfo],群成员查询。
ZIMGroupMemberListQueriedCallback
public void ZIMGroupMemberListQueriedCallback(List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userList | List<ZIMGroupMemberInfo> | 成员列表。 |
| nextFlag | int | 下一个标志。 |
| errorInfo | ZIMError | 查询群成员列表的错误码。0 代表查询群成员列表成功,非 0 为查询群成员列表失败。若出现查询群成员列表失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询群成员列表操作结果的返回。
- 业务场景:进行查询群成员列表操作后,成功与否可以通过该回调得知。
- 通知时机:查询群成员列表操作结束后的结果返回。
- 相关接口:[QueryGroupMemberList],查询群成员列表。
ZIMGroupMemberCountQueriedCallback
public void ZIMGroupMemberCountQueriedCallback(string groupID,int count,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 成员数量。 |
| count | int | 下一个标志。 |
| errorInfo | ZIMError | 查询群成员数量的错误码。0 代表查询群成员数量成功,非 0 为查询群成员数量失败。若出现查询群成员数量失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询群成员数量操作结果的返回。
- 业务场景:进行查询群成员数量操作后,成功与否可以通过该回调得知。
- 通知时机:查询群成员数量操作结束后的结果返回。
- 相关接口:[QueryGroupMemberCount],查询群成员数量。
ZIMConversationPinnedListQueriedCallback
public void ZIMConversationPinnedListQueriedCallback(List<ZIMConversation> conversationList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationList | List<ZIMConversation> | 置顶会话列表。 |
| errorInfo | ZIMError | 查询置顶会话列表的错误信息。0 代表查询置顶会话列表成功,非 0 为查询置顶会话列表失败。若出现查询置顶会话列表失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询置顶会话列表后通过该回调返回查询结果。
- 业务场景:可在该回调内做置顶会话列表查询后的逻辑。
- 通知时机:查询置顶会话列表后触发。
- 支持版本:2.8.0 及以上。
ZIMConversationPinnedStateUpdatedCallback
public void ZIMConversationPinnedStateUpdatedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorInfo | ZIMError | 更新会话置顶状态的错误码。0 代表更新会话置顶状态成功,非 0为更新会话置顶状态失败。若出现更新会话置顶状态失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
更新会话置顶状态后通过该回调返回结果。
- 业务场景:可在该回调内做更新会话置顶状态后的逻辑。
- 通知时机:调用 [UpdateConversationPinnedState] 接口更新会话置顶状态后触发。
- 支持版本:2.8.0 及以上。
ZIMConversationQueriedCallback
public void ZIMConversationQueriedCallback(ZIMConversation conversation,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversation | ZIMConversation | 会话对象。 |
| errorInfo | ZIMError | 查询会话的错误码。0 代表查询会话成功,非 0 为查询会话失败。若出现查询会话失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询会话后通过该回调返回查询结果。
- 业务场景:可在该回调内做会话查询后的逻辑。
- 通知时机:调用 [QueryConversation] 接口查询会话后触发。
- 支持版本:2.8.0 及以上。
ZIMConversationListQueriedCallback
public void ZIMConversationListQueriedCallback(List<ZIMConversation> conversationList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationList | List<ZIMConversation> | 会话列表。 |
| errorInfo | ZIMError | 查询回话列表的错误码。0 代表查询回话列表成功,非 0 为查询回话列表失败。若出现查询回话列表失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询会话列表后通过该回调返回查询结果。
- 业务场景:可在该回调内做会话列表查询后的逻辑。
- 通知时机:查询会话列表后触发。
- 相关接口:[QueryConversationList]
- 支持版本:2.0.0 及以上。
ZIMConversationDeletedCallback
public void ZIMConversationDeletedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorInfo | ZIMError | 删除回话的错误码。0 代表删除回话成功,非 0为删除回话失败。若出现删除回话失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
删除会话后通过该回调返回删除结果。
- 业务场景:可在该回调内做会话删除后的逻辑。
- 通知时机:删除会话后触发。
- 相关接口:[DeleteConversation]。
- 支持版本:2.0.0 及以上。
ZIMConversationDraftSetCallback
public void ZIMConversationDraftSetCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorInfo | ZIMError | 设置会话草稿的错误码。0 代表设置会话草稿成功,非 0为设置会话草稿失败。若出现设置会话草稿失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
设置会话草稿后,通过该回调返回操作结果。
- 业务场景:可在该回调内做设置会话草稿后的逻辑。
- 通知时机:设置会话草稿后触发。
- 相关接口:[setConversationDraft]。
- 支持版本:2.14.0 及以上。
ZIMConversationsAllDeletedCallback
public void ZIMConversationsAllDeletedCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 删除全部会话的错误码。0 代表删除全部会话成功,非 0为删除全部会话失败。若出现删除全部会话失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
删除全部会话后通过该回调返回删除结果。
- 业务场景:可在该回调内做全部会话删除后的逻辑。
- 通知时机:删除全部会话后触发。
- 相关接口:[DeleteAllConversations]。
- 支持版本:2.12.0 及以上。
ZIMConversationTotalUnreadMessageCountClearedCallback
public void ZIMConversationTotalUnreadMessageCountClearedCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 清除全部会话未读数数量的错误码。0 代表清除全部会话未读数数量成功,非 0为清除全部会话未读数数量失败。若出现清除全部会话未读数数量失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
清除全部会话未读数后通过该回调返回清除会话的结果。
- 业务场景:可在该回调内做清除全部未读数后的逻辑。
- 通知时机:清除全部会话未读数后触发。
- 相关接口:[ClearConversationTotalUnreadMessageCount]
- 支持版本:2.12.0 及以上。
ZIMConversationUnreadMessageCountClearedCallback
public void ZIMConversationUnreadMessageCountClearedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorInfo | ZIMError | 清除回话未读数数量的错误码。0 代表清除回话未读数数量成功,非 0为清除回话未读数数量失败。若出现清除回话未读数数量失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
清除会话未读数后通过该回调返回清除会话的结果。
- 业务场景:可在该回调内做清除未读数后的逻辑。
- 通知时机:清除会话未读数后触发。
- 相关接口:[ClearConversationUnreadMessageCount]
- 支持版本:2.0.0 及以上。
ZIMConversationNotificationStatusSetCallback
public void ZIMConversationNotificationStatusSetCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorInfo | ZIMError | 设置回话通知状态的错误码。0 代表设置回话通知状态成功,非 0为设置回话通知状态失败。若出现设置回话通知状态失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
设置群通知状态后通过该回调返回群通知的结果。
- 业务场景:可在该回调内做设置群通知状态后的逻辑。
- 通知时机:设置群通知状态后触发。
- 相关接口:[SetConversationNotificationStatus]。
- 支持版本:2.0.0 及以上。
ZIMMessageInsertedCallback
public void ZIMMessageInsertedCallback(ZIMMessage message,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 消息对象。 |
| errorInfo | ZIMError | 插入本地消息的错误码。0 代表插入消息成功,非 0 为插入消息失败。若出现插入消息失败时,开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。 |
详情
插入本地消息的结果的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否插入成功。
- 通知时机:当开发者调用 [InsertMessageToLocalDB] 接口时,会触发该回调。
- 相关接口:通过 [InsertMessageToLocalDB] 插入本地消息,成功与否会通过本回调通知。
- 支持版本:2.4.0 及以上。
ZIMMessageImportedCallback
public void ZIMMessageImportedCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 导入消息的错误码。0 代表导入消息成功,非 0 为导入消息失败。 |
详情
导入消息的结果的回调。
- 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否导入成功。
- 通知时机:当开发者调用 [importLocalMessages] 接口时,会触发该回调。
- 相关接口:通过 [importLocalMessages] 导入消息,成功与否会通过本回调通知。
- 支持版本:2.15.0 及以上。
ZIMMessageExportedCallback
public void ZIMMessageExportedCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 导出消息的错误码。0 代表导出消息成功,非 0 为导出消息失败。 |
详情
导出消息的结果的回调。
- 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否导出成功。
- 通知时机:当开发者调用 [exportLocalMessages] 接口时,会触发该回调。
- 相关接口:通过 [exportLocalMessages] 导出消息,成功与否会通过本回调通知。
- 支持版本:2.15.0 及以上。
ZIMMessageReactionAddedCallback
public void ZIMMessageReactionAddedCallback(ZIMMessageReaction reaction,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| reaction | ZIMMessageReaction | 表态数据。 |
| errorInfo | ZIMError | 添加消息表态的错误码,0 代表操作成功,非 0 代表操作失败,请参考官网文档(https://doc-zh.zego.im/article/11605)获取解决方案。 |
详情
消息表态新增操作的结果。
- 通知时机:对消息进行表态后。
- 相关接口:[AddMessageReaction]
- 支持版本:2.10.0 及以上。
ZIMMessageReactionDeletedCallback
public void ZIMMessageReactionDeletedCallback(ZIMMessageReaction reaction,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| reaction | ZIMMessageReaction | 表态数据。 |
| errorInfo | ZIMError | 删除消息表态的错误码,0 代表操作成功,非 0 代表操作失败,请参考官网文档(https://doc-zh.zego.im/article/11605)获取解决方案。 |
详情
消息表态删除操作的结果。
- 通知时机:删除消息表态后。
- 相关接口:[DeleteMessageReaction]
- 支持版本:2.10.0 及以上。
ZIMMessageReactionUserListQueriedCallback
public void ZIMMessageReactionUserListQueriedCallback(ZIMMessage message,List<ZIMMessageReactionUserInfo> userList,string reactionType,ulong nextFlag,int totalCount,ZIMError error)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 表态相关的消息。 |
| userList | List<ZIMMessageReactionUserInfo> | 查询出来的表态用户详情列表。 |
| reactionType | string | 表态的类型。 |
| nextFlag | ulong | 查询锚点,用于下一次分页传给 [ZIMMessageReactionUserQueryConfig] 查询使用。 |
| totalCount | int | 表态的用户总数。 |
| error | ZIMError | 错误信息。 |
详情
消息表态用户信息查询操作的结果。
- 通知时机:查询消息表态的用户信息后。
- 相关接口:[QueryMessageReactionUserList]
- 支持版本:2.10.0 及以上。
ZIMMessageRepliedListQueriedCallback
public void ZIMMessageRepliedListQueriedCallback(List<ZIMMessage> messageList,ulong nextFlag,ZIMMessageRootRepliedInfo rootRepliedInfo,ZIMError error)| 名称 | 类型 | 描述 |
|---|---|---|
| messageList | List<ZIMMessage> | 查询出来的消息列表。 |
| nextFlag | ulong | 查询锚点,用于下一次分页传给 [ZIMMessageRepliedListQueryConfig] 查询使用。 |
| rootRepliedInfo | ZIMMessageRootRepliedInfo | 根消息的回复信息。 |
| error | ZIMError | 错误信息。 |
ZIMMessageSentCallback
public void ZIMMessageSentCallback(ZIMMessage message,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 发送的消息对象,可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。 |
| errorInfo | ZIMError | 发送消息的错误码。0 代表发送消息成功,非 0为发送消息失败。若出现发送消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
发送消息的结果的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
- 通知时机:当开发者调用 [SendPeerMessage] 与 [sendRoomMessage] 接口时,会触发该回调。
- 相关接口:通过 [SendPeerMessage] 与 [SendRoomMessage] 发送消息,发送消息的成功与否会通过本回调通知。
- 支持版本:1.1.0 及以上。
ZIMConversationMessageReceiptReadSentCallback
public void ZIMConversationMessageReceiptReadSentCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorInfo | ZIMError | 设置回执会话已读的错误码。0 代表设置成功,非 0为设置失败。若出现设置失败时,开发者应查看 官网错误码文档 查询解决方案。 |
详情
设置回执会话已读的回调接口。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否设置成功。
- 通知时机:当开发者调用 [SendConversationMessageReceiptRead] 接口时,会触发该回调。
- 相关接口:通过 [SendConversationMessageReceiptRead] 设置回执的会话已读的结果成功与否会通过本回调通知。
- 支持版本:2.5.0 及以上。
ZIMMessageReceiptsReadSentCallback
public void ZIMMessageReceiptsReadSentCallback(zim_handle handle,string conversationID,ZIMConversationType conversationType,List\<long> errorMessageIDs,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| handle | zim_handle | 实例的句柄。 |
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| errorMessageIDs | List<long> | 设置消息回执失败对应的消息ID。 |
| errorInfo | ZIMError | 设置回执消息已读的错误码。0 代表设置成功,非 0为设置失败。若出现设置失败时,开发者应查看 官网错误码文档 查询解决方案。 |
详情
设置回执消息已读的回调接口。
- 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
- 通知时机:当开发者调用 [SendMessageReceiptsRead] 接口时,会触发该回调。
- 相关接口:通过 [SendMessageReceiptsRead] 设置回执的消息已读的结果成功与否会通过本回调通知。
- 支持版本:2.5.0 及以上。
ZIMMessageReceiptsInfoQueriedCallback
public void ZIMMessageReceiptsInfoQueriedCallback(List<ZIMMessageReceiptInfo> infos,List\<long> errorMessageIDs,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| infos | List<ZIMMessageReceiptInfo> | 查询出来的回执信息。 |
| errorMessageIDs | List<long> | 查询消息回执信息错误的消息ID。 |
| errorInfo | ZIMError | 查询消息回执的错误码。0 代表查询成功,非 0 为查询失败。若出现查询失败时,开发者应查看 官网错误码文档 查询解决方案。 |
详情
查询回执消息信息的回调接口。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
- 通知时机:当开发者调用 [QueryMessageReceiptsInfo] 接口时,会触发该回调。
- 相关接口:通过 [QueryMessageReceiptsInfo] 查询回执的信息的结果成功与否会通过本回调通知。
- 支持版本:2.5.0 及以上。
ZIMGroupMessageReceiptMemberListQueriedCallback
public void ZIMGroupMessageReceiptMemberListQueriedCallback(string groupID,List<ZIMGroupMemberInfo> userList,int nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groupID | string | 群组 ID。 |
| userList | List<ZIMGroupMemberInfo> | 查询成功的群用户列表。 |
| nextFlag | int | 查询下一页对应的 flag,用于给 [ZIMGroupMessageReceiptMemberQueryConfig] 的 nextFlag 参数使用。 |
| errorInfo | ZIMError | 设置查询群成员列表返回的错误码。0 代表查询成功,非 0为查询失败。若出现查询失败时,开发者应查看 官网错误码文档 查询解决方案。 |
详情
查询群回执消息具体已读/未读成员列表的回调接口。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
- 通知时机:当开发者调用 [QueryGroupMessageReceiptReadMemberList] / [QueryGroupMessageReceiptUnreadMemberList] 接口时,会触发该回调。
- 支持版本:2.5.0 及以上。
ZIMMessageRevokedCallback
public void ZIMMessageRevokedCallback(ZIMMessage message,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 消息对象。 |
| errorInfo | ZIMError | 撤回消息的错误码。0 代表撤回成功,非 0为撤回失败。若出现撤回失败时,开发者应查看 官网错误码文档 查询解决方案。 |
详情
撤回消息的结果的回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否发送成功。
- 通知时机:当开发者调用 [RevokeMessage] 接口时,会触发该回调。
- 相关接口:通过 [RevokeMessage] 撤回消息,发送消息的成功与否会通过本回调通知。
- 支持版本:2.5.0 及以上。
ZIMMessageQueriedCallback
public void ZIMMessageQueriedCallback(string conversationID,ZIMConversationType conversationType,List<ZIMMessage> messageList,uint message_list_length,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID。 |
| conversationType | ZIMConversationType | 会话类型。 |
| messageList | List<ZIMMessage> | 查询结果的消息列表。 |
| message_list_length | uint | 消息列表的长度。 |
| errorInfo | ZIMError | 查询消息的错误码。0 代表查询消息成功,非 0为查询消息失败。若出现查询消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询消息列表的结果回调。
- 业务场景:开发者通过该回调获取查询到的消息列表,可以做历史消息显示。
- 通知时机:调用查询历史消息接口 [QueryHistoryMessage] 后,查询到的消息列表会通过本回调通知。
- 相关接口:通过 [QueryHistoryMessage] 查询历史消息,查询到的消息列表会通过本回调通知。
- 支持版本:2.0.0 及以上。
ZIMConversationMessagesAllDeletedCallback
public void ZIMConversationMessagesAllDeletedCallback(ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorInfo | ZIMError | 删除消息的错误码。0 代表删除消息成功,非 0为删除消息失败。若出现删除消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
删除全部会话的全部消息后通过该回调返回消息删除的结果。
- 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
- 通知时机:调用删除消息接口 [DeleteAllConversationMessages] 后触发。
- 相关接口:[DeleteAllConversationMessages]。
- 支持版本:2.14.0 及以上。
ZIMMessageDeletedCallback
public void ZIMMessageDeletedCallback(string conversationID,ZIMConversationType conversationType,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID |
| conversationType | ZIMConversationType | 会话类型 |
| errorInfo | ZIMError | 删除消息的错误码。0 代表删除消息成功,非 0为删除消息失败。若出现删除消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
删除消息后通过该回调返回消息删除的结果。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否删除成功。
- 通知时机:调用删除消息接口 [DeleteMessage] 后触发。
- 相关接口:[DeleteMessage]。
- 支持版本:2.0.0 及以上。
ZIMMediaDownloadedCallback
public void ZIMMediaDownloadedCallback(ZIMMessage message,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 发送的消息对象,可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。 |
| errorInfo | ZIMError | 发送消息的错误码。0 代表发送消息成功,非 0为发送消息失败。若出现发送消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
媒体消息下载的结果回调。
- 业务场景:开发者可以通过该回调中的 [ErrorCode] 判断是否下载成功。
- 通知时机:当开发者调用 [DownloadMediaFile] 接口时,会触发该回调。
- 相关接口:通过 [DownloadMediaFile] 下载媒体消息,成功与否会通过本回调通知。
- 支持版本:2.1.0 及以上。
ZIMMediaUploadingProgress
public void ZIMMediaUploadingProgress(ZIMMediaMessage * message,ulong currentFileSize,ulong totalFileSize)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMediaMessage * | 当前文件上传的消息对象。 |
| currentFileSize | ulong | 当前进度,即当前文件上传的实时大小。 |
| totalFileSize | ulong | 总进度,即当前文件的总大小。 |
详情
发送媒体消息的进度回调。
- 业务场景:开发者可以通过该回调获得媒体消息的发送进度。
- 通知时机:当开发者调用 [SendMediaMessage] 接口时,会触发该回调,且在发送的过程中将会多次触发。
- 相关接口:通过 [SendMediaMessage],发送进度情况会通过本回调通知。
- 支持版本:2.1.0 及以上。
ZIMMessageExportingProgress
public void ZIMMessageExportingProgress(ulong exportedMessageCount,ulong totalMessageCount)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| exportedMessageCount | ulong | 当前进度,即当前导出的消息数。 |
| totalMessageCount | ulong | 总进度,即导出消息的总数目。 |
详情
导出消息的进度回调。
- 业务场景:开发者可以通过该回调获得导出消息的进度。
- 通知时机:当开发者调用 [ExportLocalMessages] 接口时,会触发该回调,且在导出的过程中将会多次触发。
- 相关接口:通过 [ExportLocalMessages],导出进度情况会通过本回调通知。
- 支持版本:2.15.0 及以上。
ZIMMediaDownloadingProgress
public void ZIMMediaDownloadingProgress(ZIMMessage * message,ulong currentFileSize,ulong totalFileSize)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage * | 当前文件下载的消息对象。 |
| currentFileSize | ulong | 当前进度,即当前文件下载的实时大小。 |
| totalFileSize | ulong | 总进度,即当前文件的总大小。 |
详情
下载媒体消息的进度回调。
- 业务场景:开发者可以通过该回调获得媒体消息的下载进度。
- 通知时机:当开发者调用 [DownloadMediaFile] 接口时,会触发该回调,且在下载的过程中将会多次触发。
- 相关接口:通过 [DownloadMediaFile],下载进度情况会通过本回调通知。
- 支持版本:2.1.0 及以上。
ZIMMessageLocalExtendedDataUpdatedCallback
public void ZIMMessageLocalExtendedDataUpdatedCallback(ZIMMessage message,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 更新后消息对象。 |
| errorInfo | ZIMError | 查询的错误码。0 代表登录成功,非 0 为登录失败。若出现查询失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
开发者修改消息本地扩展信息后的回调。
- 业务场景:开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
- 通知时机:当开发者调用 [UpdateMessageLocalExtendedData] 接口时,会触发该回调。
- 支持版本:2.9.0 及以上。
ZIMMessagesSearchedCallback
public void ZIMMessagesSearchedCallback(string conversationID,ZIMConversationType conversationType,List<ZIMMessage> messageList,ZIMMessage nextMessage,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationID | string | 会话 ID,单聊时,conversationID 即是对方的 userID。群组时,conversationID 即是群组的 groupID。 |
| conversationType | ZIMConversationType | 会话类型。0:单聊 1:房间 2:群组,注意:“房间”场景下,默认不支持缓存和搜索离线消息。 |
| messageList | List<ZIMMessage> | 搜索到的消息列表。 |
| nextMessage | ZIMMessage | 分页拉取标志,搜索下一页的消息锚点。 |
| errorInfo | ZIMError | 搜索本地消息的错误码。0 代表搜索本地消息成功,非 0 为搜索本地消息失败。若出现搜索本地消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
搜索本地消息结果的返回。
- 业务场景:进行本地消息搜索操作后,成功与否可以通过该回调得知。
- 相关接口:[searchLocalMessages],搜索本地消息。
ZIMMessagesGlobalSearchedCallback
public void ZIMMessagesGlobalSearchedCallback(List<ZIMMessage> messageList,ZIMMessage nextMessage,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| messageList | List<ZIMMessage> | 全局搜索到的消息列表。 |
| nextMessage | ZIMMessage | 分页拉取标志,搜索下一页的消息锚点。 |
| errorInfo | ZIMError | 全局搜索本地消息的错误码。0 代表全局搜索本地消息成功,非 0 为全局搜索本地消息失败。若出现全局搜索本地消息失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
全局搜索本地消息结果的返回。
- 业务场景:进行全局本地消息搜索操作后,成功与否可以通过该回调得知。
- 相关接口:[searchGlobalLocalMessages],全局搜索本地消息。
ZIMConversationsSearchedCallback
public void ZIMConversationsSearchedCallback(List<ZIMConversationSearchInfo> conversationSearchInfoList,int nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| conversationSearchInfoList | List<ZIMConversationSearchInfo> | 搜索到的会话消息列表。 |
| nextFlag | int | 分页拉取标志,搜索下一页的锚点。 |
| errorInfo | ZIMError | 搜索结果的错误码。0 代表搜索成功,非 0 为搜索失败。若出现搜索失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
基于本地消息搜索本地会话结果的返回。
- 业务场景:进行本地会话消息搜索操作后,成功与否可以通过该回调得知。
- 相关接口:[SearchLocalConversations],基于本地消息搜索本地会话。
ZIMRoomMembersQueriedCallback
public void ZIMRoomMembersQueriedCallback(string roomID,List<ZIMRoomMemberInfo> memberList,List<ZIMErrorUserInfo> errorUserList,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID。 |
| memberList | List<ZIMRoomMemberInfo> | 查询成功的用户信息列表。 |
| errorUserList | List<ZIMErrorUserInfo> | 查询失败的用户列表。 |
| errorInfo | ZIMError | 错误信息。 |
详情
查询房间用户信息后通过该回调返回查询结果。
- 业务场景:可在该回调内做查询房间用户信息后的逻辑。
- 通知时机:调用 [QueryRoomMembers] 接口查询房间用户信息后触发。
- 支持版本:2.8.0 及以上。
ZIMRoomMembersAttributesQueriedCallback
public void ZIMRoomMembersAttributesQueriedCallback(string roomID,List<ZIMRoomMemberAttributesInfo> infos,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID。 |
| infos | List<ZIMRoomMemberAttributesInfo> | 房间用户属性列表。 |
| errorInfo | ZIMError | 查询房间用户属性的错误码。0 代表查询房间用户属性成功,非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时,开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。 |
详情
根据 UserID 列表,房间用户属性批量查询结果的返回。
- 业务场景:进行房间用户属性查询后,成功与否以及查询结果可以通过该回调得知。
- 通知时机:房间用户属性查询结束后的结果返回。
- 相关接口:[QueryRoomMembersAttributes],查询房间用户属性。
- 支持版本:2.4.0 及以上。
ZIMRoomMemberAttributesListQueriedCallback
public void ZIMRoomMemberAttributesListQueriedCallback(string roomID,List<ZIMRoomMemberAttributesInfo> infos,string nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID。 |
| infos | List<ZIMRoomMemberAttributesInfo> | 房间用户属性列表。 |
| nextFlag | string | 下一个分页查询的锚点,为空则代表已经查询完毕。 |
| errorInfo | ZIMError | 查询房间用户属性的错误码。0 代表查询房间用户属性成功,非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时,开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。 |
详情
分页查询房间内所有用户属性列表结果的返回。
- 业务场景:进行房间用户属性查询后,成功与否以及查询结果可以通过该回调得知。
- 通知时机:房间用户属性查询结束后的结果返回。
- 相关接口:[QueryRoomMemberAttributesList],查询房间用户属性。
- 支持版本:2.4.0 及以上。
ZIMRoomCreatedCallback
public void ZIMRoomCreatedCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomInfo | ZIMRoomFullInfo | 创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。 |
| errorInfo | ZIMError | 错误信息。 |
详情
创建房间的结果回调。
- 业务场景:当开发者创建房间时可以通过该回调来判断是否创建成功,并执行相应的业务逻辑。
- 通知时机:当调用 [CreateRoom] 创建房间后结果会触发本回调通知。
- 相关接口:通过 [CreateRoom] 创建房间,创建结果会通过本回调通知。
- 支持版本:1.1.0 及以上。
ZIMRoomEnteredCallback
public void ZIMRoomEnteredCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomInfo | ZIMRoomFullInfo | 创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。 |
| errorInfo | ZIMError | 错误信息。 |
详情
进入房间的结果回调。
- 业务场景:当开发者进入房间时可以通过该回调来判断是否进入成功,并执行相应的业务逻辑。
- 通知时机:当调用 [EnterRoom] 进入房间后结果会触发本回调通知。
- 相关接口:通过 [EnterRoom] 创建房间,进入结果会通过本回调通知。
- 支持版本:2.1.0 及以上。
ZIMRoomJoinedCallback
public void ZIMRoomJoinedCallback(ZIMRoomFullInfo roomInfo,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomInfo | ZIMRoomFullInfo | 加入的房间的详细信息。若加入失败则其中的 roomID 参数将为空字符串。 |
| errorInfo | ZIMError | 加入房间的错误码。0 代表加入房间成功,非 0 为加入房间失败。若出现加入房间失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
加入房间的结果的回调。
- 业务场景:当开发者加入房间时,开发者可以通过该回调判断是否加入成功。
- 通知时机:当有人加入房间时,会通过该回调通知。
- 相关接口:通过 [JoinRoom] 加入房间,加入结果会通过本回调通知。
- 支持版本:1.1.0 及以上。
ZIMRoomLeftCallback
public void ZIMRoomLeftCallback(string roomID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID |
| errorInfo | ZIMError | 离开房间的错误码。0 代表离开房间成功,非 0 为离开房间失败。若出现离开房间失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
离开房间的结果的回调。
- 业务场景:当用户本人需要离开房间时,开发者可以在该回调里进行业务逻辑处理。
- 通知时机:当用户 调用 [LeaveRoom],则会触发该回调返回结果。
- 相关接口:通过 [LeaveRoom] 离开房间,离开结果会通过本回调通知。
- 支持版本:1.1.0 及以上。
ZIMRoomMemberQueriedCallback
public void ZIMRoomMemberQueriedCallback(string roomID,List<ZIMUserInfo> memberList,string nextFlag,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID |
| memberList | List<ZIMUserInfo> | 房间的成员列表。 |
| nextFlag | string | 分页查询的标识位,如果此字段为空字符串,说明已查询完毕。否则需要将此值设置到 ZIMQueryMemberConfig 的 "nextFlag" 字段中以进行下一页查询。 |
| errorInfo | ZIMError | 查询房间成员的错误码。0 代表查询房间成员成功,非 0 为查询房间成员失败。若出现查询房间成员失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
查询房间成员列表的结果回调。
- 通知时机:当调用 [QueryRoomMember] 接口进行房间成员查询时候,会触发该回调。
- 相关接口:通过 [QueryRoomMember] 查询房间成员列表,查询结果会通过本回调通知。
- 支持版本:1.1.0 及以上。
ZIMRoomOnlineMemberCountQueriedCallback
public void ZIMRoomOnlineMemberCountQueriedCallback(string roomID,uint count,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID |
| count | uint | 房间的在线成员数量。 |
| errorInfo | ZIMError | 查询房间在线成员的错误码。0 代表查询房间在线成员成功,非 0 为查询房间在线成员失败。若出现查询房间在线成员失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
进行查询房间在线成员数量操作后,执行所获得的人数回调。
- 通知时机:当调用 [QueryRoomOnlineMemberCount] 接口进行查询房间成员人数时,会触发该回调。
- 相关接口:可通过 [QueryRoomOnlineMemberCount] 查询房间在线人数。
- 支持版本:1.1.0 及以上。
ZIMRoomAttributesQueriedCallback
public void ZIMRoomAttributesQueriedCallback(string roomID,Dictionary<string, string> roomAttributes,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID |
| roomAttributes | Dictionary<string, string> | 房间内的房间属性。 |
| errorInfo | ZIMError | 查询房间全部属性的错误码。0 代表查询房间全部属性成功,非 0 为查询房间全部属性失败。若出现查询房间全部属性失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
房间属性查询结果的返回。
- 业务场景:进行自定义属性查询后,成功与否以及查询结果可以通过该回调得知。
- 通知时机:房间属性查询结束后的结果返回。
- 相关接口:[QueryRoomAllAttributes],查询房间属性。
- 支持版本:1.3.0。
ZIMRoomAttributesOperatedCallback
public void ZIMRoomAttributesOperatedCallback(string roomID,List\<string> errorKeys,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID。 |
| errorKeys | List<string> | 操作失败的 keys。 |
| errorInfo | ZIMError | 房间属性操作的错误码。0 代表房间属性操作成功,非 0 为房间属性操作失败。若出现房间属性操作失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
房间属性操作结果的返回。
- 业务场景:进行自定义属性操作后,成功与否可以通过该回调得知。
- 通知时机:房间属性操作结束后的结果返回。
- 相关接口:[SetRoomAttributes],设置房间属性。[DeleteRoomAttributes],删除房间属性。
- 支持版本:1.3.0。
ZIMRoomAttributesBatchOperatedCallback
public void ZIMRoomAttributesBatchOperatedCallback(string roomID,ZIMError errorInfo)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| roomID | string | 房间 ID |
| errorInfo | ZIMError | 房间属性批处理操作的错误码。0 代表房间属性批处理操作成功,非 0 为房间属性批处理操作失败。若出现房间属性批处理操作失败时,开发者应查看官网错误码文档查询解决方案。 |
详情
房间属性组合操作结果的返回。
- 业务场景:进行自定义属性组合操作后,成功与否可以通过该回调得知。
- 通知时机:房间属性组合操作结束后的结果返回。
- 相关接口:[BeginRoomAttributesBatchOperation],开始房间属性组合操作。[EndRoomAttributesBatchOperation],完成房间属性组合操作。
- 支持版本:1.3.0。
