Class

• Platform differences: When calling this function under the Android platform, in addition to the appID, the Application class object must also be passed in.

• When to call: Before calling other member functions, you must call this API to create a ZIM example.

Usage restrictions: Currently only one instance is supported, repeated calls will return [null].

Precautions:

1. Currently, the [create] function can only create one instance at most. If it is called multiple times, only the first one will return a valid instance, and the rest will be [null]. The developer should save the ZIM instance by himself, and ensure that the life cycle of the instance is available in the process of using the ZIM business function; or after calling [create], he can use [getInstance] to obtain its singleton object and call other member functions.

2. If you use this function to create an instance, you must pass in both AppID and AppSign (exclude Web platform).

Scope of Impact: Failure to call this function will prevent other member functions from being called.

Platform difference: When calling this function on the Android platform, in addition to the appID, the Application class object must also be passed in.

• Use cases: 1. When the SDK is running, the developer finds that it does not match the expected situation and submits the problem and related logs to the ZEGO technical staff for locating. The ZEGO technical staff may need the information of the engine version to assist in locating the problem.

2. Developers can also collect this information as the version information of the engine used by the app, so that the SDK corresponding to each version of the app on the line.

When to call : It can be called at any time.

• When to call: You must call [create] to create an instance before calling this function to obtain a singleton object, otherwise it will return [null].

Related interface: [create].

• When to call: It must be called before [create].

If the developer calls after [create], the SDK will save this configuration until the next time [create] takes effect.

Life cycle: Set before calling [create], and take effect when calling [create]. If the developer does not set a new log configuration in the next [create], the previous configuration will still take effect.

Platform difference: The default path of different platforms is different, please refer to the default value.

Related reference: For details, please refer to https://doc-zh.zego.im/faq/IM_sdkLog?product=IM&platform=all.

• When to call /Trigger: The [setGeofencingConfig] interface needs to be called before the [create] interface.
• Caution: If you need to update geo fencing information, please call the [destroy] interface to destroy the current ZIM instance, and then call this interface.

• Default value: Android：/storage/Android/data/[packageName]/files/ZIMCaches iOS：/Library/Caches/ZIMCaches macOS：（sandbox）/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMCaches / ~/Library/Caches/ZIMCaches Windows：C:\Users[Your UserName]\AppData[App Name]ZEGO.SDK\ZIMCaches

Call timing: It must be called before [create].

If the developer calls after [create], the SDK saves the configuration until it takes effect the next time [Create] is invoked.

• Related callbacks: In addition to getting the login result in the callback parameter, the developer will also receive the [onConnectionStateChanged] callback during the login request and after the login is successful/failed to determine the current user's login status.

Life cycle: Set before calling [create] and takes effect when calling [create]. If the developer does not set the new caches configuration the next time [create] is created, the previous configuration will still take effect.

Platform difference: The default path varies with platforms. Please refer to the default value.

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [friendListChanged].

• When to call: It can be called after creating a ZIM instance through [create].
• Related callbacks: [friendApplicationListChanged].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [friendListChanged].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendAddedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendAliasUpdatedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendApplicationAcceptedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendApplicationRejectedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendListQueriedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendListQueriedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendApplicationListQueriedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMFriendsSearchedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMBlacklistUsersAddedResult].

Usage restrictions: The number of userID passed in at one time cannot exceed 20.

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMBlacklistUsersRemovedResult].

Usage restrictions: The number of userID passed in at one time cannot exceed 20.

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMBlacklistQueriedResult].

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMBlacklistCheckedResult].

• Use cases: Through this interface, you can obtain the local cache of the user status subscription list of the current user, so that you can know which users the current user has subscribed to, obtain the subscription expiration time of the subscriber, and obtain the status data of the subscriber when it changed last time.
• When to call /Trigger: It can be called after login, regardless of network status.
• Related callbacks: ZIMSubscribedUserStatusListQueriedCallback、subscribeUsersStatus、unsubscribeUsersStatus.
• Related APIs: subscribeUsersStatus、unsubscribeUsersStatus.

