Class

• 调用时机：在调用其他成员函数之前，必须先调用此 API 创建出 ZIM 示例。
• 影响范围：不调用此函数将导致其他成员函数无法调用。
• 平台差异：Android 平台下在调用此函数时，除了传入 AppID 之外，还必须将 Application 类对象传入。

• 业务场景：1. SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。

2. 开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

• 调用时机：在任意时刻均可调用。

• 调用时机：必须在调用 [Create] 创建实例之后，才能调用此函数获取到单例对象，否则将返回 [null]。
• 相关接口：[Create]。

• 默认值：/storage/Android/data/[Application ID]/files/ZIMLogs
• 调用时机：必须在 [Create] 之前调用。
• 生命周期：调用 [Create] 之前设置，调用 [Create] 时生效。若开发者在下一次 [Create] 时没有再设置新的日志配置，则上一次配置依然生效。
• 平台差异：不同平台的默认路径不一样，请参考默认值。
• 相关参考：详细内容请参考 https://doc-zh.zego.im/faq/IM_sdkLog?product=IM&platform=all 。

• 默认值：Android：/storage/Android/data/[packageName]/files/ZIMCaches iOS：/Library/Caches/ZIMCaches macOS：（沙箱）/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMCaches / （非沙箱）~/Library/Caches/ZIMCaches Windows：C:\Users[Your UserName]\AppData[App Name]ZEGO.SDK\ZIMCaches
• 调用时机：必须在 [Create] 之前调用。
• 生命周期：调用 [Create] 之前设置，调用 [Create] 时生效。若开发者在下一次 [create] 时没有再设置新的缓存配置，则上一次配置依然生效。
• 平台差异：不同平台的默认路径不一样，请参考默认值。

• 调用时机：必须在调用 [create] 创建实例之后，调用其他实例函数之前调用此函数。
• 隐私保护声明：提醒用户尽量不要在 userID 参数里传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 相关回调：开发者除了能在 callback 参数中得到登录结果之外，在登录请求中和登录成功/失败后，还将收到 [onConnectionStateChanged] 回调，用于判断当前用户的登录状态。

常见问题解答: 与 ZEGO 的 RTC 登录有什么不同？RTC 的登录指的是登录到房间、ZIM 的登录为登录到账户。

• 相关参考：详情请参考鉴权 Token 生成 https://doc-zh.zego.im/article/11617 。

• 调用时机：必须在调用 [Create] 创建实例之后，调用其他实例函数之前调用此函数。
• 隐私保护声明：提醒用户尽量不要在 userID 参数里传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 相关回调：开发者除了能在 callback 参数中得到登录结果之外，在登录请求中和登录成功/失败后，还将收到 [OnConnectionStateChanged] 回调，用于判断当前用户的登录状态。

• 调用时机：必须在调用 [Create] 创建实例之后，通过该实例来调用此函数。
• 生命周期：该函数的生命周期依赖鉴权 Token 的有效期，由开发者业务方自行决定。
• 相关参考：详情请参考鉴权 Token 生成 https://doc-zh.zego.im/article/11617 。

• 调用时机：必须在调用 [Create] 创建实例之后，调用 [Login] 登录后才可使用。
• 相关回调：[ZIMUsersInfoQueriedCallback]。

• 调用时机/通知时机：用户登录后。
• 隐私保护声明：尽量不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 相关回调：[ZIMUserNameUpdatedCallback]。
• 相关接口：[updateUserExtendedData] 与 [QueryUsersInfo]。

• 调用时机/通知时机：用户登录后。
• 相关回调：[ZIMUserAvatarUrlUpdatedCallback]。
• 相关接口：[QueryUsersInfo]。

• 调用时机/通知时机：用户登录后。
• 隐私保护声明：尽量不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 相关回调：[ZIMUserExtendedDataUpdatedCallback]。
• 相关接口：[UpdateUserName] 与 [QueryUsersInfo]。