• Use cases: When you do not need to continuously follow the user statuses of certain users but only need to obtain their user statuses once, you can use this method.
• When to call /Trigger: Can be called after login and when the network conditions are good.

The query targets can not include unregistered users.

• Related callbacks: ZIMUsersStatusQueriedCallback.

• Use cases: When you enter the group/room/friends list and need to know which room/group members/friends are online, subscribe through this interface. When the user status of these users is updated successfully, the [userStatusUpdated] interface is updated.
• When to call /Trigger: Can be called when the login is successful and the network conditions are good.
• Caution: You cannot subscribe to the current login user through this interface. The subscribed user must be registered.
• Related callbacks: [ZIMUsersStatusSubscribedResult],[userStatusUpdated]
• Related APIs: [unsubscribeUsersStatus]

• Use cases: In non-multi-terminal login scenarios, when you leave a room or group, if you no longer follow the user status of the room or group members for a short period of time, and you have subscribed to the user status of the room or group members when you enter the room or group, you can unsubscribe through this interface.
• When to call /Trigger: Called after login and when the network is in good condition.
• Caution: You cannot cancel a user that is not in the current user subscription list.
• Related callbacks: ZIMUsersStatusUnsubscribedCallback.
• Related APIs: subscribeUsersStatus、queryUsersStatus、querySubscribedUserStatusList.

• Use cases: After login, call the interface to modify the current user's custom status as "do not disturb", "busy" and other states.
• When to call /Trigger: After an online login and a network connection exists.
• Related callbacks: After the interface is successfully invoked to update the user-defined status, other devices that are logged in to multiple devices and users who subscribe to the current user status through subscribeUsersStatus receive onUserStatusUpdated and updates the user-defined status of the current user.

• Use cases: For example, in the multi-terminal login scenario, the developer hopes that when the desktop is online, the mobile terminal does not want to receive offline push. In this scenario, the interface can be invoked to achieve this function.
• When to call /Trigger: You can call it after you log in and the network is in good condition.
• Caution: After the interface is successfully invoked, all ends will receive onUserRuleUpdate notifying the user that the rule has been updated.
• Related callbacks: userRuleUpdate、ZIMUserOfflinePushRuleUpdatedResult
• Related APIs: querySelfUserInfo

• Use cases: If you need to display the user information and rules, you can invoke the query, for example, to enter the personal page of the current user.
• When to call /Trigger: Call after login.

• Use cases: Relevant information can be obtained by registering a specified method.
• When to call: After SDK is initialized.

• When to call: After initializing the SDK and registering the listener event.

• Related callbacks: In addition to getting the login result in the Promise callback result, the developer will also receive the [connectionStateChanged] callback during the login request and after the login success/failure, which is used to determine the current user's login status.

Related reference: For details, please refer to Authentication (https://docs.zegocloud.com/article/14698).

• Related callbacks: In addition to getting the login result in the Promise callback result, the developer will also receive the [connectionStateChanged] callback during the login request and after the login success/failure, which is used to determine the current user's login status.

Related reference: For details, please refer to Authentication (https://docs.zegocloud.com/article/14698).

• Use cases: When you need to create a multi-person chat scene, you can create and join a room by this API.
• When to call: This function must be called through the instance after calling [create] to create the instance.
• Caution: After the developer receives the [onTokenWillExpire] callback, the developer needs to request the authentication server to regenerate a token in time.

• When to call /Trigger: It is available only after calling [create] to create the instance and then calling [login] to login.
• Related callbacks: [ZIMUsersInfoQueriedCallback].

Usage restrictions: No more than 10 userids can be queried by invoking the interface at a time. If the interface is invoked multiple times within 10 seconds, the total number of userids queried cannot exceed 10.

• When to call: After the user is logged in.

This interface does not support modifying user names in rooms.

• Privacy reminder: Try not to pass in sensitive information involving personal privacy, including but not limited to mobile phone numbers, ID numbers, passport numbers, real names, etc.
• Related callbacks: [ZIMUserNameUpdatedCallback].
• Related APIs: [updateUserExtendedData] and [queryUsersInfo].

• When to call: After the user is logged in.
• Privacy reminder: Try not to pass in sensitive information involving personal privacy, including but not limited to mobile phone numbers, ID numbers, passport numbers, real names, etc.
• Related callbacks: [ onUserNameUpdatedCallback ].
• Related APIs: [updateUserName] and [ queryUsersInfo ].

• Related callbacks: Developers can get the upload results through the callback parameter.

• Use cases: This function must be called from the instance after it has been created by calling [create].
• When to call: After invoking [logout], you can no longer use ZIM's chat, room, send and receive, and other functions. To use the ZIM service again, the developer must call [login] to login again.
• Caution: Upon logout, the developer will receive the [onConnectionStateChanged] callback with the login state being [Disconnected].

• When to call: It can be called after creating a ZIM instance through [create].

The call invitation has a timeout period, and the call invitation will end when the timeout period expires.

• Related callbacks: [ZIMCallInvitationSentCallback].

• Use cases: Users who are not in the call join the call, and users who are already in the call switch to the primary device.
• When to call: Need to be invoked after logged in.

• When to call: It can be called after creating a ZIM instance through [create].

Canceling the call invitation after the timeout period of the call invitation expires will fail.

• Related callbacks: [ZIMCallCancelSentCallback].

• When to call: It can be called after creating a ZIM instance through [create].

The callee will fail to accept an uninvited callid.

• Related callbacks: [ZIMCallAcceptanceSentCallback].

• When to call: It can be called after creating a ZIM instance through [create].

The callee will fail to reject the uninvited callid.

• Related callbacks: [ZIMCallRejectionSentCallback].

• When to call: After a call is established, users whose call status is accept can call this interface.

The callee will fail to quit the uninvited callId.

• Related callbacks: [ZIMCallQuitSentResult].

• When to call: The call was in advanced mode and the user status was Accepted.

User calls that are not in the call will fail. ZIM SDK Does not have service logic after the call ends, and developers can customize the development logic after the end.

• Related callbacks: [ZIMCallEndSentResult].

• When to call: After calling [callInvite] to initiate a call invitation in advanced mode or after the called party accepts the advanced mode call invitation.

User calls that are not in the call will fail. ZIM SDK has no relevant business logic after accepting. Developers can customize the development logic after adding calls. By default, a call can contain a maximum of 9 users.

• Related callbacks: [ZIMCallingInvitationSentResult].

• When to call: Run [create] to create a ZIM instance, which can be invoked after login.
• Related callbacks: [ZIMQueryCallInvitationListResult].

• Related callbacks: [ZIMGroupsSearchedResult].

• Related callbacks: [ZIMGroupMembersSearchedResult].

• Use cases: You can use this interface to create a chat scenario and join a group.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Caution: Available after login, unavailable after logout. UserIDs can have a maximum of 100 users and a group can have a maximum of 500 users.
• Related callbacks: The result of creating the group is obtained through the [ZIMGroupCreatedCallback] callback.
• Related APIs: You can use [joinGroup] to join a group, [leaveGroup] to leave a group, or [dismissGroup] to dismiss a group.

• Use cases: This interface is used to join a group in a chat scenario.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Caution: Available after login, unavailable after logout. If you have joined a group, the join succeeds.
• Related callbacks: To get the result of joining the room, call [ZIMGroupJoinedCallback].
• Related APIs: You can use [createGroup] to create a group, [leaveGroup] to leave a group, or [dismissGroup] to dismiss a group.

• Use cases: This interface is used to exit a chat group.
• When to call /Trigger: It can be invoked after a ZIM instance is created through [create] and logged in.
• Caution: When the group owner quits the group, the identity of the group owner will be automatically transferred to the earliest member who joined the group. When all members exit the group, the group is automatically dissolved.
• Impacts on other APIs: You can use [createGroup] to create a group, [joinGroup] to join a group, or [dismissGroup] to dismiss a group.
• Related callbacks: The result of leaving the room can be obtained by the [ZIMGroupLeftCallback] callback.

• Use cases: After you create a chat group, you do not need to use this interface to dissolve the group.
• When to call /Trigger: This parameter can be called after a group is created by using [createGroup].
• Caution: A non-group owner cannot dissolve a group.
• Related callbacks: Through callback can get [ZIMGroupDismissedCallback] dissolution results of the room, through [onGroupStateChanged] listen callback can get the room status.
• Related APIs: You can use [createGroup] to create a group, [joinGroup] to join a group, and [leaveGroup] to leave a group.

• Use cases: You can use this method to remove one or more users from the group.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Caution: This interface does not require the peer's consent or the peer's online status. It cannot accept group-related callbacks after being kicked out. History messages and sessions remain after being kicked out and can still enter the group.
• Related callbacks: Through the callback [ZIMGroupMemberKickedCallback] can get the user kicked out the results of the group.
• Related APIs: You can invite a target user into a group through [inviteUsersIntoGroup].

• Use cases: You can use this method to invite one or more users to the group.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Caution: This interface does not require the peer's consent or the peer's online status.
• Related callbacks: Through the callback [ZIMGroupUsersInvitedCallback] can get the user invited to the results of the group.
• Related APIs: You can kick out a target user into a group through [kickGroupMembers].

• Use cases: In a group chat scenario, you can transfer the group master through this interface.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupOwnerTransferredCallback] can get the result of the transfer of the group manager.

• Use cases: To distinguish different group.
• When to call: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupAliasUpdatedResult] can get the result of the change of group alias.