• 业务场景：开发者可在 App 提供业务上的“反馈”渠道，当用户反馈的问题属于 ZEGO SDK 时，可调用此函数将 SDK 的本地日志信息上传，并联系 ZEGO 技术支持协助定位用户问题。
• 调用时机：在 [Create] 后。
• 相关回调：开发者可以通过 callback 参数获取上传结果。

• 调用时机：必须在调用 [Create] 创建实例之后，通过该实例来调用此函数。
• 相关回调：开发者在登出后，将收到 [OnConnectionStateChanged] 回调，此时登录状态为 [Disconnected]。

• 调用时机：在不需要再使用 ZIM 的时候调用，一般可以在对 ZIM 对象置空之前调用。

• 业务场景：当需要对一个或者多个用户发起邀请时，可调用此接口。
• 调用时机：通过 [Create] 创建 ZIM 实例后可调用。
• 相关回调：[ZIMCallInvitationSentCallback]。

• 业务场景：需要取消之前发起的呼叫邀请时，可通过该接口来取消呼叫邀请。
• 调用时机：通过 [Create] 创建 ZIM 实例后可调用。
• 相关回调：[ZIMCallCancelSentCallback]。

• 业务场景：ZIM SDK在接受后无相关业务逻辑，开发者可以自定义接受后的开发逻辑，如收到其他主叫发起的邀请后，通过该接口来接受呼叫邀请，之后使用 RTC 开启语音聊天功能。
• 调用时机：通过 [Create] 创建 ZIM 实例后可调用。
• 相关回调：[ZIMCallAcceptanceSentCallback]。

• 业务场景：收到其他主叫发起的邀请后，可通过该接口来拒绝呼叫邀请。
• 调用时机：通过 [Create] 创建 ZIM 实例后可调用。
• 相关回调：[ZIMCallRejectionSentCallback]。

• 调用时机：呼叫建立后，呼叫状态为 Accepted 的用户可调用此接口。
• 相关回调：[ZIMCallQuitSentCallback]。

• 调用时机：呼叫为进阶模式且用户状态为 "Accepted"。
• 相关回调：[ZIMCallEndSentCallback]。

• 调用时机：主叫调用 [callInvite] 发起进阶模式的呼叫邀请后使用，或被叫接受进阶模式呼叫邀请后。
• 相关回调：[ZIMCallingInvitationSentCallback]。

• 业务场景：用户可通过该查询呼叫邀请列表，用作界面展示或其他功能。
• 调用时机：通过 [Create] 创建 ZIM 实例, 登录后可调用。
• 相关回调：[ZIMCallInvitationListQueriedCallback]。

• 业务场景：需要创建多人聊天场景时，可通过该接口创建并加入群组。
• 调用时机：通过 [Create] 创建 ZIM 实例并 [Login] 登录之后。
• 相关回调：通过 [ZIMGroupCreatedCallback] 回调可拿到创建群组的结果。
• 相关接口：可通过 [JoinGroup] 加入群组，[LeaveGroup] 离开群组， [DismissGroup] 解散群组。

• 业务场景：当需要通过关键字等配置搜索本地群组时，可以调用该接口进行搜索。
• 调用时机/通知时机：调用 [login] 登录后。
• 相关回调：[ZIMGroupsSearchedCallback]

• 业务场景：当需要通过关键字等配置搜索本地群成员时，可以调用该接口进行搜索。
• 相关回调：[ZIMGroupMembersSearchedCallback]

• 业务场景：需要创建多人聊天场景时，可通过该接口创建并加入群组。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupCreatedCallback] 回调可拿到创建群组的结果。
• 相关接口：可通过 [JoinGroup] 加入群组，[LeaveGroup] 离开群组， [DismissGroup] 解散群组。

• 业务场景：需要加入多人聊天场景时，可通过该接口加入群组。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupJoinedCallback] 回调可拿到加入房间的结果。
• 相关接口：可通过 [CreateGroup] 创建群组，[LeaveGroup] 离开群组， [DismissGroup] 解散群组。