• Use cases: After creating a group, you need to change the group name.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupNameUpdatedCallback] can get the result of the change of name, through [onGroupNoticeUpdated] can get update group name information.

• Use cases: After creating a group, users need to change the mute status of the group.
• When to call: This can be called after a ZIM instance is created using [create] and logged into the group.
• Related callbacks: The result of changing the group mute status can be obtained through the [ZIMGroupMutedResult]. The updated group mute status information can be obtained through [groupMuteInfoUpdated].

• Use cases: After creating a group, users need to change the mute status of the group members.
• When to call: This can be called after a ZIM instance is created using [create] and logged into the group.
• Related callbacks: The result of changing the group members mute status can be obtained through the [ZIMGroupMembersMutedResult]. The updated group members mute status information can be obtained through [groupMemberInfoUpdated].

• Related callbacks: The result of changing the group name can be obtained through the [ZIMGroupAvatarUrlUpdatedCallback] callback, and the updated group avatar information can be obtained through the [onGroupAvatarUrlUpdated] callback.

• Use cases: You need to update the group bulletin in the group.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through callback [ZIMGroupNoticeUpdateCallback] can get update group of the results announcement, announcement by [onGroupNoticeUpdated] can get update group information.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.

• Use cases: You need to obtain group information for display.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupInfoQueriedCallback] can query the result of the group information.

• Use cases: You need to get a list of groups to display.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupListQueriedCallback] can get a check list of all current group results.

• Use cases: Added extended field information about group description, such as group family, label, and industry category.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupAttributesOperatedCallback] can get the result of the set of attributes.
• Related APIs: [deleteGroupAttributes] can be used to deleteGroupAttributes, [queryGroupAttributes] can be used to queryGroupAttributes, [queryAllGroupAttributes] can be used to queryAllGroupAttributes.

• Use cases: Deleted the extended field of the group description.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupAttributesOperatedCallback] can delete the result of the group of attributes.
• Related APIs: You can use [setGroupAttributes] to setGroupAttributes, [queryGroupAttributes] to queryGroupAttributes, and [queryAllGroupAttributes] to queryAllGroupAttributes.