• 业务场景：需要退出多人聊天场景时，可通过该接口离开群组。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例后并登录后可调用。
• 相关回调：通过 [ZIMGroupLeftCallback] 回调可拿到离开房间的结果。
• 相关接口：可通过 [CreateGroup] 创建群组，[JoinGroup] 加入群组， [DismissGroup] 解散群组。

• 业务场景：创建多人聊天群组后，不需要在此群组进行聊天互动，可通过此接口解散群组。
• 调用时机：通过 [CreateGroup] 创建群组后可以调用。
• 相关回调：通过 [ZIMGroupDismissedCallback] 回调可拿到解散房间的结果，通过 [OnGroupStateChanged] 监听回调可拿到房间状态。
• 相关接口：可通过 [CreateGroup] 创建群组， [JoinGroup] 加入群组，[LeaveGroup] 离开群组。

• 业务场景：需要将一个或多个用户踢出群组时，可通过此方法实现该功能。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupMemberKickedCallback] 回调可拿到将用户踢出群组的结果。
• 相关接口：可通过 [InviteUsersIntoGroup] 邀请目标用户进入群组。

• 业务场景：需要邀请一个或多个用户邀请加入群组时，可通过此方法实现该功能。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupMemberinvitedCallback] 回调可拿到邀请用户加入群组的结果。
• 相关接口：可通过 [KickGroupMembers] 将目标用户踢出群组。

• 业务场景：在多人群组聊天场景中，可通过该接口转让群主。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupOwnerTransferredCallback] 回调可拿到转让群主的结果。

• 业务场景：创建群组后，用户需要更改群名称。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupNameUpdatedCallback] 回调可拿到更改群名称的结果，通过 [OnGroupNoticeUpdated] 可拿到更新群名称信息。

• 业务场景：创建群组后，用户需要更改群头像 URL。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录、处于对应群中时可调用。
• 相关回调：通过 [ZIMGroupAvatarUrlUpdatedCallback] 回调可拿到更改群头像的结果，通过 [OnGroupAvatarUrlUpdated] 可拿到更新群头像信息。

• 业务场景：需要在群组中，更新群公告。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupNoticeUpdateCallback] 回调可拿到更新群公告的结果，通过 [OnGroupNoticeUpdated] 可拿到更新群公告信息。

• 业务场景：需获取群组信息进行展示。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupInfoQueriedCallback] 回调可拿到查询群组信息的结果。

• 业务场景：需要获取群列表进行展示。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupListQueiedCallback] 回调可拿到查询当前所有群列表的结果。

• 业务场景：新增对群组描述的扩展字段信息，如群的家族、标签、行业类别等。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupAttributesOperatedCallback] 回调可拿到设置群属性的结果。
• 相关接口：可通过 [DeleteGroupAttributes] 删除群属性，[QueryGroupAttributes] 查询群属性，[QueryAllGroupAttributes] 查询全部群属性。

• 业务场景：删除对群组描述的扩展字段信息。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupAttributesOperatedCallback] 回调可拿到删除群属性的结果。
• 相关接口：可通过 [SetGroupAttributes] 设置群属性，[QueryGroupAttributes] 查询群属性，[QueryAllGroupAttributes] 查询全部群属性。

• 业务场景：需要查询指定群属性进行展示的场景。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并 [Login] 登录之后。
• 相关回调：通过 [ZIMGroupAttributesQuriedCallback] 回调可拿到查询指定群属性的结果。
• 相关接口：[QueryAllGroupAttributes] 查询所有群属性。

• 业务场景：需要查询所有群属性进行展示的场景。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupAttributesQuriedCallback] 回调可拿到查询所有群属性的结果。
• 相关接口：[QueryGroupAttributes] 查询指定群属性。

• 业务场景：在多人群组中，需要对指定群成员角色进行设置。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupMemberRoleUpdatedCallback] 回调可拿到设置群成员角色的结果。

• 业务场景：需要对群成员设置昵称。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupMemberNicknameUpdatedCallback] 回调可拿到设置群成员昵称的结果。

• 业务场景：需要获取指定群成员信息进行展示或交互。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupMemberInfoQueriedCallback] 回调可拿到查询指定群成员信息的结果。

• 业务场景：需要获取指定群成员列表信息进行展示或交互。
• 调用时机/通知时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：通过 [ZIMGroupMemberListQueriedCallback] 回调可拿到查询群成员列表的结果。

• 调用时机：通过 [Create] 创建 ZIM 实例并登录后可调用。
• 相关回调：[ZIMGroupMemberCountQueriedCallback]。

• 业务场景：需要得知指定会话的相关信息时，这时可以调用该接口来获得数据源。
• 调用时机/通知时机：登录后可调用。
• 相关回调：[ZIMConversationQueriedCallback]。

• 业务场景：登录后需要展示已有的消息会话，这时可以调用该接口来获得数据源。
• 调用时机/通知时机：登录后可调用。
• 相关回调：[ZIMConversationListQueriedCallback]。
• 相关接口：[DeleteConversation] 删除会话；[ClearConversationUnreadMessageCount] 清除会话未读数。

• 业务场景：登录后需要展示已有的置顶消息会话，这时可以调用该接口来获得数据源。
• 调用时机/通知时机：登录后可调用。

• 业务场景：需要修改某个会话置顶状态时，可以调用该接口。
• 调用时机/通知时机：登录后可调用。
• 相关回调：[ZIMConversationPinnedStateUpdatedCallback]。

• 业务场景：在会话不再被需要时，若要将整个会话删除，此时可调用该接口实现。
• 调用时机/通知时机：需要删除会话时调用,创建 ZIM 实例后即可调用，登录后生效，登出后失效。
• 影响范围：调用成功会触发 DeleteConversation 的 callback 回调。若所删除会话包含未读消息会触发[OnConversationTotalUnreadMessageCountUpdated]回调。
• 相关回调：[ZIMConversationDeletedCallback]

• 业务场景：当由会话进入聊天页，此时该会话原先的消息未读数需要清零，可调用该接口。
• 调用时机/通知时机：需要清除目标未读数时调用。
• 影响范围：调用该方法会触发总未读数更新的回调 [OnConversationTotalUnreadMessageCountUpdated] ，会触发会话更新的回调 [OnConversationChanged] 。
• 相关回调：[ZIMConversationUnreadMessageCountClearedCallback]。
• 相关接口：[OnConversationTotalUnreadMessageCountUpdated]、[OnConversationChanged]。

• 业务场景：用户选择消息免打扰，可以调用对应方法，未读数不增加。
• 默认值：消息免打扰默认不开启。
• 调用时机/通知时机：登录并存在目标会话的前提下，若想要开关目标会话的消息免打扰状态，调用该接口。
• 影响范围：使用该方法开启免打扰状态后，收到消息不会触发 [OnConversationTotalUnreadMessageCountUpdated]。
• 相关回调：[ZIMConversationNotificationStatusSetCallback]。
• 相关接口：[OnConversationTotalUnreadMessageCountUpdated]。

• 业务场景：登录后需要向目标用户、目标消息室、目标群聊发送消息时，通过该接口发送。
• 调用时机：登录后即可调用。
• 相关回调：[ZIMMessageSentCallback]、[ZIMMessageSendNotification]、[OnReceivePeerMessage]、[OnReceiveRoomMessage]、[OnReceiveGroupMessage]、[OnConversationChanged]、[OnConversationTotalUnreadMessageCountUpdated]。
• 相关接口：[QueryHistoryMessage]、[DeleteAllMessage]、[DeleteMessages]、[SendMediaMessage]。