• Use cases: You need to query the scenarios to display the specified group attributes.
• When to call /Trigger: After creating a ZIM instance with [create] and logging in with [login].
• Related callbacks: Through the callback [ZIMGroupAttributesQuriedCallback] can get query attributes of the specified group of results.
• Related APIs: [queryAllGroupAttributes] Queries all group attributes.

• Use cases: Scenarios where all group attributes need to be queried.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through callback can get query [ZIMGroupAttributesQuriedCallback] all the results of the group of attributes.
• Related APIs: [queryGroupAttributes] Queries the attributes of the specified group.

• Use cases: The ZIM instance can be invoked after being created by [create] and logged in.
• When to call /Trigger: If the primary role of a group is 1 and the default role of other members is 3, you can invoke this interface to change the role.
• Caution: The role of the group owner is 1, the role of the administrator is 2, and the role of the normal member is 3. You can modify it by calling this interface, but the role cannot be changed to 1. If you need to customize the role, it is recommended to set the value to 100 or higher, and its permissions will be the same as those of normal members.
• Related callbacks: Through the callback [ZIMGroupMemberRoleUpdatedCallback] can be set up to get the results of the group of members of the role.

• Use cases: Nicknames need to be set for group members.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Caution: A group member nickname can contain a maximum of 100 characters.
• Related callbacks: Through the callback [ZIMGroupMemberNicknameUpdatedCallback] can be set up to get the results of the group members nickname.

• Use cases: You need to obtain the specified group member information for display or interaction.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupMemberInfoQueriedCallback] can get the query specifies the result of group membership information.

• Use cases: You need to obtain the specified group member list for display or interaction.
• When to call /Trigger: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through the callback [ZIMGroupMemberListQueriedCallback] can query the result of the group member list.

• Use cases: You need to obtain the specified group muted member list for display or interaction.
• When to call: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: Through [ZIMGroupMemberMutedListQueriedResult] can query the result of the group muted member list.

• When to call: The ZIM instance can be invoked after being created by [create] and logged in.
• Related callbacks: [ZIMGroupMemberCountQueriedCallback].

• Use cases: When you need to know the relevant information of the specified conversation, you can call this interface to obtain the data source.
• When to call /Trigger: Can be invoked after login.
• Related callbacks: [ZIMConversationQueriedResult].

• Use cases: This interface can be invoked to get the data source when you need to display an existing message session after logging in.
• When to call /Trigger: Can be invoked after login.
• Caution: NextConversation is the riveting point of the query message, which can be null for the first query. In subsequent query, the earliest conversation can be used as nextConversation to query earlier sessions. In paging query, Count in [ZIMConversationQueryConfig] fill each pull the number of sessions.
• Related callbacks: [ZIMConversationListQueriedCallback].
• Related APIs: [deleteConversation] Deletes the session. [clearConversationUnreadMessageCount] clear session readings.

• Use cases: This interface can be invoked to get the data source when you need to display an existing message conversation after logging in.
• When to call /Trigger: Can be invoked after login.
• Caution: NextConversation is the riveting point of the query message, which can be null for the first query. In subsequent query, the earliest conversation can be used as nextConversation to query earlier sessions. In paging query, Count in [ZIMConversationQueryConfig] fill each pull the number of sessions.
• Related callbacks: [ZIMConversationListQueriedCallback].

• Use cases: This interface can be invoked to get the data source when you need to display an existing pinned message conversation after logging in.
• When to call /Trigger: Can be invoked after login.
• Caution: NextConversation is the riveting point of the query message, which can be null for the first query. In subsequent query, the earliest conversation can be used as nextConversation to query earlier sessions. In paging query, Count in [ZIMConversationQueryConfig] fill each pull the number of sessions.

• Use cases: This interface can be invoked to get the data source when you need to display an existing message conversation after logging in.
• When to call /Trigger: Can be called after logging in.
• Related callbacks: [ZIMConversationTotalUnreadMessageCountQueriedCallback].