• 业务场景：登录后需要向目标用户、目标房间以及目标群聊发送媒体消息时，通过本接口发送。
• 调用时机：登录后可调用。
• 影响范围：使用该方法会触发消息接收方的 [OnReceivePeerMessage] / [OnReceiveRoomMessage] / [OnReceiveGroupMessage] 回调，会触发发送方和接收方的 [OnConversationChanged] 回调，若该消息所在会话未设置消息免打扰，会触发 [OnConversationTotalUnreadMessageCountUpdated] 回调。
• 相关回调：[ZIMMessageSentCallback]、[ZIMMediaMessageSendNotification]、[OnReceivePeerMessage]、[OnReceiveRoomMessage]、[OnReceiveGroupMessage]、 [OnConversationChanged]、[onConversationTotalUnreadMessageCountUpdated]。
• 相关接口：[QueryHistoryMessage]、[DeleteAllMessage]、[DeleteMessages]

• 业务场景：开发者可结合系统消息类型，在客户端将回调通知（例如：邀请某人进群、把某人移出群等），转为系统消息类型，插入本地 DB，以达到系统提示的效果。
• 调用时机/通知时机：登录后可调用。
• 相关回调：[ZIMMessageInsertedCallback]。
• 相关接口：[QueryHistoryMessage]、[DeleteAllMessage]、[DeleteMessages]。

• 业务场景：设置整个会话所有已接收的回执消息已读，会话里消息回执的发送者会从 ZIMEventHandler 收到 [OnConversationMessageReceiptChanged] 的回调。
• 调用时机/通知时机：登录后即可调用，建议在进入消息列表页面之前调用，在消息列表页面内建议调用 [SendMessageReceiptsRead] 对需要设置已读的消息批量设置。
• 相关回调：[ZIMConversationMessageReceiptReadSentCallback]。
• 相关接口：[SendMessageReceiptsRead] 、[SendMessage] 。

• 业务场景：开发者可通过这个方法，设置一批带回执的消息已经被读了。发送端如果在线，则会收到 [OnMessageReceiptChanged] 的回调。
• 调用时机：登录后可调用。建议在消息列表页对需要设置已读的消息设置。不建议和 [SendConversationMessageReceiptRead] 一起混用。
• 相关回调：[ZIMMessageReceiptsReadSentCallback]。
• 相关接口：[SendMessage]。

• 业务场景：如果需要查询消息的回执状态、未读用户数和已读用户数，可以调用此接口。
• 调用时机：登录后可调用。如果需要查询详细的成员列表，则可以通过接口[QueryGroupMessageReceiptReadMemberList] 或[QueryGroupMessageReceiptUnreadMemberList] 查询。
• 相关回调：[ZIMMessageReceiptsInfoQueriedCallback]。
• 相关接口：[QueryGroupMessageReceiptReadMemberList] , [QueryGroupMessageReceiptUnreadMemberList]。

• 业务场景：开发者可通过这个方法，查询一条自己发的消息的具体已读成员列表。
• 调用时机：登录后可调用。
• 相关回调：[ZIMGroupMessageReceiptMemberListQueriedCallback]。
• 相关接口：如果需要查询某一条消息的回执状态或只需要查询已读/未读数，通过接口 [QueryMessageReceiptsInfo] 查询。

• 业务场景：开发者可通过这个方法，查询一条自己发的消息的具体未读成员列表。
• 调用时机：登录后可调用。
• 相关回调：[ZIMGroupMessageReceiptMemberListQueriedCallback]。
• 相关接口：如果需要查询某一条消息的回执状态或只需要查询已读/未读数，通过接口 [QueryMessageReceiptsInfo] 查询。

• 业务场景：当需要通过关键字等条件搜索以往的本地消息，可以调用该接口来分页搜索本地消息。
• 相关回调：[ZIMMessagesSearchedCallback]

• 业务场景：当需要通过关键字等条件进行全局搜索会话时，可以调用该接口进行搜索。
• 调用时机/通知时机：需要通过关键字等条件进行搜索会话时调用。
• 相关回调：[ZIMConversationsSearchedCallback]

• 业务场景：当需要通过关键字等条件进行全局搜索以往的本地消息，可以调用该接口按会话进行分组来搜索本地消息。
• 相关回调：[ZIMMessagesGlobalSearchedCallback]

• 业务场景：登录后需要向目标用户、目标群聊发送回复消息时，通过该接口发送。
• 调用时机：登录后即可调用。
• 相关回调：[onReceivePeerMessage]、[onReceiveGroupMessage]。
• 相关接口：[queryHistoryMessage]、[sendMessage]、[sendMediaMessage]。

• 业务场景：用户收到消息之后，若该消息包含媒体文件，则可以调用本接口下载其内容。
• 调用时机/通知时机：登录后且收到包含媒体文件的消息之后可调用。
• 相关回调：[ZIMMediaDownloadedCallback]、[ZIMMediaDownloadingProgress]。

• 业务场景：用户收到消息之后，若该消息为媒体消息，则可以调用本接口下载其内容。
• 调用时机/通知时机：登录后且收到媒体消息之后可调用。
• 相关回调：[ZIMMediaDownloadedCallback]、[ZIMMediaDownloadingProgress]。

• 业务场景：当需要获得以往的历史消息，可以调用该接口来分页查询历史消息。
• 调用时机/通知时机：需要查询历史消息时调用。
• 相关回调：[ZIMMessageQueriedCallback]

• 业务场景：当需要展示置顶消息时，可以调用该接口来查询会话内置顶消息列表。
• 调用时机：需要查询置顶消息时调用。
• 相关回调：[ZIMPinnedMessageListQueriedCallback]

• 业务场景：用户需要撤回某条消息，当用户不想让其他用户看到该信息时，可用此方法撤回。
• 调用时机/通知时机：需要撤回消息时调用。
• 影响范围：若撤回的消息为会话的最新一条消息，会触发 [OnConversationChanged] 回调，若此条消息未读，则会触发 [OnConversationTotalUnreadMessageCountUpdated] 回调。
• 相关回调：[ReceiveMessageRevoked]、[OnConversationChanged]、[OnConversationTotalUnreadMessageCountUpdated]。

• 业务场景：用户需要删除某条消息，当用户无需展示某条消息时，可用此方法删除。
• 调用时机/通知时机：需要删除消息时调用。
• 影响范围：若删除的消息为会话的最新一条消息，会触发 [OnConversationChanged] 回调，若此条消息未读，则会触发 [OnConversationTotalUnreadMessageCountUpdated] 回调。
• 相关回调：[ZIMMessageDeletedCallback]、[OnConversationChanged]、[OnConversationTotalUnreadMessageCountUpdated]。

• 业务场景：用户需要对某条消息进行表态，例如点赞，可用此方法进行表态。
• 相关回调：若表态成功，则会触发 [OnMessageReactionsChanged] 回调；若表态的消息为会话的最新一条消息，成功后还会触发 [OnConversationChanged] 回调。

• 业务场景：用户需要对某条已表态的消息进行表态删除，可用此方法。
• 相关回调：若删除成功，则会触发 [onMessageReactionsChanged] 回调；若相关消息为会话的最新一条消息，成功后还会触发 [onConversationChanged] 回调。

• 业务场景：当需要获得消息某个表态下的具体用户信息，可以调用该接口来分页查询表态用户消息。
• 调用时机/通知时机：需要查询表态用户信息时调用。

• 业务场景：如想要实现一个群设置页面的清空当前会话下的聊天信息，可调用该接口。
• 调用时机/通知时机：目标会话存在、并且用户属于此会话的一员。
• 影响范围：触发 [OnConversationChanged] 回调，若存在未读消息，则会触发 [OnConversationTotalUnreadMessageCountUpdated] 回调。
• 相关回调：[ZIMMessageDeletedCallback]。

• 调用时机/通知时机：用户登录后。
• 隐私保护声明：尽量不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 相关回调：[ZIMMessageLocalExtendedDataUpdatedCallback]。

• 业务场景：需要创建多人聊天场景时，可通过该接口创建并加入房间。
• 调用时机：登录后可调用。
• 相关回调：通过 [OnRoomCreated] 回调可拿到创建房间的结果。
• 相关接口：可通过 [JoinRoom] 加入房间，[LeaveRoom] 离开房间。