• Use cases: You can call this interface when you need to modify the pinned state of a conversation.
• When to call /Trigger: Can be invoked after login.
• Related callbacks: [ZIMConversationPinnedStateUpdatedResult].

• Use cases: If you want to delete all conversations when they are no longer needed, you can call this interface implementation.
• When to call /Trigger: his parameter is invoked when conversations needs to be deleted and can be invoked after a ZIM instance is created. The call takes effect after login and becomes invalid after logout.
• Impacts on other APIs: If deleted conversations include unread message will trigger the [conversationTotalUnreadMessageCountUpdated] callback, the call is successful at login, and the other end will trigger [conversationsAllDeleted] callback.

• Use cases: You can invoke this interface implementation to delete an entire session when it is no longer needed.
• When to call /Trigger: his parameter is invoked when a session needs to be deleted and can be invoked after a ZIM instance is created. The call takes effect after login and becomes invalid after logout.
• Impacts on other APIs: A successful call triggers the deleteConversation callback. If the deleted conversation contains unread messages, the [onConversationTotalUnreadMessageCountUpdated] callback is triggered.
• Related callbacks: [ZIMConversationDeletedCallback]

• Use cases: This interface can be invoked when you need to temporarily save the text message that the user is editing but has not yet sent.
• When to call /Trigger: Call when you need to set session draft, call after creating ZIM instance, take effect after login, invalid after logout.
• Impacts on other APIs: A successful call triggers the [conversationchanged] callback.
• Related callbacks: [ZIMConversationDraftSetResult]

• Use cases: You can call this interface when you need to clear all unread conversations to zero.
• When to call /Trigger: Called when all conversation readings need to be cleared.
• Impacts on other APIs: Calling this method will trigger a total readings not updated callback [conversationTotalUnreadMessageCountUpdated].
• Related APIs: [conversationTotalUnreadMessageCountUpdated].

• Use cases: This interface is called when a chat page is entered from a session and the original message readings of the session need to be cleared.
• When to call /Trigger: Called when a target needs to be cleared without readings.
• Impacts on other APIs: Calling this method will trigger a total readings not updated callback [conversationTotalUnreadMessageCountUpdated], would trigger a session to update callbacks [conversationChanged].
• Related callbacks: [ZIMConversationUnreadMessageCountClearedCallback].
• Related APIs: [conversationTotalUnreadMessageCountUpdated]、[conversationChanged].

• Use cases: When you need to implement custom business logic based on conversation marks.
• Default value: The conversation marks defaults to empty.
• When to call: When logged in and a valid conversation exists, if you want to set or unset mark for the target conversation, call this interface.
• Related callbacks: [ZIMConversationMarkSetCallback]。

• Use cases: If the user selects MESSAGE DO not Disturb (DND), the user can call the corresponding method.
• Default value: Message DND is disabled by default.
• When to call /Trigger: If the target session exists after login, invoke this interface if you want to enable the DND status of the target session.
• Impacts on other APIs: After the DND state is enabled, receiving messages is not triggered [conversationTotalUnreadMessageCountUpdated]。
• Related callbacks: [ZIMConversationNotificationStatusSetResult]。
• Related APIs: [conversationTotalUnreadMessageCountUpdated]。

• Related APIs: [queryHistoryMessage], [sendMessage].

• Related APIs: [queryHistoryMessage], [sendMessage].

• Related callbacks: [ZIMMessagePinnedCallback], [onMessagePinStatusChanged].
• Related APIs: [queryPinnedMessageList], [sendMessage].

• Related APIs: [queryHistoryMessage], [deleteAllMessage], [deleteMessages],[sendMediaMessage].

• Impacts on other APIs: Using this method will trigger the [receivePeerMessage] / [receiveRoomMessage] / [receiveGroupMessage] callback of the message receiver, and will trigger the [conversationChanged] callback of the sender and receiver. Fires the [conversationTotalUnreadMessageCountUpdated] callback.