• 业务场景：需要得知指定房间内的用户信息时，这时可以调用该接口来获得数据源。可以确认用户是否在房间中。
• 调用时机/通知时机：登录后可调用。

• 业务场景：如需要为房间内成员设置一个等级，设置一个状态时，可用此接口来设置。
• 默认值：[ZIMRoomMemberAttributesSetConfig] 默认构造 isDeleteAfterOwnerLeft 为 true。
• 调用时机：登录后，并处于相关房间内调用。
• 相关回调：[ZIMRoomMembersAttributesOperatedCallback]、[OnRoomMemberAttributesUpdated]。
• 相关接口：[QueryRoomMembersAttributes]、[QueryRoomMemberAttributesList]。

• 调用时机：当需要指定查询部分房间用户的时候使用该接口。
• 相关回调：[ZIMRoomMembersAttributesQueriedCallback]。
• 相关接口：[SetRoomMembersAttributes]、[QueryRoomMemberAttributesList]。
• 生命周期：登录并加入对应房间后可用，离开对应房间后不可用。

• 调用时机：当需要指定查询全部房间用户的时候使用该接口。
• 相关回调：[ZIMRoomMemberAttributesListQueriedCallback]。
• 相关接口：[SetRoomMembersAttributes]、[QueryRoomMembersAttributes]。
• 生命周期：登录并加入对应房间后可用，离开对应房间后不可用。

• 业务场景：需要创建具有自定义属性的多人聊天场景时，可通过该接口创建并加入房间。
• 调用时机：登录后可调用。
• 相关回调：通过 [OnRoomCreated] 回调可拿到创建房间的结果。
• 相关接口：可通过 [JoinRoom] 加入房间，[LeaveRoom] 离开房间。

• 业务场景：需要进入具有自定义属性的多人聊天场景，同时不需要区分房间是被创建还是被加入时，可通过该接口进入一个房间。
• 调用时机：登录后可调用。
• 相关回调：通过 [OnRoomEntered] 回调可拿到进入房间的结果。
• 相关接口：可通过 [EnterRoom] 进入房间，[LeaveRoom] 离开房间。

• 业务场景：多人聊天场景下，用户需要加入房间时可调用该接口进入房间。
• 调用时机：登录后可调用，且该用户位于房间中时可调用。
• 相关回调：通过 [ZIMRoomJoinedCallback] 回调可获得加入房间的结果。
• 相关接口：可通过 [CreateRoom] 创建房间，[LeaveRoom] 离开房间。

• 业务场景：多人聊天场景下，房间中的用户需要离开房间时，可通过该接口离开房间。
• 调用时机：登录后可调用，且该用户位于房间中时可调用。
• 相关回调：通过 [ZIMRoomLeftCallback] 回调可拿到离开房间的结果。
• 相关接口：可通过 [CreateRoom] 创建房间，[JoinRoom] 加入房间。

• 业务场景：当开发者需要获取房间成员列表以做其他业务操作时，可调用该接口以获得成员列表。
• 调用时机：登录后，且该用户位于需要查询的房间中时可调用该接口。
• 相关回调：通过 [ZIMRoomMemberQueriedCallback] 回调可拿到查询房间成员列表的结果。
• 相关接口：可通过 [QueryRoomOnlineMemberCount] 查询房间在线人数。

• 业务场景：当开发者需要获取房间在线的房间成员人数时，可以调用此接口。
• 调用时机：通过 [Create] 创建 ZIM 实例后，且该用户位于需要查询的房间中时可调用该接口。
• 相关回调：通过 [ZIMRoomOnlineMemberCountQueriedCallback] 回调可拿到查询房间成员在线人数的的结果。
• 相关接口：可通过 [QueryRoomMember] 查询房间成员。