pushconfig only needs to be filled in when you need to use the offline push function. Sending media messages to the room does not support offline push, nor does it support the callbacks [conversationChanged] and [conversationTotalUnreadMessageCountUpdated].

• Related callbacks: [ZIMMessageSentResult], [ZIMMediaUploadingProgress], [receivePeerMessage], [receiveRoomMessage], [receiveGroupMessage], [conversationChanged], [conversationTotalUnreadMessageCountUpdated].
• Related APIs: [queryHistoryMessage], [deleteAllMessage], [deleteMessages]

• Use cases: The developer can combine the system message type, and convert the callback notification (for example, invite someone into the group, remove someone from the group, etc.) to the system message type on the client side and insert it into the local DB to achieve the effect of the system prompt .
• When to call: It can be called after login.
• Caution: Inserting "command" messages is not supported. To insert a "room" message, upgrade the SDK to 2.13.0 and above.
• Related callbacks: [ZIMMessageInsertedCallback].
• Related APIs: [queryHistoryMessage], [deleteAllMessage], [deleteMessages].

• Related callbacks: [ZIMFileCacheQueriedResult].

• Caution: The name of the message file exported by this interface is zim_backup_msg_text. If the passed in path is the same when calling this interface multiple times, the ZIM SDK will rename the old zim_backup_msg_text file by itself to ensure that the latest exported file name is zim_backup_msg_text.
• Related callbacks: [ZIMMessageExportedCallback].

• Caution: The ZIM SDK reads a file named zim_backup_msg_text in the directory by default. If there are multiple backups in this path, please confirm whether the name of the file to be imported is zim_backup_msg_text.
• Related callbacks: [ZIMMessageImportedCallback].

• Use cases: Set all received receipt messages in the entire conversation to be read, and the sender of the message receipt in the conversation will receive the [onConversationMessageReceiptChanged] callback from ZIMEventHandler.
• When to call: It can be called after login. It is recommended to call before entering the message list page. In the message list page, it is recommended to call [sendMessageReceiptsRead] to batch set the messages that need to be read.
• Caution: Only single chat conversation are allowed.

Related callback: [ZIMConversationMessageReceiptReadSentCallback].

• Related APIs: [sendMessageReceiptsRead], [sendMessage].

• Use cases: Developers can use this method to set a batch of messages with receipts that have been read. If the sender is online, it will receive the [onMessageReceiptChanged] callback.
• When to call: Callable after login. It is recommended to set the settings for the messages that need to be read on the message list page. It is not recommended to mix with [sendConversationMessageReceiptRead].
• Related callbacks: [ZIMMessageReceiptsReadSentCallback].
• Related APIs: [sendMessage].

• Use cases: If you need to query the receipt status of the message, the number of unread users and the number of read users, you can call this interface.
• When to call: Callable after login. If you need to query the detailed member list, you can query through the interface [queryGroupMessageReceiptReadMemberList] or [queryGroupMessageReceiptUnreadMemberList].
• Related callbacks: [ZIMMessageReceiptsInfoQueriedResult].
• Related APIs: [queryGroupMessageReceiptReadMemberList] , [queryGroupMessageReceiptUnreadMemberList].

• Use cases: Developers can use this method to query the specific read member list of a message they send.
• When to call: Callable after login.
• Related callbacks: [ZIMGroupMessageReceiptMemberListQueriedCallback].
• Related APIs: If you need to query the receipt status of a certain message or only need to query the read/unread count, you can query through the interface [queryMessageReceiptsInfo].

• Use cases: Developers can use this method to query the specific unread member list of a message they send.
• When to call: Callable after login.
• Related callbacks: [ZIMGroupMessageReceiptMemberListQueriedCallback].
• Related APIs: If you need to query the receipt status of a certain message or only need to query the read/unread count, you can query through the interface [queryMessageReceiptsInfo].

• Related callbacks: [ZIMMessagesSearchedResult].

• Related callbacks: [ZIMConversationsSearchedResult].

• Related callbacks: [ZIMMessagesGlobalSearchedResult].

• Related APIs: [queryHistoryMessage], [sendMessage], [sendMediaMessage].

• Use cases: Developers can use this method to query the entire reply message tree.
• When to call: Callable after login.

• Related callbacks: [ZIMMediaDownloadedResult], [ZIMMediaDownloadingProgress].

• Related callbacks: [ZIMMediaDownloadedResult], [ZIMMediaDownloadingProgress].

• Use cases: This function is used in 1V1 chat scenarios.

• Related callbacks: [ZIMMessageQueriedCallback].

• Related callbacks: [ZIMPinnedMessageListQueriedCallback].

• Impacts on other APIs: Call the interface trigger [onMessageDeleted] callback, if there are unread messages at this time, will trigger [onConversationTotalUnreadMessageCountUpdated] callback.
• Related callbacks: [ZIMConversationMessagesAllDeletedCallback]、[onMessageDeleted]、[onConversationTotalUnreadMessageCountUpdated].

• Use cases: If you need to obtain the specific sub-messages under the combine message, you can call this API to query.

• Use cases: The user needs to recall a message. This method can be used when the user does not want other users to see the message.
• When to call: Called when the message needs to be revoked.

Room message revoke is not supported.

• Related callbacks: If the revoked message is the latest message of the session, the [conversationChanged] callback will be triggered, and if the message is unread, the [conversationTotalUnreadMessageCountUpdated] callback will be triggered.

• Impacts on other APIs: If the deleted message is the latest message of the session, the [conversationChanged] callback will be triggered, and if the message is unread, the [conversationTotalUnreadMessageCountUpdated] callback will be triggered.
• Related callbacks: [ZIMMessageDeletedCallback]、[conversationChanged]、[conversationTotalUnreadMessageCountUpdated].

• Use cases: Users need to express their position on a certain message, such as liking, and this method can be used to express their position.

Room message reaction is not supported.

• Related callbacks: If the addition is successful, the [messageReactionsChanged] callback will be triggered. If the reaction is made to the latest message in the conversation, the [conversationChanged] callback will be triggered when the addition is successful.

• Use cases: Users need to delete the status of a message that has already been stated, which can be done using this method.

Room message reaction is not supported.

• Related callbacks: If the deletion is successful, the [messageReactionsChanged] callback will be triggered. If the reaction is deleted from the latest message in the conversation, the [conversationChanged] callback will be triggered when the deletion is successful.

• Use cases: When it is necessary to obtain specific user information under a certain state of a message, this interface can be called to query state user messages in a paginated manner.

• Impacts on other APIs: The [conversationChanged] callback is triggered, and if there are unread messages, the [conversationTotalUnreadMessageCountUpdated] callback is triggered.
• Related callbacks: [ZIMMessageDeletedCallback].

• When to call: After the user is logged in.
• Privacy reminder: Please avoid passing sensitive personal information, including but not limited to phone numbers, ID card numbers, passport numbers, real names, etc.
• Related callbacks: [ZIMMessageLocalExtendedDataUpdatedResult ].

• Use cases: When you need to know the user information in the specified room, you can call this interface to obtain the data source.
• When to call /Trigger: Can be invoked after login.

• Use cases: Use this interface when you need to specify that you want to query some room users.
• Related callbacks: [ZIMRoomMembersAttributesQueriedResult].
• Related APIs: [setRoomMembersAttributes]、[queryRoomMemberAttributesList].
• Runtime lifecycle: It is available after logging in and joining the corresponding room, but unavailable after leaving the corresponding room.

• Use cases: This interface is used when you need to query all room users.
• Related callbacks: [ZIMRoomMemberAttributesListQueriedResult].
• Related APIs: [setRoomMembersAttributes]、[queryRoomMembersAttributes].
• Runtime lifecycle: It is available after logging in and joining the corresponding room, but unavailable after leaving the corresponding room.