• 调用时机： 登录后，并处于相关房间内调用。
• 业务场景：语聊房需要查询麦位时，可以使用该接口。
• 相关回调：[ZIMRoomAttributesQueriedCallback]。
• 相关接口：[deleteRoomAttributes]，删除房间属性。[setRoomAttributes]，设置房间属性。

• 业务场景：语聊房需要设置麦位时，可以使用该接口。
• 调用时机： 登录后，并处于相关房间内调用。

数量限制: 每个房间中，最多允许设置 20 个属性。

大小限制: 房间属性的key-value，默认 key 的长度是 16，默认 value 的长度是 1024。

• 默认值：[ZIMRoomAttributesSetConfig] 传空时的默认配置是非强制操作，且不更新拥有者，且涉及到的房间属性在拥有者退出后不自动删除。
• 隐私保护声明：尽量不要在房间属性中传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
• 影响范围：新增或修改现有房间的房间属性。
• 相关回调：[ZIMRoomAttributesOperatedCallback]。
• 相关接口：[DeleteRoomAttributes]，删除房间属性。[QueryRoomAllAttributes]，查询房间属性。

• 业务场景：语聊房需要删除麦位时，可以使用该接口。
• 调用时机： 登录后，并处于相关房间内调用。
• 默认值：[ZIMRoomAttributesDeleteConfig] 传空时的默认配置是非强制操作。
• 影响范围：删除现有房间的房间属性。
• 相关回调：[ZIMRoomAttributesOperatedCallback]。
• 相关接口：[SetRoomAttributes]，设置房间属性。[QueryRoomAllAttributes]，查询房间属性。

• 业务场景：语聊房需要切换麦位时，可以使用该接口发起组合操作以完成，如先下麦，然后抢占其他麦位，若抢占失败再回到原来麦位，这期间原来的麦位是锁定的，保证了原来的麦位不会被其他用户上麦。
• 调用时机： 登录后，并处于相关房间内调用。
• 影响范围：开启后设置、删除房间属性操作会被纳入到本次组合操作中。
• 相关接口：[EndRoomAttributesBatchOperation]，完成本次组合操作。

• 业务场景：语聊房需要切换麦位时，可以使用该接口。
• 调用时机：登录后，在 [BeginRoomAttributesBatchOperation] 执行后执行该操作。
• 影响范围：同房间内的设置，删除房间属性。
• 相关回调：[ZIMRoomAttributesBatchOperatedCallback]。
• 相关接口：[BeginRoomAttributesBatchOperation]，开启组合操作。

• 是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。

• 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

• 是否必填：如果发送的是外部 URL，发送端必填。

• 是否必填：发送端不需要填，该值由 SDK 生成。

• 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

• 是否必填：发送端不需要填，该值由 SDK 生成。

• 业务场景：可用于索引其他消息。

• 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

• 是否必填：必填。

• 默认值：false。

• 业务场景：用于在回执消息中，判断当前消息是处于什么状态。

• 业务场景：可为消息附加拓展字段，然后发送给对端。
• 是否必填：否。

• 是否必填：SDK内部赋值。

• 业务场景：例如在群或者房间可使用。
• 是否必填：否。
• 默认值：false。
• 建议值：如果需要提醒所有人，可以设置为 true。

• 业务场景：发消息时可以带上
• 是否必填：否。

• 是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。

• 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

• 是否必填：如果发送的是外部 URL，发送端必填。

• 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

• 是否必填：发送端不需要填，该值由 SDK 生成。

• 是否必填：非必填。
• 默认值：Android：/storage/Android/data/[packageName]/files/ZIMCaches iOS：/Library/Caches/ZIMCaches macOS：（沙箱）/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMCaches / （非沙箱）~/Library/Caches/ZIMCaches Windows：C:\Users[Your UserName]\AppData[App Name]ZEGO.SDK\ZIMCaches
• 建议值：建议使用默认值。

• 是否必填：必填。

• 是否必填：非必填。
• 默认值：""。

• 是否必填：非必填。

• 是否必填：非必填。

• 是否必填：非必填。

• 是否必填：必填。

• 是否必填：非必填。