Class

2026-07-24


ZIM	ZIMEventHandler

ZIM

Details

ZIM SDK main class.

Methods

getVersion

static

getVersion

static getVersion(): string

Gets the SDK's version number.

Get the SDK version. Use cases:

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

Available since：1.1.0.

create

static

create

static create(appConfig: ZIMAppConfig): ZIM | null

Create a ZIM instance.

Parameters

Name	Type	Description
appConfig	ZIMAppConfig	ZIMAppConfig

Details

Create a ZIM instance for subsequent calls to other member functions.

When to call：Before calling other member functions, you must call this API to create a ZIM example.
Scope of impact：Failure to call this function will prevent other member functions from being called. Platform differences: When calling this function on the Android platform, in addition to the appID, the Application class object must also be passed in.

Available since：2.3.0 and above.
Restrictions：Currently only one instance is supported, repeated calls will return [null]. Caution:

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.
If you use this function to create an instance, you must pass in both AppID and AppSign (exclude Web platform).

getInstance

static

getInstance

static getInstance(): ZIM | null

Get the ZIM singleton object.

Get the ZIM singleton object for subsequent calls to other member functions.

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 APIs：[create].

Available since：2.3.0 and above.

setAdvancedConfig

static

setAdvancedConfig

static setAdvancedConfig(key: string, value: string): void

Set ZIM advanced configuration.

Parameters

Name	Type	Description
key	string	Configuration Key
value	string	Configuration value

When you need to customize the set advanced configurations, you need to call this function. It must be set before calling [create] to take effect. If it is set after [create], it will take effect at the next [create].

setGeofencingConfig

static

setGeofencingConfig

static setGeofencingConfig(areaList: number[], type: ZIMGeofencingType): boolean

Set geofence-related configurations.

Parameters

Name	Type	Description
areaList	number[]	Geofencing area list
type	ZIMGeofencingType	Geofencing type

Details

Geofencing means that instant messaging data transmission is limited to a certain area to meet regional data privacy and security regulations, that is, to restrict access to communication services in a specific area.

When to call：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.

Available since：2.12.0 and above.
Restrictions：If you need to use this function, please contact ZEGO technical support.

setLogConfig

setLogConfig(config: ZIMLogConfig): void

Set log related configuration.

Parameters

Name	Type	Description
config	ZIMLogConfig	Custom log configuration

Details

Set log related configuration, including log path and log size. Since there is a default log path inside the SDK, unless the developer has a strong need to customize the log path, it is generally not recommended that customers set it by themselves. Default value:

Android：/storage/Android/data/[packageName]/files/ZIMLogs
iOS：~/Library/Caches/ZIMLogs
macOS：(sandbox) ~/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMLogs /; (non-sandbox) ~/Library/Caches/ZIMLogs
Windows：C:/Users/[Your UserName]/AppData/[App Name]ZEGO.SDK/ZIMLogs
When to call：It must be called before [create].
Caution：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 differences: The default path of different platforms is different, please refer to the default value.
Related APIs：For details, please refer to https://doc-zh.zego.im/faq/IM_sdkLog?product=IM&platform=all.

Available since：1.1.0 and above.

destroy

destroy(): void

Destroy the ZIM instance.

Release the resources used by the ZIM instance. This function must be called to release the occupied memory resources when ZIM is no longer needed, otherwise a memory leak may occur.

When to call：call when ZIM is no longer needed, usually before emptying the ZIM object.
Caution：After calling this function, ZIM internal functions can no longer be used, and all callback notifications will no longer be triggered. If you need to continue using the ZIM function, please call [create] again to create a new instance.

Available since：1.1.0 and above.

on

on<K extends keyof ZIMEventHandler>(type: K, listener: ZIMEventHandler[K]): void

Set the event notification callbacks that need to be handled. If the eventHandler is set to [null], all the callbacks set previously will be cleared.

Parameters

Name	Type	Description
type	K	Event type
listener	ZIMEventHandler[K]	Event callback

Details

Set event notification callback, pass [null] to clear the set callback.

When to call：After calling [create] to create an instance, this function must be called through the instance.
Caution：If the developer calls this function multiple times, it will overwrite the callback set by the last call to this function.
Life cycle：Set this function after calling [create], and you can receive ZIM-related event notifications normally; after calling [destroy], you will no longer receive any event notifications.

Available since：1.1.0 and above.

off

off<K extends keyof ZIMEventHandler>(type: K): void

Remove event notification callback.

Parameters

Name	Type	Description
type	K	Event type

Details

Remove event notification callback.

When to call：After calling [create] to create an instance, this function must be called through the instance.
Caution：If the developer calls this function multiple times, it will overwrite the callback set by the last call to this function.
Life cycle：Set this function after calling [create], and you can receive ZIM-related event notifications normally; after calling [destroy], you will no longer receive any event notifications.

Available since：1.1.0 and above.

uploadLog

uploadLog(): void

Upload log and call after setting up log path.

By default, the SDK will create and print log files in the default directory of the App. By default, the maximum value of each log file is 5MB, and the three log files are written in a cycle. When this function is called, the SDK automatically packages and uploads the log file to the ZEGO server.

Use cases：Developers can provide business "feedback" channels in the App. When user feedback problems belong to ZEGO SDK, they can call this function to upload the local log information of SDK and contact ZEGO technical support to help locate user problems.
When to call：It must be after calling [create] to create an instance.
Caution：If you call [destroy] or exit the App too quickly after calling this interface to upload logs, it may fail. You are advised to wait a few seconds and then call [destroy] or exit the App after receiving the callback for successful upload.
Related callbacks：Developers can get the upload results through the callback parameter.

Available since：1.2.0 and above.
Restrictions：If this interface is invoked repeatedly within 10 minutes, only the last invocation takes effect.

login(userID: string, config: ZIMLoginConfig): void

Parameters

Name	Type	Description
userID	string	Used to identify user information, the unique ID of the user.
config	ZIMLoginConfig	Various parameters used for specific login actions.

Details

Log in to the ZIM service. [login] is the most important step of the ZIM function. You need to log in before using any other functions.

When to call：This function must be called after calling [create] to create an instance and before calling other instance functions.
Caution：Before using ZIM's single chat, room, message sending and receiving functions, you must first call this function to log in, and the UI can be displayed to the user through the login result.
Privacy statement：remind users not to pass in sensitive information involving personal privacy in the userID parameter, including but not limited to mobile phone number, ID number, passport number, real name, etc.
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.
FAQ：How is the RTC login different from ZEGO's? RTC login refers to the login to the room, ZIM login to the account.
References：For details, please refer to Authentication (https://docs.zegocloud.com/article/13772).

Available since：2.13.0 and above.

logout

logout(config: ZIMLogoutConfig): void

Logout parameter configuration.

Parameters

Name	Type	Description
config	ZIMLogoutConfig

Details

Log out of the ZIM service.

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

Available since：1.1.0 or above.

renewToken

renewToken(token: string): Promise<ZIMTokenRenewedResult>

Update the authentication token.

Parameters

Name	Type	Description
token	string	The token issued by the developer's business server, used to ensure security. The generation rules are detailed in ZEGO document website.

Details

Update the authentication token so that the authentication token can be updated in time after it expires, so as to continue to use ZIM functions normally.

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.
Life cycle：The life cycle of this function depends on the validity period of the authentication token, which is determined by the developer business.
References：For details, please refer to the Token generation documentation.
Caution：After the developer receives the [onTokenWillExpire] callback, the developer needs to request the authentication server to regenerate a token in time.

Available since：1.1.0 or above.

callExperimentalAPI

callExperimentalAPI(params: string): Promise<string>

Call the experimental API.

Parameters

Name	Type	Description
params	string	Parameters in the format of a JSON string, please consult ZEGO technical support for details.

ZEGO provides some technical previews or special customization functions in ZIM business through this API. If you need to get the use of the function or the details, please consult ZEGO technical support.

updateUserName

updateUserName(userName: string): Promise<ZIMUserNameUpdatedResult>

Update user's user name.

Parameters

Name	Type	Description
userName	string	User name , It is customized by the developer. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.

Details

After user logs in, calling this interface could update the user's own user name.

When to call：After the user is logged in.
Caution：This interface does not support modifying user names in rooms.
Privacy statement：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].

Available since：2.2.0 or above.

updateUserAvatarUrl

updateUserAvatarUrl(userAvatarUrl: string): Promise<ZIMUserAvatarUrlUpdatedResult>

Update user's avatar URL.

Parameters

Name	Type	Description
userAvatarUrl	string	User avatar URL wanted to changed to.

Details

After the user logs in, calling this interface can set or update the user's own user avatar URL.

When to call：After the user logs in.
Caution：The user avatar itself needs to be stored by the developer, and ZIM only saves its user information as a pass-through URL.
Related callbacks：[ZIMUserAvatarUrlUpdatedCallback].
Related APIs：[queryUsersInfo].

Available since：2.3.0 and above.
Restrictions：There is no limit on special characters and a maximum of 500 bytes.

updateUserExtendedData

updateUserExtendedData(extendedData: string): Promise<ZIMUserExtendedDataUpdatedResult>

Update user's user extended data.

Parameters

Name	Type	Description
extendedData	string	User extended data wanted to changed to .

Details

After user logs in, calling this interface could update the user's own user extended data.

When to call：After the user is logged in.
Privacy statement：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：[ZIMUserExtendedDataUpdatedCallback].
Related APIs：[updateUserName] and [ queryUsersInfo ].

Available since：2.2.0 or above.

updateUserOfflinePushRule

updateUserOfflinePushRule(offlinePushRule: ZIMUserOfflinePushRule): Promise<ZIMUserOfflinePushRuleUpdatedResult>

Update user's custom rule of offline push.

Parameters

Name	Type	Description
offlinePushRule	ZIMUserOfflinePushRule	The user pushes the rule information offline, and the interface will be fully updated with the member properties of the input object each time the interface is called.

Details

This interface is used to modify the custom rule of offline push for 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：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：onUserRuleUpdate、ZIMUserOfflinePushRuleUpdatedCallback
Related APIs：querySelfUserInfo

Available since：2.15.0 and later versions.

updateUserCustomStatus

updateUserCustomStatus(customStatus: string, config: ZIMUserCustomStatusUpdateConfig): Promise<ZIMUserCustomStatusUpdatedResult>

Update user's custom status.

Parameters

Name	Type	Description
customStatus	string	User custom status.
config	ZIMUserCustomStatusUpdateConfig	Config of user custom status.

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

updateUserBadge

updateUserBadge(badge: number): void

Update the number of iOS offline notification badges.

Parameters

Name	Type	Description
badge	number	The user’s expected APP badge value.

Details

This API updates the APP badge count on the current user’s mobile clients. It applies to the user on mobile devices where they have logged in.

Use cases：In multi-device login scenarios, after the developer clears unread counts (or when unread counts change) on desktop or web, and wants mobile users’ APP badge counts to reflect and sync to the corresponding value, this API can be called to achieve that.
When to call：After login, with a good network connection, and when the total unread count changes. It only needs to be called on non-mobile platforms that do not support ZPNs (such as desktop and web).
Caution：After a successful call, the APP badge value will be updated to the specified value on all offline mobile clients where the user has logged in.
Related callbacks：[ZIMUserBadgeUpdatedCallback].

Available since：2.28.0 or above.

queryUsersInfo

queryUsersInfo(userIDs: string[], config: ZIMUsersInfoQueryConfig): Promise<ZIMUsersInfoQueriedResult>

Query user information.

Parameters

Name	Type	Description
userIDs	string[]	userID list.
config	ZIMUsersInfoQueryConfig	Query user information configuration.

Details

Through this interface, you can query and obtain the corresponding UserInfo by userID.

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

Available since：2.3.0 or above.
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.

queryUsersStatus

queryUsersStatus(userIDs: string[]): Promise<ZIMUsersStatusQueriedResult>

Query the user statuses of other users.

Parameters

Name	Type	Description
userIDs	string[]	User ID list.

Details

Query the user statuses of other users.

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：Can be called after login and when the network conditions are good.
Caution：The query targets can not include unregistered users.
Related callbacks：ZIMUsersStatusQueriedCallback.

Available since：2.18.0

querySelfUserInfo

querySelfUserInfo(): Promise<ZIMSelfUserInfoQueriedResult>

Query user information and user rules.

Query information about the current user and user rules. In offline state, you can query local data.

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：Call after login.

Available since：2.15.0 .
Restrictions：ZIMSelfUserInfoQueriedCallback、userInfoUpdated、userRuleUpdated

subscribeUsersStatus

subscribeUsersStatus(userIDs: string[], config: ZIMUserStatusSubscribeConfig): Promise<ZIMUsersStatusSubscribedResult>

Subscribe to the user status of other users

Parameters

Name	Type	Description
userIDs	string[]	User ID list.
config	ZIMUserStatusSubscribeConfig	Configuration for subscribing to user status.

Details

Subscribing to the user status of other users through this interface.

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 [onUserStatusUpdated] interface is updated.
When to call：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：[ZIMUsersStatusSubscribedCallback],[onUserStatusUpdated]
Related APIs：[unsubscribeUsersStatus]

Available since：2.18.0
Restrictions：The maximum number of subscribers is 100. By default, a single user can subscribe to a maximum of 3000 users. When the number of subscribers reaches the upper limit, the new subscribers will overwrite the original subscribers.

unsubscribeUsersStatus

unsubscribeUsersStatus(userIDs: string[]): Promise<ZIMUsersStatusUnsubscribedResult>

This command is used to batch unsubscribe the target users in the current user subscription list.

Parameters

Name	Type	Description
userIDs	string[]	User ID list.

Details

Batch unsubscribe the target user in the current user subscription list.

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

Available since：2.18.0
Restrictions：The maximum number of userids passed in at a time is 100.

querySubscribedUserStatusList

querySubscribedUserStatusList(config: ZIMSubscribedUserStatusQueryConfig): Promise<ZIMSubscribedUserStatusListQueriedResult>

This command is used to query the user status subscription list of the current user.

Parameters

Name	Type	Description
config	ZIMSubscribedUserStatusQueryConfig	Configuration for querying subscribed user status list.

Details

This command is used to query the user status subscription list of the current user.

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：It can be called after login, regardless of network status.
Related callbacks：ZIMSubscribedUserStatusListQueriedCallback、subscribeUsersStatus、unsubscribeUsersStatus.
Related APIs：subscribeUsersStatus、unsubscribeUsersStatus.

Available since：2.18.0
Restrictions：The data obtained is the local cache of the SDK. When the network conditions are good after login, the SDK periodically synchronizes data to the background.

queryConversationList

queryConversationList(config: ZIMConversationQueryConfig, option: ZIMConversationFilterOption): Promise<ZIMConversationListQueriedResult>

Query the conversation list.

Parameters

Name	Type	Description
config	ZIMConversationQueryConfig	Configuration for session queries.
option	ZIMConversationFilterOption	Filter options for session queries.

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

queryConversation

queryConversation(conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationQueriedResult>

Query a conversation by conversation ID and conversation type.

Parameters

Name	Type	Description
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.

Details

This method displays the session list of the logged in user.

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：Can be invoked after login.
Related callbacks：[ZIMConversationQueriedCallback].

Available since：2.8.0 and above.
Restrictions：There is no limit to the frequency of use, available after login, unavailable after logout.

queryConversationPinnedList

queryConversationPinnedList(config: ZIMConversationQueryConfig): Promise<ZIMConversationPinnedListQueriedResult>

Query the conversation pinned list.

Parameters

Name	Type	Description
config	ZIMConversationQueryConfig	Configuration for session queries.

Details

This method displays the pinned conversation list of the logged in user.

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

Available since：2.8.0 and above.
Restrictions：There is no limit to the frequency of use, available after login, unavailable after logout.

updateConversationPinnedState

updateConversationPinnedState(isPinned: boolean, conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationPinnedStateUpdatedResult>

Modify the conversation pinned state.

Parameters

Name	Type	Description
isPinned	boolean	Whether the conversation is pinned, [true] is pinned, [false] is unpinned.
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.

Details

This method can modify the pinned state of the specified conversation of the logged-in user.

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

Available since：2.8.0 and above.
Restrictions：Available after login, unavailable after logout.

deleteConversation

deleteConversation(conversationID: string, conversationType: ZIMConversationType, config: ZIMConversationDeleteConfig): Promise<ZIMConversationDeletedResult>

delete the conversation.

Parameters

Name	Type	Description
conversationID	string	conversationID.
conversationType	ZIMConversationType	conversationtype.
config	ZIMConversationDeleteConfig	delete the session's configuration.

Details

This interface is invoked when a session needs to be deleted. All members in the session can invoke this interface.

Use cases：You can invoke this interface implementation to delete an entire session when it is no longer needed.
When to call：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.
Scope of impact：A successful call triggers the deleteConversation callback. If the deleted conversation contains unread messages, the [onConversationTotalUnreadMessageCountUpdated] callback is triggered.
Related callbacks：[ZIMConversationDeletedCallback]

Available since：2.0.0 and above.

deleteAllConversations

deleteAllConversations(config: ZIMConversationDeleteConfig): void

delete all conversations.

Parameters

Name	Type	Description
config	ZIMConversationDeleteConfig	delete all conversation's configuration.

Details

This interface is invoked when all conversations needs to be deleted. All members in conversations can invoke this interface.

Use cases：If you want to delete all conversations when they are no longer needed, you can call this interface implementation.
When to call：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.
Scope of impact：If deleted conversations include unread message will trigger the [onConversationTotalUnreadMessageCountUpdated] callback, the call is successful at login, and the other end will trigger [onConversationsAllDeleted] callback.
Related callbacks：[ZIMConversationsAllDeletedCallback]

Available since：2.12.0 and above.

clearConversationUnreadMessageCount

clearConversationUnreadMessageCount(conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationUnreadMessageCountClearedResult>

clear session unreads.

Parameters

Name	Type	Description
conversationID	string	conversationID.
conversationType	ZIMConversationType	conversation type.

Details

Used to clear unread for the current user target session.

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：Called when a target needs to be cleared without readings.
Scope of impact：Calling this method will trigger a total readings not updated callback [onConversationTotalUnreadMessageCountUpdated], would trigger a session to update callbacks [onConversationChanged].
Related callbacks：[ZIMConversationUnreadMessageCountClearedCallback].
Related APIs：[onConversationTotalUnreadMessageCountUpdated]、[onConversationChanged].

Available since：2.0.0 and above.
Restrictions：Valid after login, invalid after logout.

clearConversationTotalUnreadMessageCount

clearConversationTotalUnreadMessageCount(): void

clear all conversations unreads.

Used to clear unread for all conversations.

Use cases：You can call this interface when you need to clear all unread conversations to zero.
When to call：Called when all conversation readings need to be cleared.
Scope of impact：Calling this method will trigger a total readings not updated callback [onConversationTotalUnreadMessageCountUpdated].
Related callbacks：[ZIMConversationTotalUnreadMessageCountClearedCallback].
Related APIs：[onConversationTotalUnreadMessageCountUpdated].

Available since：2.12.0 and above.
Restrictions：Valid after login, invalid after logout.

queryConversationTotalUnreadMessageCount

queryConversationTotalUnreadMessageCount(config: ZIMConversationTotalUnreadMessageCountQueryConfig): Promise<ZIMConversationTotalUnreadMessageCountQueriedResult>

Query the conversations total unread message count by config.

Parameters

Name	Type	Description
config	ZIMConversationTotalUnreadMessageCountQueryConfig	Configuration for querying the total unread count of the conversation.

Details

his method can query the total number of unread messages in the conversations of the logged-in user according to the configuration items.

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：Can be called after logging in.
Related callbacks：[ZIMConversationTotalUnreadMessageCountQueriedCallback].

Available since：2.17.0 and above.
Restrictions：There is no limit on the frequency of use; it is available after logging in and not available after logging out.

setConversationNotificationStatus

setConversationNotificationStatus(status: ZIMConversationNotificationStatus, conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationNotificationStatusSetResult>

Set the conversation notification state.

Parameters

Name	Type	Description
status	ZIMConversationNotificationStatus	the session notification state.
conversationID	string	Conversation ID. Currently, only "group" conversations and "peer"(only for 2.14.0 or above version) conversations can be set by notification state.
conversationType	ZIMConversationType	Conversation type, such as peer, group, etc.

Details

This method enables DND by selecting whether the unread of the target session is updated when a message is received. For conversations where Do Not Disturb is enabled, offline push notifications for that conversation are generally not received, unless the conversation is a group chat, the message sender has mentioned the current user, and the isNotifyMentionedUsers property in ZIMMessageSendConfig is set to true. In that case, the user will receive offline push notifications for that conversation.

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：If the target session exists after login, invoke this interface if you want to enable the DND status of the target session.
Scope of impact：After the DND state is enabled, receiving messages is not triggered [conversationTotalUnreadMessageCountUpdated]。
Related callbacks：[ZIMConversationNotificationStatusSetCallback]。
Related APIs：[conversationTotalUnreadMessageCountUpdated]。

Available since：2.0.0 and above.
Restrictions：Valid after login, invalid after logout.

sendConversationMessageReceiptRead

sendConversationMessageReceiptRead(conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationMessageReceiptReadSentResult>

Sets all received receipts for the conversation as read.

Parameters

Name	Type	Description
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type, such as peer, group, etc.

Details

Set all received receipts of the conversation to be read.

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 callbacks：[ZIMConversationMessageReceiptReadSentCallback].
Related APIs：[sendMessageReceiptsRead], [sendMessage].

Available since：2.5.0 and above.

setConversationDraft

setConversationDraft(draft: string, conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationDraftSetResult>

Set a conversation draft.

Parameters

Name	Type	Description
draft	string	Drafts that need to be set.
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type, such as peer, group, etc.

Details

When you need to set a draft for a session, call this interface, and members of the session can call this interface.

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：Call when you need to set session draft, call after creating ZIM instance, take effect after login, invalid after logout.
Scope of impact：A successful call triggers the [onConversationChanged] callback.
Related callbacks：[ZIMConversationDraftSetCallback]

Available since：2.14.0 and above.

setConversationMark

setConversationMark(markType: number, enable: boolean, conversationInfos: ZIMConversationBaseInfo[]): Promise<ZIMConversationMarkSetResult>

Set the conversation marked status.

Parameters

Name	Type	Description
markType	number	Mark value that needs to be set.
enable	boolean	Whether to enable the mark value.
conversationInfos	ZIMConversationBaseInfo[]	Conversation information list that needs to be set.

Details

This method can set marks for the conversation.

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

Available since：2.17.0 and above.
Restrictions：The range for setting marks is [1, 20]. A maximum of 100 conversations are supported for marking at one time.

setConversationMessageDestructDuration

setConversationMessageDestructDuration(duration: number, conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationMessageDestructDurationSetResult>

Set the timed message self-destruction duration for a conversation.

Parameters

Name	Type	Description
duration	number	The message self-destruction duration to set for the conversation.
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type, such as peer, group, etc.

Details

Call this API when you need messages in a conversation to be automatically destroyed after being sent. By default, all members in the conversation can call this API.

Use cases：This API can be used when users have higher sensitivity or security requirements in conversation chats.
When to call：Can be called after creating a ZIM instance. Takes effect after login and becomes invalid after logout.
Scope of impact：After a successful call, the setting takes effect for both the local and peer users in peer-to-peer conversations simultaneously, and for all members in group conversations.
Caution：In group chat scenarios, all group members can configure this setting by default. The permission can be restricted to group owners or administrators only.
Related callbacks：[ZIMConversationMessageDestructDurationSetCallback].

Available since：3.0.0 and above.

searchLocalConversations

searchLocalConversations(config: ZIMConversationSearchConfig): Promise<ZIMConversationsSearchedResult>

Search local conversations on local messages.

Parameters

Name	Type	Description
config	ZIMConversationSearchConfig	Global search conversation config.

Details

This method is used for searching local conversations based on local messages.

Use cases：When there is a need to search conversations using keywords or other conditions, this API can be called for searching.
When to call：It should be invoked when there is a requirement to search conversations using keywords or other conditions.
Related callbacks：[ZIMConversationsSearchedCallback].

Available since：2.9.0 and above.
Restrictions：effective after logging in and becomes invalid after logging out. Searching is not supported in room scenarios (conversationType=1).

sendMessage

sendMessage(message: ZIMMessage, toConversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSendConfig, notification: ZIMMessageSendNotification): Promise<ZIMMessageSentResult>

send message.

Parameters

Name	Type	Description
message	ZIMMessage	The message to be sent.
toConversationID	string	The conversation ID the message needs to be sent.
conversationType	ZIMConversationType	The conversation type the message needs to be sent.
config	ZIMMessageSendConfig	Related configuration for sending messages.
notification	ZIMMessageSendNotification	Related notifications when messages are sent.

Details

This method can be used to send messages in single chat, room and group chat.

Use cases：When you need to send message to the target user, target message room, and target group chat after logging in, send it through this interface.
When to call：It can be called after login.
Related callbacks：[ZIMMessageSentCallback], [ZIMMessageSendNotification], [onPeerMessageReceived], [onRoomMessageReceived], [onGroupMessageReceived], [onConversationChanged], [onConversationTotalUnreadMessageCountUpdated].
Related APIs：[queryHistoryMessage], [deleteAllMessage], [deleteMessages],[sendMediaMessage].

Available since：2.4.0 and above.
Restrictions：The interval between sending messages should be greater than 100ms. Available after login, unavailable after logout.

queryHistoryMessage

queryHistoryMessage(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageQueryConfig): Promise<ZIMMessageQueriedResult>

Query historical messages.

Parameters

Name	Type	Description
conversationID	string	The session ID of the queried historical message.
conversationType	ZIMConversationType	conversation type.
config	ZIMMessageQueryConfig	Query the configuration of historical messages.

Details

This method is used to query historical messages.

Use cases：When you need to obtain past historical messages, you can call this interface to query historical messages by paging.
When to call：Called when historical messages need to be queried.
Related callbacks：[ZIMMessageQueriedCallback].

Available since：2.0.0 and above.
Restrictions：Effective after login, invalid after logout. In the default room scenario (conversationType=1), offline message is disabled. If you need to enable it, please contact the corresponding technical support.

queryMessages

queryMessages(messageSeqs: number[], conversationID: string, conversationType: ZIMConversationType): Promise<ZIMMessageQueriedResult>

Query messages based on the message seq list.

Parameters

Name	Type	Description
messageSeqs	number[]	The list of message sequence numbers to query.
conversationID	string	The session ID of the queried message.
conversationType	ZIMConversationType	conversation type.

Available since：2.19.0 and above.

deleteMessages

deleteMessages(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageDeleteConfig): Promise<ZIMMessageDeletedResult>

delete message.

Parameters

Name	Type	Description
messageList	ZIMMessage[]	List of deleted messages.
conversationID	string	The session ID of the deleted message.
conversationType	ZIMConversationType	conversation type.
config	ZIMMessageDeleteConfig	Delete the configuration of the message.

Details

This method implements the function of deleting messages.

Use cases：The user needs to delete a message. When the user does not need to display a message, this method can be used to delete it.
When to call：Called when the message needs to be deleted.
Caution：The impact of deleting messages is limited to this account.
Scope of impact：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].

Available since：2.0.0 and above.
Restrictions：Effective after login.

deleteAllMessage

deleteAllMessage(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageDeleteConfig): Promise<ZIMMessageDeletedResult>

Delete all message.

Parameters

Name	Type	Description
conversationID	string	The session ID of the message to be deleted.
conversationType	ZIMConversationType	conversation type.
config	ZIMMessageDeleteConfig	delete message configuration.

Details

When you need to delete all messages under the target session, call this method.

Use cases：If you want to implement a group setting page to clear the chat information under the current session, you can call this interface.
When to call：The target session exists and the user is a member of this session.
Caution：The impact of deleting messages is limited to this account, and messages from other accounts will not be deleted.
Scope of impact：The [conversationChanged] callback is triggered, and if there are unread messages, the [conversationTotalUnreadMessageCountUpdated] callback is triggered.
Related callbacks：[ZIMMessageDeletedCallback].

Available since：2.0.0 and above.
Restrictions：Effective after login, invalid after logout.

deleteAllConversationMessages

deleteAllConversationMessages(config: ZIMMessageDeleteConfig): void

Delete all messages for all conversations.

Parameters

Name	Type	Description
config	ZIMMessageDeleteConfig	delete message configuration.

Details

This method implements the function of deleting all messages for all sessions.

Use cases：The user needs to delete a message. When the user does not need to display a message, this method can be used to delete it.
When to call：Called when you need to delete all messages for all sessions.
Caution：IsAlsoDeleteServerMessage decided whether to delete a server message, the impact of deleting messages is limited to this account.
Scope of impact：Call the interface trigger [onMessageDeleted] callback, if there are unread messages at this time, will trigger [onConversationTotalUnreadMessageCountUpdated] callback.
Related callbacks：[ZIMConversationMessagesAllDeletedCallback]、[onMessageDeleted]、[onConversationTotalUnreadMessageCountUpdated].

Available since：2.14.0 and above.
Restrictions：Effective after login.

insertMessageToLocalDB

insertMessageToLocalDB(message: ZIMMessage, conversationID: string, conversationType: ZIMConversationType, senderUserID: string): Promise<ZIMMessageInsertedResult>

Insert a message to the local DB.

Parameters

Name	Type	Description
message	ZIMMessage	The message to be sent.
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
senderUserID	string	The sender ID of this message.

Details

This method can insert a message directly to the local DB on the client side.

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

Available since：2.4.0 and above.

sendMessageReceiptsRead

sendMessageReceiptsRead(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): Promise<ZIMMessageReceiptsReadSentResult>

Set the receipt of a batch of messages to become read.

Parameters

Name	Type	Description
messageList	ZIMMessage[]	The list of messages to be read with no more than 10 messages.
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.

Details

This method can set the receipt of a batch of messages to become read.

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

Available since：2.5.0 and above.
Restrictions：Only support the settings for received messages with receipt status as PROCESSING.

queryMessageReceiptsInfo

queryMessageReceiptsInfo(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): Promise<ZIMMessageReceiptsInfoQueriedResult>

Query the receipt information of a batch of messages.

Parameters

Name	Type	Description
messageList	ZIMMessage[]	list of messages to query.
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.

Details

This method can query the receipt information of a batch of messages, including the status, the number of unread users and the number of read users.

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：[ZIMMessageReceiptsInfoQueriedCallback].
Related APIs：[queryGroupMessageReceiptReadMemberList] , [queryGroupMessageReceiptUnreadMemberList].

Available since：2.5.0 and above.
Restrictions：Only messages whose statuses are not NONE and UNKNOWN are supported.

revokeMessage

revokeMessage(message: ZIMMessage, config: ZIMMessageRevokeConfig): Promise<ZIMMessageRevokedResult>

revoke message.

Parameters

Name	Type	Description
message	ZIMMessage	The message needs to be revoke.
config	ZIMMessageRevokeConfig	Revoke the configuration of the message.

Details

This method implements the function of message recall. The interface only allows recalling messages within 2 minutes. If you need to recall messages sent earlier, please contact technical support.

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.
Caution：Room message revoke is not supported.
Related callbacks：If the revoked message is the latest message of the session, the [onConversationChanged] callback will be triggered, and if the message is unread, the [onConversationTotalUnreadMessageCountUpdated] callback will be triggered.

Available since：2.5.0 and above.
Restrictions：Login is required to use. To revoke messages from other members within the group, the group owner needs to use version 2.9.0 or above.

updateMessageLocalExtendedData

updateMessageLocalExtendedData(localExtendedData: string, message: ZIMMessage): Promise<ZIMMessageLocalExtendedDataUpdatedResult>

Update the local expandable field of the message.

Parameters

Name	Type	Description
localExtendedData	string	The expandable message field visible only on this end can store additional information locally and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
message	ZIMMessage	Message body to be updated

Details

After the user logs in, calling this interface allows updating the local expandable field of the message.

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

Available since：2.2.0 or above.

editMessage

editMessage(message: ZIMMessage, config: ZIMMessageEditConfig, notification: ZIMMessageSendNotification): Promise<ZIMMessageEditedResult>

Edit message.

Parameters

Name	Type	Description
message	ZIMMessage	The message needs to be edited.
config	ZIMMessageEditConfig	Edit the configuration of the message.
notification	ZIMMessageSendNotification	Message send notification object (optional).

Details

This method can be used to edit messages in single chat, group chat.

Use cases：When you need to edit message to the target user, target group chat after logging in, edit it through this interface.
Related callbacks：[ZIMMessageSendNotification], [ZIMMessageEditedCallback], [onMessageEdited], [onConversationChanged], [onMessageRepliedInfoChanged].
Related APIs：[queryHistoryMessage], [sendMessage].

Available since：2.20.0 and above.

cancelSendingMessage

cancelSendingMessage(message: ZIMMessage, config: ZIMSendingMessageCancelConfig): void

Cancels sending of media message.

Parameters

Name	Type	Description
message	ZIMMessage	The message needs to be cancelled to be sent.
config	ZIMSendingMessageCancelConfig	The configuration of cancelling to be sent message.

Details

This method can be used to cancel the sending of a local media file upload message.

Related APIs：[queryHistoryMessage], [sendMessage].

Available since：2.22.0 and above.

searchLocalMessages

searchLocalMessages(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSearchConfig): Promise<ZIMMessagesSearchedResult>

Search local message list.

Parameters

Name	Type	Description
conversationID	string	The conversation ID of the local message to be search.
conversationType	ZIMConversationType	conversation type.
config	ZIMMessageSearchConfig	Search the configuration of local messages.

Details

This method is used to search local messages.

Use cases：When it is necessary to search for past local messages based on keywords or other conditions, this interface can be called to perform pagination search for local messages.
Related callbacks：[ZIMMessagesSearchedCallback].

Available since：2.9.0 and above.
Restrictions：Effective after login, invalid after logout. Searching is not supported in the room scene (conversationType=1).

searchGlobalLocalMessages

searchGlobalLocalMessages(config: ZIMMessageSearchConfig): Promise<ZIMMessagesGlobalSearchedResult>

Search global local message list.

Parameters

Name	Type	Description
config	ZIMMessageSearchConfig	Search global the configuration of local messages.

Details

This method is used to search global local messages.

Use cases：When there is a need to perform a global search of previous local messages based on keywords or other conditions, you can invoke this interface to search local messages by grouping them according to conversations.
Related callbacks：[ZIMMessagesGlobalSearchedCallback].

Available since：2.9.0 and above.
Restrictions：Effective after login, invalid after logout. Searching global is not supported in the room scene (conversationType=1).

addMessageReaction

addMessageReaction(reactionType: string, message: ZIMMessage, config: ZIMMessageReactionAddConfig): Promise<ZIMMessageReactionAddedResult>

add message reaction

Parameters

Name	Type	Description
reactionType	string	Type of reaction, defined by you, with a maximum length of 32 bytes.
message	ZIMMessage	The message needs reaction.
config	ZIMMessageReactionAddConfig	Added configuration for reactions. It now supports reacting multiple times to the same item and increases the aggregated count accordingly.

Details

Message reaction refers to the user's response to a message. It can generally be used to add or remove emoticons for single chat or group chat messages, as well as to initiate group voting, confirm group results, and other operations.

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.
Caution：Room message reaction is not supported.
Related callbacks：If the addition is successful, the [onMessageReactionsChanged] callback will be triggered. If the reaction is made to the latest message in the conversation, the [onConversationChanged] callback will be triggered when the addition is successful.

Available since：2.28.0 and above.
Restrictions：You can only use it after logging in. And only supports message reactions for single chat and group chat

deleteMessageReaction

deleteMessageReaction(reactionType: string, message: ZIMMessage): Promise<ZIMMessageReactionDeletedResult>

delete message reaction

Parameters

Name	Type	Description
reactionType	string	Reaction type. It must be the type of reaction made by the local user.
message	ZIMMessage	The message needs reaction delete.

Details

Delete the reaction made by the local user.

Use cases：Users need to delete the status of a message that has already been stated, which can be done using this method.
Caution：Room message reaction is not supported.
Related callbacks：If the deletion is successful, the [onMessageReactionsChanged] callback will be triggered. If the reaction is deleted from the latest message in the conversation, the [onConversationChanged] callback will be triggered when the addition is successful.

Available since：2.10.0 and above.
Restrictions：You can only use it after logging in. And only supports message statements for single chat and group chat

deleteMessageAllReactions

deleteMessageAllReactions(message: ZIMMessage): void

Delete all of your reactions under this message

Parameters

Name	Type	Description
message	ZIMMessage	The message needs reaction delete.

Details

Delete all reactions made by the local user.

Use cases：Users need to delete the status of a message that has already been stated, which can be done using this method.
Caution：Room message reaction is not supported.
Related callbacks：If the deletion is successful, the [onMessageReactionsChanged] callback will be triggered. If the reaction is deleted from the latest message in the conversation, the [onConversationChanged] callback will be triggered when the addition is successful.

Available since：2.28.0 and above.
Restrictions：You can only use it after logging in. And only supports message statements for single chat and group chat

queryMessageReactionUserList

queryMessageReactionUserList(message: ZIMMessage, config: ZIMMessageReactionUserQueryConfig): Promise<ZIMMessageReactionUserListQueriedResult>

query message reaction userlist

Parameters

Name	Type	Description
message	ZIMMessage	The message needs querying reaction user list.
config	ZIMMessageReactionUserQueryConfig	reaction user query config.

Details

This method is used to query specific user information under a certain state of a message.

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.
When to call：Call when you need to query reaction user information.

Available since：2.10.0 and above.
Restrictions：You can only use it after logging in. And only supports message statements for single chat and group chat

queryCombineMessageDetail

queryCombineMessageDetail(message: ZIMCombineMessage): Promise<ZIMCombineMessageDetailQueriedResult>

query combine message detail

Parameters

Name	Type	Description
message	ZIMCombineMessage	The combine message needs querying message list.

Details

This method is used to query the sub-messages of the combine message.

Use cases：If you need to obtain the specific sub-messages under the combine message, you can call this API to query.
When to call：Call when you need to query the sub-messages of a combine message.

Available since：2.14.0 and above.
Restrictions：You can only use it after logging in.

replyMessage

replyMessage(message: ZIMMessage, toOriginalMessage: ZIMMessage, config: ZIMMessageSendConfig, notification: ZIMMessageSendNotification): Promise<ZIMMessageSentResult>

send reply message.

Parameters

Name	Type	Description
message	ZIMMessage	The message needs to be sent.
toOriginalMessage	ZIMMessage	The message needs to be replied.
config	ZIMMessageSendConfig	The configuration of the message needs to be sent.
notification	ZIMMessageSendNotification	The notification of the message needs to be sent.

Details

This method can be used to send reply messages in single chat and group chat.

Use cases：When you need to send reply message to the target user and target group chat after logging in, send it through this interface.
When to call：It can be called after login.
Related callbacks：[onPeerMessageReceived], [onGroupMessageReceived].
Related APIs：[queryHistoryMessage], [sendMessage], [sendMediaMessage].

Available since：2.17.0 and above.
Restrictions：The interval between sending messages should be greater than 100ms. Available after login, unavailable after logout.

queryMessageRepliedList

queryMessageRepliedList(message: ZIMMessage, config: ZIMMessageRepliedListQueryConfig): Promise<ZIMMessageRepliedListQueriedResult>

Query message replied list.

Parameters

Name	Type	Description
message	ZIMMessage	The message needs to be queried replied list.
config	ZIMMessageRepliedListQueryConfig	The configuration of the message needs to be queried replied list.

Details

Query the reply message list.

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

Available since：2.17.0 and above.

pinMessage

pinMessage(message: ZIMMessage, isPinned: boolean, config: ZIMMessagePinConfig): void

Pin message.

Parameters

Name	Type	Description
message	ZIMMessage	The message needs to be pinned.
isPinned	boolean	Whether to pin.
config	ZIMMessagePinConfig	Pinning configuration parameters.

Use cases：After logging in, when you need to pin or unpin a successfully sent message for a target user or target group chat, use this API to perform the operation.
Related callbacks：ZIMMessagePinnedCallback, onMessagePinStatusChanged.
Related APIs：queryPinnedMessageList, sendMessage.

queryPinnedMessageList

queryPinnedMessageList(conversationID: string, conversationType: ZIMConversationType): Promise<ZIMPinnedMessageListQueriedResult>

Query pinned message list.

Parameters

Name	Type	Description
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.

Details

This method is used to query the list of pinned messages.

Use cases：When you need to display pinned messages, you can call this interface to query the list of pinned messages within a conversation.
When to call：Called when pinned messages need to be queried.
Related callbacks：[ZIMPinnedMessageListQueriedCallback].

Available since：2.25.0 and above.
Restrictions：The SDK must be logged in and the message pinning feature must be supported to use this interface.

createRoom

createRoom(roomInfo: ZIMRoomInfo, config: ZIMRoomAdvancedConfig): Promise<ZIMRoomCreatedResult>

Create a room with advanced settings

Parameters

Name	Type	Description
roomInfo	ZIMRoomInfo	The configuration information of the room to be created.
config	ZIMRoomAdvancedConfig	The advanced properties of the room to be created.

Details

Users can create and join rooms through this api, other users can join this room through [joinRoom] function.

Use cases：When you need to create a multi-person chat scenario with custom attributes, use this API to create and join a room.
When to call：Can be called after login.
Caution：After all users leave the room, it will be automatically destroyed. A user can be in at most 5 rooms at the same time.
Related callbacks：The result of creating a room can be obtained through the [onRoomCreated] callback.
Related APIs：Use [joinRoom] to join a room, and [leaveRoom] to leave a room.

Available since：1.3.0.
Restrictions：If the room already exists, calling this API will result in an error. Please refer to the returned error code for handling.

joinRoom

joinRoom(roomID: string): Promise<ZIMRoomJoinedResult>

Join a room.

Parameters

Name	Type	Description
roomID	string	ID of the room to join.

Details

If the room does not exist, the join fails and you need to call [createRoom] to create the room first.

Use cases：In a multi-person chat scenario, users can call this interface to enter the room when they need to join the room.
When to call：It can be called after creating a ZIM instance through [create].
Caution：When everyone leaves the room, the room will be automatically destroyed.
Related callbacks：The result of joining the room can be obtained through the [ZIMRoomJoinedCallback] callback.
Related APIs：You can create a room with [createRoom] and leave the room with [leaveRoom].

Available since：1.1.0 or above.

enterRoom

enterRoom(roomInfo: ZIMRoomInfo, config: ZIMRoomAdvancedConfig): Promise<ZIMRoomEnteredResult>

Enter the room. If the room does not exist, it will be created automatically.

Parameters

Name	Type	Description
roomInfo	ZIMRoomInfo	Configuration information for the room that will be created. Only the first user who enters the room creates roomName and takes effect.
config	ZIMRoomAdvancedConfig	Advanced properties of the room that will be created. Only the first user who enters the room is configured to take effect.

Details

After calling this API, If the room already exists, join the room directly; if the room does not exist, create a room and join. At the same time, if the room does not exist, after calling this interface, the room advanced properties set by the user will take effect.

Use cases：When you need to enter a multi-person chat scene with custom attributes, and you do not need to distinguish whether the room is created or added, you can enter a room through this interface.
When to call：It can be called after logging in.
Caution：When everyone leaves the room, the room will be automatically destroyed, and a user can be in a maximum of 5 rooms at the same time. [enterRoom] is equivalent to [createRoom] and [joinRoom], so you only need to choose one of the APIs.
Related callbacks：The result of entering the room can be obtained through the [ZIMRoomEnteredCallback] callback.
Related APIs：You can enter the room through [enterRoom], and leave the room through [leaveRoom].

Available since：2.1.0.

switchRoom

switchRoom(fromRoomID: string, toRoomInfo: ZIMRoomInfo, isCreateWhenRoomNotExisted: boolean, config: ZIMRoomAdvancedConfig): Promise<ZIMRoomSwitchedResult>

Switch from one room to another. If the room does not exist, it will decide whether to create the corresponding room based on the passed parameters.

Parameters

Name	Type	Description
fromRoomID	string	ID of the source room to switch.
toRoomInfo	ZIMRoomInfo	Configuration information for the room to switch to.
isCreateWhenRoomNotExisted	boolean	Whether to create the room if it does not exist.
config	ZIMRoomAdvancedConfig	Advanced properties for the room to switch to.

Details

Use cases：Scenarios that require quick switching from one room to another.
When to call：It can be called after logging in.
Related callbacks：The result of switching the room can be obtained through the [ZIMRoomSwitchedCallback] callback.

Available since：2.18.0.

leaveRoom

leaveRoom(roomID: string): Promise<ZIMRoomLeftResult>

Leave a room.

Parameters

Name	Type	Description
roomID	string	ID of the room to leave.

Details

When the user in the room needs to leave the room, use [leaveRoom] to leave the room. If the room does not exist, the leave fails.

Use cases：In the multi-person chat scenario, when users in the room need to leave the room, they can leave the room through this interface.
When to call：After creating a ZIM instance via [create], it can be called when the user is in the room.
Caution：If the current user is not in this room, the exit fails. When everyone leaves the room, the room will be automatically destroyed.
Related callbacks：The result of leaving the room can be obtained through the [ZIMRoomLeftCallback] callback.
Related APIs：You can create a room through [createRoom] and join a room with [joinRoom].

Available since：1.1.0 or above.

leaveAllRoom

leaveAllRoom(): Promise<ZIMRoomAllLeftResult>

Leave all rooms entered.

Call this interface to exit all rooms you have entered at once.

When to call：After creating a ZIM instance via [create], it can be called when the user is in the room.
Caution：If the current user is not in this room, leaving will fail; and calling this interface can only leave the room entered under the current terminal, and will not affect the rooms entered by other terminals with multi-terminal login.
Related callbacks：The result of leaving the room can be obtained through the [ZIMRoomAllLeftCallback] callback.

Available since：2.15.0 or above.

queryRoomMemberList

queryRoomMemberList(roomID: string, config: ZIMRoomMemberQueryConfig): Promise<ZIMRoomMemberQueriedResult>

Query the list of members in the room.

Parameters

Name	Type	Description
roomID	string	ID of the room to query.
config	ZIMRoomMemberQueryConfig	Configuration of query room member operation.

Details

After joining a room, you can use this function to get the list of members in the room.

Use cases：When a developer needs to obtain a list of room members for other business operations, this interface can be called to obtain a list of members.
When to call：After creating a ZIM instance through [create], and the user is in the room that needs to be queried, you can call this interface.
Caution：To use this feature, please contact ZEGOCLOUD technical support. If the user is not currently in this room, the query fails. When there are more than 500 room members, the result of querying the list of room members can only contain the information of a maximum of 500 members.
Related callbacks：Through the [ZIMRoomMemberQueriedCallback] callback, you can get the result of querying the room member list.
Related APIs：You can check the online number of people in the room through [queryRoomOnlineMemberCount].

Available since：1.1.0 or above.

queryRoomMembers

queryRoomMembers(userIDs: string[], roomID: string): Promise<ZIMRoomMembersQueriedResult>

Query the information of the specified userID in the specified room.

Parameters

Name	Type	Description
userIDs	string[]	List of user IDs to query.
roomID	string	The room ID of the specified room.

Details

This method can query the information of up to ten users in the specified room of the logged-in user.

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：Can be invoked after login.

Available since：2.8.0 and above.
Restrictions：Available after login, unavailable after logout, up to ten users can be queried at one time.

queryRoomOnlineMemberCount

queryRoomOnlineMemberCount(roomID: string): Promise<ZIMRoomOnlineMemberCountQueriedResult>

Query the number of online members in the room.

Parameters

Name	Type	Description
roomID	string	ID of the room to query.

Details

After joining a room, you can use this function to get the number of online members in the room.

Use cases：When a developer needs to obtain the number of room members who are online, this interface can be called.
When to call：After creating a ZIM instance through [create], and the user is in the room that needs to be queried, this interface can be called.
Caution：If the user is not currently in this room, the query will fail.
Related callbacks：The result of querying the online number of room members can be obtained through the [ZIMRoomOnlineMemberCountQueriedCallback] callback.
Related APIs：the room member can be inquired through [queryRoomMemberList].

Available since：1.1.0 or above.

setRoomAttributes

setRoomAttributes(roomAttributes: Map<string, string>, roomID: string, config: ZIMRoomAttributesSetConfig): Promise<ZIMRoomAttributesOperatedResult>

Set room attributes (use this for all additions and changes).

Parameters

Name	Type	Description
roomAttributes	Map<string, string>	Room attributes to be set.
roomID	string	To modify the room number of the room attribute.
config	ZIMRoomAttributesSetConfig	Behavior configuration of the operation.

Details

Used to set room properties.

Use cases：This interface is used when you need to set the mic bit in a chat room.
When to call：after login, and in the relevant room to call.
Caution：Key-value of the room property. The default key length is 16 and the default value length is 1024.
Default value：[ZIMRoomAttributesSetConfig] the space-time of the default configuration is optional, and do not update the owner, and involves the room properties in the owner is not automatically deleted after exit.
Privacy statement：Try not to introduce sensitive information related to personal privacy into the property of the room, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Related callbacks：[ZIMRoomAttributesOperatedCallback].
Related APIs：[deleteRoomAttributes] to delete room attributes. [queryRoomAllAttributes], queries the room attributes.

Available since：1.3.0.
Restrictions：You can set a maximum of 20 properties per room.

deleteRoomAttributes

deleteRoomAttributes(keys: string[], roomID: string, config: ZIMRoomAttributesDeleteConfig): Promise<ZIMRoomAttributesOperatedResult>

Delete room attributes.

Parameters

Name	Type	Description
keys	string[]	The key of the room attribute to be deleted.
roomID	string	To modify the room number of the room attribute
config	ZIMRoomAttributesDeleteConfig	Behavior configuration of the operation.

Details

Used to delete room attributes.

Use cases：This interface can be used when a voice chat room needs to delete a seat.
When to call：After login and while in the relevant room.
Default value：The default configuration when [ZIMRoomAttributesDeleteConfig] is empty is non-forced operation.
Scope of impact：Deletes the room attributes of the existing room.
Related callbacks：[ZIMRoomAttributesOperatedCallback].
Related APIs：[setRoomAttributes] to set room attributes. [queryRoomAllAttributes] to query room attributes.

Available since：1.3.0.

beginRoomAttributesBatchOperation

beginRoomAttributesBatchOperation(roomID: string, config: ZIMRoomAttributesBatchOperationConfig): void

Open combination room attribute operation.

Parameters

Name	Type	Description
roomID	string	The number of the room where the combined operation needs to be turned on.
config	ZIMRoomAttributesBatchOperationConfig	The configuration of the combined operation.

Details

Used to turn on the combination of room attributes.

Use cases：When a voice chat room needs to switch seats, this interface can be used to initiate a batch operation.
When to call：After login and while in the relevant room.
Caution：After starting batch operations on room attributes, all set and delete operations will be included in the batch until the batch operation is complete. Consecutive calls reset the state. Not calling [endRoomAttributesBatchOperation] is treated as no operation.
Scope of impact：After being enabled, set and delete room attribute operations will be included in this batch operation.
Related APIs：[endRoomAttributesBatchOperation] to complete the batch operation.

Available since：1.3.0.

endRoomAttributesBatchOperation

endRoomAttributesBatchOperation(roomID: string): Promise<ZIMRoomAttributesBatchOperatedResult>

Complete the property operation of the combined room.

Parameters

Name	Type	Description
roomID	string	To modify the room number of the room attribute.

Details

After completing the operation of combining room attributes, all the setting/deleting operations from the last call to beginRoomAttributesBatchOperation to this operation will be completed for the room.

Use cases：This interface can be used when a voice chat room needs to switch seats.
When to call：After login, execute after [beginRoomAttributesBatchOperation].
Caution：Calling without [beginRoomAttributesBatchOperation] will return an error. Not calling [endRoomAttributesBatchOperation] after [beginRoomAttributesBatchOperation] is treated as no operation.
Scope of impact：Set and delete room attributes within the same room.
Related callbacks：[ZIMRoomAttributesBatchOperatedCallback].
Related APIs：[beginRoomAttributesBatchOperation] to start the batch operation.

Available since：1.3.0.
Restrictions：Requires that batch operations have been started in the room.

queryRoomAllAttributes

queryRoomAllAttributes(roomID: string): Promise<ZIMRoomAttributesQueriedResult>

Query all properties of the room.

Parameters

Name	Type	Description
roomID	string	Need to query the room number of the custom attributes.

Details

Used to query room attributes.

When to call：After login and while in the relevant room.
Use cases：This interface can be used when a voice chat room needs to query seat information.
Related callbacks：[ZIMRoomAttributesQueriedCallback].
Related APIs：[deleteRoomAttributes] to delete room attributes. [setRoomAttributes] to set room attributes.

Available since：1.3.0.

setRoomMembersAttributes

setRoomMembersAttributes(attributes: Map<string, string>, userIDs: string[], roomID: string, config: ZIMRoomMemberAttributesSetConfig): Promise<ZIMRoomMembersAttributesOperatedResult>

Set room member attributes (use this for all additions and changes).

Parameters

Name	Type	Description
attributes	Map<string, string>	Room member attributes to be set.
userIDs	string[]	A list of userIDs to set.
roomID	string	Room ID.
config	ZIMRoomMemberAttributesSetConfig	Behavior configuration of the operation.

Details

Call this API to set room user properties of members in the room.

Use cases：If you need to set a level for members in the room, you can use this interface to set a state.
Default value：[ZIMRoomMemberAttributesSetConfig] Default constructor isDeleteAfterOwnerLeft is true.
When to call：After logging in and calling in the relevant room.
Related callbacks：[ZIMRoomMembersAttributesOperatedCallback],[onRoomMemberAttributesUpdated].
Related APIs：[queryRoomMembersAttributes], [queryRoomMemberAttributesList].

Available since：2.4.0 and above.
Restrictions：A maximum of 500 user attributes can be set in each room and stored in the key-value mode. If you need to increase the attribute limit, please contact ZEGO technical support. The total length of user attribute key-values owned by each user in a room cannot exceed 144 bytes, and the number of key-values cannot exceed 30 pairs. The length of a single key-value cannot exceed 8 bytes for a Key and 64 bytes for a Value. If you need to raise the cap, please contact ZEGO technical support. After the room is destroyed, the user-defined user properties are also destroyed.

queryRoomMembersAttributes

queryRoomMembersAttributes(userIDs: string[], roomID: string): Promise<ZIMRoomMembersAttributesQueriedResult>

Batch query the room user attributes of the members in the room.

Parameters

Name	Type	Description
userIDs	string[]	A list of userIDs to query.
roomID	string	Room ID.

Details

Call this API to batch query the room user attributes of the members in the room.

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

Available since：2.4.0 or later.
Restrictions：The maximum call frequency is 5 times within 30 seconds by default, and the maximum query time is 100 people.

queryRoomMemberAttributesList

queryRoomMemberAttributesList(roomID: string, config: ZIMRoomMemberAttributesQueryConfig): Promise<ZIMRoomMemberAttributesListQueriedResult>

paginate the room user properties that have room property members in the room.

Parameters

Name	Type	Description
roomID	string	Room ID.
config	ZIMRoomMemberAttributesQueryConfig	Behavior configuration of the operation.

Details

paginate the room user properties that have room property members in the room.

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

Available since：2.4.0 or later.
Restrictions：The maximum call frequency is 5 times within 30 seconds by default, and the maximum query time is 100 people.

createGroup

createGroup(groupInfo: ZIMGroupInfo, userIDs: string[], config: ZIMGroupAdvancedConfig): Promise<ZIMGroupCreatedResult>

Create a group with the andvanced info such as group attributes and group notice.

Parameters

Name	Type	Description
groupInfo	ZIMGroupInfo	Configuration information for the group to be created.
userIDs	string[]	List of users invited to the group.
config	ZIMGroupAdvancedConfig	Create the relevant configuration of the group.

Details

You can call this interface to create a group, and the person who calls this interface is the group leader.

Use cases：You can use this interface to create a chat scenario and join a group.
When to call：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.

Available since：2.0.0 and above.

dismissGroup

dismissGroup(groupID: string): Promise<ZIMGroupDismissedResult>

Dismiss the group.

Parameters

Name	Type	Description
groupID	string	The ID of the group to be dismissed.

Details

When a group is created, you can use [dismissGroup] to dismiss it.

Use cases：After you create a chat group, you do not need to use this interface to dissolve the group.
When to call：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.

Available since：2.0.0 and above.

joinGroup

joinGroup(groupID: string): Promise<ZIMGroupJoinedResult>

Join a group.

Parameters

Name	Type	Description
groupID	string	The group ID to join.

Details

After a group is created, other users can use [joinGroup] to join the group.

Use cases：This interface is used to join a group in a chat scenario.
When to call：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. A group is limited to 500 people and fails to join when it is full.
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.

Available since：2.0.0 and above.

leaveGroup

leaveGroup(groupID: string): Promise<ZIMGroupLeftResult>

Leave the group.

Parameters

Name	Type	Description
groupID	string	The group ID to leave.

Details

After a user joins a group, the user can leave the group through this interface.

Use cases：This interface is used to exit a chat group.
When to call：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.
Scope of impact：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.

Available since：2.0.0 and above.
Restrictions：Available after login, unavailable after logout.

inviteUsersIntoGroup

inviteUsersIntoGroup(userIDs: string[], groupID: string): Promise<ZIMGroupUsersInvitedResult>

invite some members into the group.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to invite into the group.
groupID	string	The target group ID.

Details

After a group is created, users can add multiple users to the group through this interface. The interface can be invoked by both the master and members of the group.

Use cases：This interface allows you to invite others to join a group chat.
When to call：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. The service layer determines the number of invited users.
Related callbacks：Through the callback [ZIMGroupUsersInvitedCallback] can add multiple users into the group's results.
Related APIs：KickGroupMember can be used to kick a target user out of the group.

Available since：2.0.0 and above.
Restrictions：The maximum number of userIDs users can join the group is 100. If the number of users reaches 100, the interface callback will notify the user. The maximum number of people in a group is 500.

kickGroupMembers

kickGroupMembers(userIDs: string[], groupID: string): Promise<ZIMGroupMemberKickedResult>

kick some members out of the group.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to kick out of the group.
groupID	string	The target group ID.

Details

After a user joins a group, you can use this method to remove the user from the group.

Use cases：You can use this method to remove one or more users from the group.
When to call：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].

Available since：2.0.0 and above.
Restrictions：You can't kick someone unless you're the leader of the group.

transferGroupOwner

transferGroupOwner(toUserID: string, groupID: string): Promise<ZIMGroupOwnerTransferredResult>

Transfer the group owner.

Parameters

Name	Type	Description
toUserID	string	The user ID of the new group owner.
groupID	string	The target group ID.

Details

After a group is created, the group owner can use this method to assign the group owner to a specified user.

Use cases：In a group chat scenario, you can transfer the group master through this interface.
When to call：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.

Available since：2.0.0 and above.
Restrictions：You cannot transfer a group owner if you are not a group owner.

queryGroupInfo

queryGroupInfo(groupID: string): Promise<ZIMGroupInfoQueriedResult>

Query group information.

Parameters

Name	Type	Description
groupID	string	The group ID of the group information to be queried.

Details

Query information about a created group.

Use cases：You need to obtain group information for display.
When to call：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.

Available since：2.0.0 and above.
Restrictions：Available after login, unavailable after logout.

queryGroupMemberInfo

queryGroupMemberInfo(userID: string, groupID: string): Promise<ZIMGroupMemberInfoQueriedResult>

Query group member information.

Parameters

Name	Type	Description
userID	string	User ID of the queried member information.
groupID	string	The ID of the group whose member information will be queried.

Details

After a group is created, you can use this method to query information about a specified group member.

Use cases：You need to obtain the specified group member information for display or interaction.
When to call：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.

Available since：2.0.0 and above.
Restrictions：Available after login, unavailable after logout.

queryGroupList

queryGroupList(count: number, config: ZIMGroupListQueryConfig): Promise<ZIMGroupListQueriedResult>

Query the group list.

Parameters

Name	Type	Description
count	number	The number of groups to query.
config	ZIMGroupListQueryConfig	Group list query configuration.

Details

Query the list of all groups.

Use cases：You need to get a list of groups to display.
When to call：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.

Available since：2.27.0 and above.
Restrictions：Available after login, unavailable after logout.

queryGroupMemberList

queryGroupMemberList(groupID: string, config: ZIMGroupMemberQueryConfig): Promise<ZIMGroupMemberListQueriedResult>

Query the list of group members.

Parameters

Name	Type	Description
groupID	string	The group ID of the group member list to be queried.
config	ZIMGroupMemberQueryConfig	Group member query configuration.

Details

After a group is created, you can use this method to query the group member list.

Use cases：You need to obtain the specified group 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 the callback [ZIMGroupMemberListQueriedCallback] can query the result of the group member list.

Available since：2.0.0 and above.
Restrictions：Available after login, unavailable after logout.

queryGroupMemberCount

queryGroupMemberCount(groupID: string): Promise<ZIMGroupMemberCountQueriedResult>

Query the number of group members in a specified group.

Parameters

Name	Type	Description
groupID	string	The group ID of the group to be queried.

Details

Query the number of group members in a group.

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

Available since：2.2.0 or above.
Restrictions：This function can only query the group that the user has entered.

updateGroupName

updateGroupName(groupName: string, groupID: string): Promise<ZIMGroupNameUpdatedResult>

Update the group name.

Parameters

Name	Type	Description
groupName	string	The new group name.
groupID	string	The target group ID.

Details

After a group is created, users can call this method to change the group name.

Use cases：After creating a group, you need to change the group name.
When to call：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.

Available since：2.0.0 and above.
Restrictions：Group members and group owners can change the group name. The maximum length of the name is 100 bytes.

updateGroupAvatarUrl

updateGroupAvatarUrl(groupAvatarUrl: string, groupID: string): Promise<ZIMGroupAvatarUrlUpdatedResult>

Update the group avatar URL.

Parameters

Name	Type	Description
groupAvatarUrl	string	The new group avatar URL.
groupID	string	The target group ID.

Details

After a group is created, the user can modify the group avatar URL by calling this method.

Use cases：After creating a group, the user needs to change the group avatar URL.
When to call：It can be invoked after creating a ZIM instance through [create] and logging in.
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.

Available since：2.3.0 and above.
Restrictions：Group members and group owners can modify the group avatar, with a maximum length of 500 bytes.

updateGroupNotice

updateGroupNotice(groupNotice: string, groupID: string): Promise<ZIMGroupNoticeUpdatedResult>

Update group announcements.

Parameters

Name	Type	Description
groupNotice	string	The new group notice content.
groupID	string	The target group ID.

Details

When a group is created, users can use this method to update the group bulletin.

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

Available since：2.0.0 and above.
Restrictions：Only group members can update the group bulletin. The maximum number of bytes is 300. There is no special character limit.

updateGroupAlias

updateGroupAlias(groupAlias: string, groupID: string): Promise<ZIMGroupAliasUpdatedResult>

Update the group alias.

Parameters

Name	Type	Description
groupAlias	string	The new group alias.
groupID	string	The target group ID.

Details

After a group is created, users can call this method to change the group alias.

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 [ZIMGroupAliasUpdatedCallback] can get the result of the change of group alias.

Available since：2.18.0 and above.

updateGroupJoinMode

updateGroupJoinMode(mode: ZIMGroupJoinMode, groupID: string): Promise<ZIMGroupJoinModeUpdatedResult>

Update group verification mode.

Parameters

Name	Type	Description
mode	ZIMGroupJoinMode	The group join mode.
groupID	string	The target group ID.

Details

When a group is created, the group owner and administrators can use this method to update the group verification mode.

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

Available since：2.15.0 and above.

updateGroupInviteMode

updateGroupInviteMode(mode: ZIMGroupInviteMode, groupID: string): Promise<ZIMGroupInviteModeUpdatedResult>

Update group verification mode.

Parameters

Name	Type	Description
mode	ZIMGroupInviteMode	The group invite mode.
groupID	string	The target group ID.

Details

When a group is created, the group owner and administrators can use this method to update the group verification mode.

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

Available since：2.15.0 and above.

updateGroupBeInviteMode

updateGroupBeInviteMode(mode: ZIMGroupBeInviteMode, groupID: string): Promise<ZIMGroupBeInviteModeUpdatedResult>

Update group verification mode.

Parameters

Name	Type	Description
mode	ZIMGroupBeInviteMode	The group be-invite mode.
groupID	string	The target group ID.

Details

After a group is created, the group owner and administrators can update the invited group verification mode through this method.

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

Available since：2.15.0 and above.

setGroupAttributes

setGroupAttributes(groupAttributes: Map<string, string>, groupID: string): Promise<ZIMGroupAttributesOperatedResult>

Add or update group attributes.

Parameters

Name	Type	Description
groupAttributes	Map<string, string>	The group attributes to set, in key-value pairs.
groupID	string	The target group ID.

Details

If a group already exists, all users of the group can use this method to set group attributes.

Use cases：Added extended field information about group description, such as group family, label, and industry category.
When to call：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, [queryGroupAllAttributes] can be used to queryAllGroupAttributes.

Available since：2.0.0 and above.
Restrictions：Only group members can set group attributes.

deleteGroupAttributes

deleteGroupAttributes(keys: string[], groupID: string): Promise<ZIMGroupAttributesOperatedResult>

Delete group attributes.

Parameters

Name	Type	Description
keys	string[]	The list of group attribute keys to delete.
groupID	string	The target group ID.

Details

When a group already exists, you can use this method to delete group attributes. Both the master and members of the interface group can be invoked.

Use cases：Deleted the extended field of the group description.
When to call：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.

Available since：2.0.0 and above.
Restrictions：Only group members can delete group attributes.

queryGroupAttributes

queryGroupAttributes(keys: string[], groupID: string): Promise<ZIMGroupAttributesQueriedResult>

Query group attributes by keys.

Parameters

Name	Type	Description
keys	string[]	The list of group attribute keys to query.
groupID	string	The target group ID.

Details

After a group is created, you can use this method to query the specified group attributes.

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

Available since：2.0.0 and above.
Restrictions：Available after login, unavailable after logout.

queryGroupAllAttributes

queryGroupAllAttributes(groupID: string): Promise<ZIMGroupAttributesQueriedResult>

Query all attributes of the group.

Parameters

Name	Type	Description
groupID	string	The target group ID.

Details

After a group is created, you can use this method to query all group attributes.

Use cases：Scenarios where all group attributes need to be queried.
When to call：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.

Available since：2.0.0 and above.

setGroupMemberRole

setGroupMemberRole(role: number, forUserID: string, groupID: string): Promise<ZIMGroupMemberRoleUpdatedResult>

Set the group member role.

Parameters

Name	Type	Description
role	number	The role value to set for the group member.
forUserID	string	The user ID of the target group member.
groupID	string	The target group ID.

Details

After a group is created, you can use this method to set the roles of group members.

Use cases：The ZIM instance can be invoked after being created by [create] and logged in.
When to call：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.

Available since：2.0.0 and above.
Restrictions：Non-group master unavailable.

setGroupMemberNickname

setGroupMemberNickname(nickname: string, forUserID: string, groupID: string): Promise<ZIMGroupMemberNicknameUpdatedResult>

Set the group member nickname.

Parameters

Name	Type	Description
nickname	string	The new group member nickname.
forUserID	string	The user ID of the target group member.
groupID	string	The target group ID.

Details

After a group is created, you can use this method to set nicknames for group members.

Use cases：Nicknames need to be set for group members.
When to call：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.

Available since：2.0.0 and above.
Restrictions：Available after login, unavailable after logout. The owner of a group can change his or her own nickname, while the members can change only their own nickname.

muteGroup

muteGroup(isMute: boolean, groupID: string, config: ZIMGroupMuteConfig): Promise<ZIMGroupMutedResult>

Mute a group.

Parameters

Name	Type	Description
isMute	boolean	Whether to mute. [true] means mute, [false] means unmute.
groupID	string	The target group ID.
config	ZIMGroupMuteConfig	Group mute configuration.

Details

Once a group is created, the group administrator can call this interface to implement group muting and unmuting.

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 [ZIMGroupMutedCallback] callback. The updated group mute status information can be obtained through [onGroupMutedInfoUpdated].

Available since：2.14.0 and above.
Restrictions：This can be called by the group owner and group administrators.

muteGroupMembers

muteGroupMembers(isMute: boolean, userIDs: string[], groupID: string, config: ZIMGroupMemberMuteConfig): Promise<ZIMGroupMembersMutedResult>

Mute group members.

Parameters

Name	Type	Description
isMute	boolean	Whether to mute. [true] means mute, [false] means unmute.
userIDs	string[]	The list of user IDs to mute/unmute.
groupID	string	The target group ID.
config	ZIMGroupMemberMuteConfig	Group member mute configuration.

Details

Once a group is created, the group administrator can call this interface to implement group members muting and unmuting.

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 [ZIMGroupMembersMutedCallback] callback. The updated group members mute status information can be obtained through [onGroupMemberInfoUpdated].

Available since：2.14.0 and above.
Restrictions：This can be called by the group owner and group administrators.

queryGroupMemberMutedList

queryGroupMemberMutedList(groupID: string, config: ZIMGroupMemberQueryConfig): Promise<ZIMGroupMemberMutedListQueriedResult>

Query the list of group muted members.

Parameters

Name	Type	Description
groupID	string	The target group ID.
config	ZIMGroupMemberQueryConfig	Group muted member list query configuration.

Details

After a group is created, you can use this method to query the group muted 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 the callback [ZIMGroupMembersMutedCallback] can query the result of the group muted member list.

Available since：2.14.0 and above.
Restrictions：Available after login, unavailable after logout.

queryGroupMessageReceiptReadMemberList

deprecated

queryGroupMessageReceiptReadMemberList(message: ZIMMessage, groupID: string, config: ZIMGroupMessageReceiptMemberQueryConfig): Promise<ZIMGroupMessageReceiptMemberListQueriedResult>

Query the list of group message read members.

Parameters

Name	Type	Description
message	ZIMMessage	The group message to query the read member list of.
groupID	string	The target group ID.
config	ZIMGroupMessageReceiptMemberQueryConfig	Group message receipt member query configuration.

Details

This method can query the specific read member list of a message sent by a group.

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

Available since：2.5.0 and above.
Restrictions：only supports querying the messages sent by the local end, and the receipt status of the messages is not NONE and UNKNOWN. If the user is not in the group, or has been kicked out of the group, the corresponding member list cannot be found.

Deprecated

This API was deprecated in 3.1.0. Please use [queryGroupMessageReceiptMemberList] instead.

queryGroupMessageReceiptUnreadMemberList

deprecated

queryGroupMessageReceiptUnreadMemberList(message: ZIMMessage, groupID: string, config: ZIMGroupMessageReceiptMemberQueryConfig): Promise<ZIMGroupMessageReceiptMemberListQueriedResult>

Query the list of group message unread members.

Parameters

Name	Type	Description
message	ZIMMessage	The group message to query the unread member list of.
groupID	string	The target group ID.
config	ZIMGroupMessageReceiptMemberQueryConfig	Group message receipt member query configuration.

Details

This method can query the specific unread member list of a message sent by a group.

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

Available since：2.5.0 and above.
Restrictions：only supports querying the messages sent by the local end, and the receipt status of the messages is not NONE. If the user is not in the group, or has been kicked out of the group, the corresponding member list cannot be found.

Deprecated

This API was deprecated in 3.1.0. Please use [queryGroupMessageReceiptMemberList] instead.

queryGroupMessageReceiptMemberList

queryGroupMessageReceiptMemberList(message: ZIMMessage, groupID: string, count: number, config: ZIMGroupMessageReceiptMemberListQueryConfig): Promise<ZIMGroupMessageReceiptMemberListQueriedResult>

Query the receipt member list of a group message.

Parameters

Name	Type	Description
message	ZIMMessage	The group message to query the receipt member list of.
groupID	string	The target group ID.
count	number	The number of members to query per page, up to 100.
config	ZIMGroupMessageReceiptMemberListQueryConfig	Query configuration for the group message receipt member list.

Details

This method can query the specific unread member list, read member list, or delivered member list of a message sent by yourself in a group.

Use cases：Developers can use this method to query and display the specific receipt member lists of a message they sent, enabling the UI to separately show the unread, read, and delivered member lists for that message.
Caution：If you only need to query the receipt status of a message or just the read/unread count, use [queryMessageReceiptsInfo] instead.

Available since：3.1.0 and above.
Restrictions：Only supports querying messages sent by the local end, and the receipt status of the messages must not be NONE. If the user is not in the group, or has been kicked out of the group, the corresponding member list cannot be found.

searchLocalGroups

searchLocalGroups(config: ZIMGroupSearchConfig): Promise<ZIMGroupsSearchedResult>

Search local groups.

Parameters

Name	Type	Description
config	ZIMGroupSearchConfig	Configuration for searching groups.

Details

This method is used to search for local groups.

Use cases：When you need to search for local groups by keywords or other criteria, you can call this interface to search.
When to call：After calling [login]
Related callbacks：[ZIMGroupsSearchedCallback].

Available since：2.9.0 and above.
Restrictions：Takes effect after login, becomes invalid after logout.

searchLocalGroupMembers

searchLocalGroupMembers(groupID: string, config: ZIMGroupMemberSearchConfig): Promise<ZIMGroupMembersSearchedResult>

Search local group members.

Parameters

Name	Type	Description
groupID	string	Group ID of the joined group.
config	ZIMGroupMemberSearchConfig	The configuration for searching group members.

Details

This method is used to search for group members.

Use cases：When you need to search for local group members by keywords or other criteria, you can call this interface to search.
Related callbacks：[ZIMGroupMembersSearchedCallback].

Available since：2.9.0 and above.
Restrictions：Takes effect after login, becomes invalid after logout.

sendGroupJoinApplication

sendGroupJoinApplication(groupID: string, config: ZIMGroupJoinApplicationSendConfig): Promise<ZIMGroupJoinApplicationSentResult>

Send an application to join the group.

Parameters

Name	Type	Description
groupID	string	The group ID to apply to join.
config	ZIMGroupJoinApplicationSendConfig	Group join application configuration.

Details

When a group's joinMode is Auth, users can apply to join the group through this method.

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

Available since：2.15.0 and above.

acceptGroupJoinApplication

acceptGroupJoinApplication(userID: string, groupID: string, config: ZIMGroupJoinApplicationAcceptConfig): Promise<ZIMGroupJoinApplicationAcceptedResult>

Accept an application to join the group.

Parameters

Name	Type	Description
userID	string	The user ID of the applicant.
groupID	string	The target group ID.
config	ZIMGroupJoinApplicationAcceptConfig	Configuration for accepting the group join application.

Details

When a group's joinMode requires Auth, after an external user sends a group application, the group owner or administrator can agree to the application through this method.

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

Available since：2.15.0 and above.

rejectGroupJoinApplication

rejectGroupJoinApplication(userID: string, groupID: string, config: ZIMGroupJoinApplicationRejectConfig): Promise<ZIMGroupJoinApplicationRejectedResult>

Reject an application to join the group.

Parameters

Name	Type	Description
userID	string	The user ID of the applicant.
groupID	string	The target group ID.
config	ZIMGroupJoinApplicationRejectConfig	Configuration for rejecting the group join application.

Details

When a group's joinMode is Auth, the group owner or administrator can reject to the user's application to join the group through this method.

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

Available since：2.15.0 and above.

sendGroupInviteApplications

sendGroupInviteApplications(userIDs: string[], groupID: string, config: ZIMGroupInviteApplicationSendConfig): Promise<ZIMGroupInviteApplicationsSentResult>

Send an application to invite the group.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to invite.
groupID	string	The target group ID.
config	ZIMGroupInviteApplicationSendConfig	Group invite application configuration.

Details

When a group's invitation verification mode requires approval by the invitee, group members can send invitations to the group through this method.

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

Available since：2.15.0 and above.

acceptGroupInviteApplication

acceptGroupInviteApplication(inviterUserID: string, groupID: string, config: ZIMGroupInviteApplicationAcceptConfig): Promise<ZIMGroupInviteApplicationAcceptedResult>

Accept an application to invite to the group.

Parameters

Name	Type	Description
inviterUserID	string	The user ID of the inviter.
groupID	string	The target group ID.
config	ZIMGroupInviteApplicationAcceptConfig	Configuration for accepting the group invite application.

Details

When a group's beInviteMode mode is Auth, users outside the group can accept the invitation through this method and become group members after receiving the group invitation.

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

Available since：2.15.0 and above.

rejectGroupInviteApplication

rejectGroupInviteApplication(inviterUserID: string, groupID: string, config: ZIMGroupInviteApplicationRejectConfig): Promise<ZIMGroupInviteApplicationRejectedResult>

Reject an application to invite to the group.

Parameters

Name	Type	Description
inviterUserID	string	The user ID of the inviter.
groupID	string	The target group ID.
config	ZIMGroupInviteApplicationRejectConfig	Configuration for rejecting the group invite application.

Details

When a group's beInviteMode requires Auth, users invited to the group can reject the invitation through this method.

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

Available since：2.15.0 and above.

queryGroupApplicationList

queryGroupApplicationList(config: ZIMGroupApplicationListQueryConfig): Promise<ZIMGroupApplicationListQueriedResult>

Query the group application list.

Parameters

Name	Type	Description
config	ZIMGroupApplicationListQueryConfig	Group application list query configuration.

Details

The query results include your own application to join the group and your application to be invited to join the group. When the user is a group owner or administrator, the query results will also include other people's applications to join the group and their own applications to invite others to the group.

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

Available since：2.15.0 and above.

callInvite

callInvite(invitees: string[], config: ZIMCallInviteConfig): Promise<ZIMCallInvitationSentResult>

Initiate a call invitation.

Parameters

Name	Type	Description
invitees	string[]	The list of invitee user IDs.
config	ZIMCallInviteConfig	Call invitation configuration.

Details

When the caller initiates a call invitation, the called party can use [callAccept] to accept the call invitation or [callReject] to reject the invitation.

Use cases：When you need to initiate a call invitation, you can create a unique callid through this interface to maintain this call invitation.
When to call：It can be called after creating a ZIM instance through [create].
Caution：The call invitation has a timeout period, and the call invitation will end when the timeout period expires.
Related callbacks：[ZIMCallInvitationSentCallback].

Available since：2.0.0 and above.

callCancel

callCancel(invitees: string[], callID: string, config: ZIMCallCancelConfig): Promise<ZIMCallCancelSentResult>

Cancel the call invitation.

Parameters

Name	Type	Description
invitees	string[]	The list of invitee user IDs to cancel the invitation for.
callID	string	The call invitation ID to cancel.
config	ZIMCallCancelConfig	Call cancel configuration.

Details

After the caller initiates a call invitation, the call invitation can be canceled through this interface before the timeout period.

Use cases：When you need to cancel the call invitation initiated before, you can cancel the call invitation through this interface.
When to call：It can be called after creating a ZIM instance through [create].
Caution：Canceling the call invitation after the timeout period of the call invitation expires will fail.
Related callbacks：[ZIMCallCancelSentCallback].

Available since：2.0.0 and above.

callAccept

callAccept(callID: string, config: ZIMCallAcceptConfig): Promise<ZIMCallAcceptanceSentResult>

Accept the call invitation.

Parameters

Name	Type	Description
callID	string	The call invitation ID to accept.
config	ZIMCallAcceptConfig	Call accept configuration.

Details

When the calling party initiates a call invitation, the called party can accept the call invitation through this interface.

Use cases：When you need to accept the call invitation initiated earlier, you can accept the call invitation through this interface.
When to call：It can be called after creating a ZIM instance through [create].
Caution：The callee will fail to accept an uninvited callid.
Related callbacks：[ZIMCallAcceptanceSentCallback].

Available since：2.0.0 and above.

callReject

callReject(callID: string, config: ZIMCallRejectConfig): Promise<ZIMCallRejectionSentResult>

Reject the call invitation.

Parameters

Name	Type	Description
callID	string	The ID of the call invitation to be rejected.
config	ZIMCallRejectConfig	Related configuration for rejecting call invitations.

Details

When the calling party initiates a call invitation, the called party can reject the call invitation through this interface.

Use cases：When you need to reject the call invitation initiated earlier, you can use this interface to reject the call invitation.
When to call：It can be called after creating a ZIM instance through [create].
Caution：The callee will fail to reject the uninvited callid.
Related callbacks：[ZIMCallRejectionSentCallback].

Available since：2.0.0 and above.

callingInvite

callingInvite(invitees: string[], callID: string, config: ZIMCallingInviteConfig): Promise<ZIMCallingInvitationSentResult>

Invite other users to join the call invitation.

Parameters

Name	Type	Description
invitees	string[]	The list of user IDs to invite into the call.
callID	string	The current call invitation ID.
config	ZIMCallingInviteConfig	Configuration for inviting during an active call.

Details

In the advanced mode, when the master calls the call invitation, users in the call can continue to invite other users to join the call through the interface，Or after the called party accepts the advanced mode call invitation.

When to call：After calling [callInvite] to initiate a call invitation in advanced mode.
Caution：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：[ZIMCallingInvitationSentCallback].

Available since：2.9.0 and above.

callJoin

callJoin(callID: string, config: ZIMCallJoinConfig): Promise<ZIMCallJoinSentResult>

Join an advanced mode call, or switch the main device for the advanced mode call (multi-terminal login only).

Parameters

Name	Type	Description
callID	string	The call invitation ID to join.
config	ZIMCallJoinConfig	Call join configuration.

Details

After create an advanced mode call invitation, you can invoke this interface to join the call or switch the primary device.

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.

Available since：2.12.0.

callQuit

callQuit(callID: string, config: ZIMCallQuitConfig): Promise<ZIMCallQuitSentResult>

Quit the current call invitation.

Parameters

Name	Type	Description
callID	string	The call invitation ID to quit.
config	ZIMCallQuitConfig	Call quit configuration.

Details

When the Lord's call initiates the invitation and is called and accepts it, the current call can be exited through the interface.

When to call：It can be called after creating a ZIM instance through [create].
Caution：The callee will fail to quit the uninvited callid.
Related callbacks：[ZIMCallQuitSentCallback].

Available since：2.9.0 and above.

callEnd

callEnd(callID: string, config: ZIMCallEndConfig): Promise<ZIMCallEndSentResult>

End the call invitation.

Parameters

Name	Type	Description
callID	string	The call invitation ID to end.
config	ZIMCallEndConfig	Call end configuration.

Details

End The call in advanced mode.

When to call：The call was in advanced mode and the user status was Accepted.
Caution：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：[ZIMCallEndSentCallback].

Available since：2.9.0 and above.

queryCallInvitationList

queryCallInvitationList(config: ZIMCallInvitationQueryConfig): Promise<ZIMCallInvitationListQueriedResult>

Query the call invitation list.

Parameters

Name	Type	Description
config	ZIMCallInvitationQueryConfig	Call invitation list query configuration.

Details

Users can call the call invitation list through the query.

Use cases：Users can use the query call invitation list for interface display or other functions.
When to call：Run [create] to create a ZIM instance, which can be invoked after login.
Related callbacks：[ZIMCallInvitationListQueriedCallback].

Available since：2.9.0 and above.

addFriend

addFriend(userID: string, config: ZIMFriendAddConfig): Promise<ZIMFriendAddedResult>

Add friends directly.

Parameters

Name	Type	Description
userID	string	The user ID to add as a friend.
config	ZIMFriendAddConfig	Friend add configuration.

Details

Through this interface, a user with the specified userID can be added to the friend list.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[onFriendListChanged].

Available since：2.14.0 or above.

deleteFriends

deleteFriends(userIDs: string[], config: ZIMFriendDeleteConfig): Promise<ZIMFriendsDeletedResult>

Delete friends.

Parameters

Name	Type	Description
userIDs	string[]	The list of friend user IDs to delete.
config	ZIMFriendDeleteConfig	Friend delete configuration.

Details

Through this interface, the specified user can be deleted from the friend list.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[onFriendListChanged].

Available since：2.14.0 or above.

checkFriendsRelation

checkFriendsRelation(userIDs: string[], config: ZIMFriendRelationCheckConfig): Promise<ZIMFriendsRelationCheckedResult>

Check friend relationships.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to check friend relationships with.
config	ZIMFriendRelationCheckConfig	Friend relation check configuration.

Details

Through this interface, you can check the friend relationship with the specified user.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendsRelationCheckedCallback].

Available since：2.14.0 or above.

updateFriendAlias

updateFriendAlias(friendAlias: string, userID: string): Promise<ZIMFriendAliasUpdatedResult>

Update friend alias.

Parameters

Name	Type	Description
friendAlias	string	The new friend alias.
userID	string	The user ID of the friend to update the alias for.

Details

Through this interface, the specified userID user can update the alias.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendAliasUpdatedCallback].

Available since：2.14.0 or above.

updateFriendAttributes

updateFriendAttributes(friendAttributes: Map<string, string>, userID: string): Promise<ZIMFriendAttributesUpdatedResult>

Update friend attributes.

Parameters

Name	Type	Description
friendAttributes	Map<string, string>	The friend attributes to update, in key-value pairs.
userID	string	The user ID of the friend to update attributes for.

Details

Through this interface, the specified userID user can update the attributes.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.

Available since：2.14.0 or above.

queryFriendsInfo

queryFriendsInfo(userIDs: string[]): Promise<ZIMFriendsInfoQueriedResult>

Query friend information in batches.

Parameters

Name	Type	Description
userIDs	string[]	The list of friend user IDs to query information for.

Details

If you need to query the information of a group of designated friends for display, you can query it through this interface.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendListQueriedCallback].

Available since：2.14.0 or above.

queryFriendList

queryFriendList(config: ZIMFriendListQueryConfig): Promise<ZIMFriendListQueriedResult>

Query the friends list.

Parameters

Name	Type	Description
config	ZIMFriendListQueryConfig	Friend list query configuration.

Details

The list of friends that need to be paged can be queried through this interface.

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

Available since：2.14.0 or above.

searchLocalFriends

searchLocalFriends(config: ZIMFriendSearchConfig): Promise<ZIMFriendsSearchedResult>

Search local friends.

Parameters

Name	Type	Description
config	ZIMFriendSearchConfig	Friend search configuration.

Details

Through this interface, you can search for local friend information based on keywords.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendsSearchedCallback].

Available since：2.14.0 or above.

sendFriendApplication

sendFriendApplication(userID: string, config: ZIMFriendApplicationSendConfig): Promise<ZIMFriendApplicationSentResult>

Send a friend application.

Parameters

Name	Type	Description
userID	string	The user ID to send the friend application to.
config	ZIMFriendApplicationSendConfig	Friend application configuration.

Details

When the user needs to initiate a friend application, he can initiate a friend application to the other party through [sendFriendApplication].

Use cases：When you need to initiate a friend request for a user, you can call this interface.
When to call：It can be called after creating a ZIM instance through [create].
Related callbacks：[onFriendApplicationListChanged].

Available since：2.14.0 and above.

acceptFriendApplication

acceptFriendApplication(userID: string, config: ZIMFriendApplicationAcceptConfig): Promise<ZIMFriendApplicationAcceptedResult>

Accept a friend application.

Parameters

Name	Type	Description
userID	string	The user ID of the friend application sender.
config	ZIMFriendApplicationAcceptConfig	Configuration for accepting the friend application.

Details

After receiving the friend application, accept the friend application through this interface.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendApplicationAcceptedCallback].

Available since：2.14.0 or above.

rejectFriendApplication

rejectFriendApplication(userID: string, config: ZIMFriendApplicationRejectConfig): Promise<ZIMFriendApplicationRejectedResult>

Reject a friend application.

Parameters

Name	Type	Description
userID	string	The user ID of the friend application sender.
config	ZIMFriendApplicationRejectConfig	Configuration for rejecting the friend application.

Details

After receiving the friend application, reject the friend application through this interface.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendApplicationRejectedCallback].

Available since：2.14.0 or above.

queryFriendApplicationList

queryFriendApplicationList(config: ZIMFriendApplicationListQueryConfig): Promise<ZIMFriendApplicationListQueriedResult>

Query the friend application list.

Parameters

Name	Type	Description
config	ZIMFriendApplicationListQueryConfig	Friend application list query configuration.

Details

If you need to paginate to query the list of friend applications, you can query through this interface.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMFriendApplicationListQueriedCallback].

Available since：2.14.0 or above.

addUsersToBlacklist

addUsersToBlacklist(userIDs: string[]): Promise<ZIMBlacklistUsersAddedResult>

Add users to the blacklist.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to add to the blacklist.

Details

Through this interface, a user with the specified userID can be added to the blacklist.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMBlacklistUsersAddedCallback].

Available since：2.13.0 or above.
Restrictions：The number of userID passed in at one time cannot exceed 20.

removeUsersFromBlacklist

removeUsersFromBlacklist(userIDs: string[]): Promise<ZIMBlacklistUsersRemovedResult>

Remove the user from the blacklist.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to remove from the blacklist.

Details

Through this interface, the user with the specified userID can be removed from the blacklist.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMBlacklistUsersRemovedCallback].

Available since：2.13.0 or above.
Restrictions：The number of userID passed in at one time cannot exceed 20.

queryBlacklist

queryBlacklist(config: ZIMBlacklistQueryConfig): Promise<ZIMBlacklistQueriedResult>

Query the blacklist.

Parameters

Name	Type	Description
config	ZIMBlacklistQueryConfig	Blacklist query configuration.

Details

Query the blacklist.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMBlacklistQueriedCallback].

Available since：2.13.0 or above.

checkUserIsInBlacklist

checkUserIsInBlacklist(userID: string): Promise<ZIMBlacklistCheckedResult>

Check if the user is on the blacklist.

Parameters

Name	Type	Description
userID	string	The user ID to check whether it is on the blacklist.

Details

Through this interface, you can check whether a certain userID is on the blacklist.

When to call：It is available only after calling [create] to create the instance and then calling [login] to login.
Related callbacks：[ZIMBlacklistCheckedCallback].

Available since：2.13.0 or above.

createCommunity

createCommunity(communityInfo: ZIMCommunityInfo, config: ZIMCommunityCreateConfig): Promise<ZIMCommunityCreatedResult>

Create a community.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityInfo	Information for the community to be created.
config	ZIMCommunityCreateConfig	Create the relevant configuration of the community.

Details

Create a community-type group that supports massive members interacting simultaneously.

Use cases：Used to create a large-scale social group that supports up to 100,000 users chatting or interacting in the community at the same time.
Related callbacks：The result of creating the community is obtained through the [ZIMCommunityCreatedCallback] callback.

Available since：3.0.0.

dismissCommunity

dismissCommunity(communityID: string): Promise<ZIMCommunityDismissedResult>

Dismiss a community.

Parameters

Name	Type	Description
communityID	string	The ID of the community to dismiss.

Details

After a community is created, the community owner can dismiss it through this interface.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Caution：Only the community owner can dismiss the community.
Related callbacks：The result of dismissing the community is obtained through the [ZIMCommunityDismissedCallback] callback.

Available since：3.0.0.

joinCommunity

joinCommunity(communityID: string): Promise<ZIMCommunityJoinedResult>

Join a community.

Parameters

Name	Type	Description
communityID	string	The community ID to join.

Details

Users can join the specified community through this interface.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The result of joining the community is obtained through the [ZIMCommunityJoinedCallback] callback.

Available since：3.0.0.

leaveCommunity

leaveCommunity(communityID: string): Promise<ZIMCommunityLeftResult>

Leave a community.

Parameters

Name	Type	Description
communityID	string	The community ID to leave.

Details

After a user joins a community, they can leave through this interface.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The result of leaving the community is obtained through the [ZIMCommunityLeftCallback] callback.

Available since：3.0.0.

inviteUsersIntoCommunity

inviteUsersIntoCommunity(userIDs: string[], communityID: string): Promise<ZIMCommunityUsersInvitedResult>

Invite users into a community.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to invite.
communityID	string	The target community ID.

Details

Invite specified users to join the community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The result of the invitation is obtained through the [ZIMCommunityUsersInvitedCallback] callback.

Available since：3.0.0.

kickCommunityMembers

kickCommunityMembers(userIDs: string[], communityID: string): Promise<ZIMCommunityMembersKickedResult>

Kick members from a community.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to kick from the community.
communityID	string	The target community ID.

Details

Remove specified users from the community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Caution：Only the community owner and administrators can call this.
Related callbacks：The result of kicking members is obtained through the [ZIMCommunityMembersKickedCallback] callback.

Available since：3.0.0.

queryCommunityList

queryCommunityList(count: number, config: ZIMCommunityListQueryConfig): Promise<ZIMCommunityListQueriedResult>

Query the community list.

Parameters

Name	Type	Description
count	number	The number of communities to query.
config	ZIMCommunityListQueryConfig	Community list query configuration (optional).

Details

Query the list of communities that the current user has joined.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The query result is obtained through the [ZIMCommunityListQueriedCallback] callback.

Available since：3.0.0.

updateCommunityName

updateCommunityName(communityName: string, communityID: string): Promise<ZIMCommunityNameUpdatedResult>

Update the community name.

Parameters

Name	Type	Description
communityName	string	The new community name.
communityID	string	The target community ID.

Details

Update the name of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The update result is obtained through the [ZIMCommunityNameUpdatedCallback] callback.

Available since：3.0.0.

updateCommunityAvatarUrl

updateCommunityAvatarUrl(communityAvatarUrl: string, communityID: string): Promise<ZIMCommunityAvatarUrlUpdatedResult>

Update the community avatar URL.

Parameters

Name	Type	Description
communityAvatarUrl	string	The new community avatar URL.
communityID	string	The target community ID.

Details

Update the avatar URL of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The update result is obtained through the [ZIMCommunityAvatarUrlUpdatedCallback] callback.

Available since：3.0.0.

updateCommunityNotice

updateCommunityNotice(communityNotice: string, communityID: string): Promise<ZIMCommunityNoticeUpdatedResult>

Update the community notice.

Parameters

Name	Type	Description
communityNotice	string	The new community notice content.
communityID	string	The target community ID.

Details

Update the notice content of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The update result is obtained through the [ZIMCommunityNoticeUpdatedCallback] callback.

Available since：3.0.0.

setCommunityAttributes

setCommunityAttributes(communityAttributes: Map<string, string>, communityID: string): Promise<ZIMCommunityAttributesOperatedResult>

Set community attributes.

Parameters

Name	Type	Description
communityAttributes	Map<string, string>	The community attributes to set, in key-value pairs.
communityID	string	The target community ID.

Details

Set custom attributes for the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The result is obtained through the [ZIMCommunityAttributesOperatedCallback] callback.

Available since：3.0.0.

deleteCommunityAttributes

deleteCommunityAttributes(keys: string[], communityID: string): Promise<ZIMCommunityAttributesOperatedResult>

Delete community attributes.

Parameters

Name	Type	Description
keys	string[]	The list of community attribute keys to delete.
communityID	string	The target community ID.

Details

Delete custom attributes of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The deletion result is obtained through the [ZIMCommunityAttributesOperatedCallback] callback.

Available since：3.0.0.

setCommunityNotificationStatus

setCommunityNotificationStatus(status: ZIMCommunityMessageNotificationStatus, communityID: string): Promise<ZIMCommunityNotificationStatusSetResult>

Set the community notification status.

Parameters

Name	Type	Description
status	ZIMCommunityMessageNotificationStatus	The notification status to set.
communityID	string	The target community ID.

Details

Set the message notification status (such as Do Not Disturb) for the current user in the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The result is obtained through the [ZIMCommunityNotificationStatusSetCallback] callback.

Available since：3.0.0.

queryCommunityInfo

queryCommunityInfo(communityID: string): Promise<ZIMCommunityInfoQueriedResult>

Query community information.

Parameters

Name	Type	Description
communityID	string	The community ID to query information for.

Details

Query the detailed information of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The query result is obtained through the [ZIMCommunityInfoQueriedCallback] callback.

Available since：3.0.0.

updateCommunityMemberRole

updateCommunityMemberRole(memberRole: number, forUserID: string, communityID: string): Promise<ZIMCommunityMemberRoleUpdatedResult>

Update a community member's role.

Parameters

Name	Type	Description
memberRole	number	The role value to set for the member.
forUserID	string	The user ID of the target community member.
communityID	string	The target community ID.

Details

Update the role of the specified community member.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Caution：Only the community owner can call this.
Related callbacks：The update result is obtained through the [ZIMCommunityMemberRoleUpdatedCallback] callback.

Available since：3.0.0.

transferCommunityOwner

transferCommunityOwner(toUserID: string, communityID: string): Promise<ZIMCommunityOwnerTransferredResult>

Transfer the community owner.

Parameters

Name	Type	Description
toUserID	string	The user ID of the new community owner.
communityID	string	The target community ID.

Details

The community owner can transfer ownership to a specified user through this method.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Caution：Only the community owner can call this.
Related callbacks：The transfer result is obtained through the [ZIMCommunityOwnerTransferredCallback] callback.

Available since：3.0.0.

queryCommunityMemberList

queryCommunityMemberList(communityID: string, count: number, config: ZIMCommunityMemberListQueryConfig): Promise<ZIMCommunityMemberListQueriedResult>

Query the community member list.

Parameters

Name	Type	Description
communityID	string	The community ID to query the member list for.
count	number	The number of members to query.
config	ZIMCommunityMemberListQueryConfig	Community member list query configuration (optional).

Details

Query the member list of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The query result is obtained through the [ZIMCommunityMemberListQueriedCallback] callback.

Available since：3.0.0.

queryCommunityMembers

queryCommunityMembers(userIDs: string[], communityID: string): Promise<ZIMCommunityMembersQueriedResult>

Query specific community members' information.

Parameters

Name	Type	Description
userIDs	string[]	The list of user IDs to query information for.
communityID	string	The target community ID.

Details

Query the member information of specific users in the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The query result is obtained through the [ZIMCommunityMembersQueriedCallback] callback.

Available since：3.0.0.

createCommunityChannel

createCommunityChannel(channelInfo: ZIMCommunityChannelInfo, config: ZIMCommunityChannelCreateConfig): Promise<ZIMCommunityChannelCreatedResult>

Create a community channel.

Parameters

Name	Type	Description
channelInfo	ZIMCommunityChannelInfo	Information for the community channel to be created.
config	ZIMCommunityChannelCreateConfig	Create the relevant configuration of the community channel.

Details

Create a chat channel within a community. The current version only supports creating public channels.

Use cases：Used to distinguish different chat topics within a community, allowing community administrators to manage separately and gather users with the same interests under the same topic.
When to call：Can be called after creating a ZIM instance via [create] and logging in.
Caution：Only the community owner and community administrators can create channels in the community.

Available since：3.0.0.

dismissCommunityChannel

dismissCommunityChannel(channelID: string, communityID: string): Promise<ZIMCommunityChannelDismissedResult>

Dismiss a community channel.

Parameters

Name	Type	Description
channelID	string	The channel ID to dismiss.
communityID	string	The target community ID.

Details

Dismiss the specified channel in the community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The dismissal result is obtained through the [ZIMCommunityChannelDismissedCallback] callback.

Available since：3.0.0.

updateCommunityChannelName

updateCommunityChannelName(channelName: string, channelID: string, communityID: string): Promise<ZIMCommunityChannelNameUpdatedResult>

Update the community channel name.

Parameters

Name	Type	Description
channelName	string	The new channel name.
channelID	string	The channel ID to update the name for.
communityID	string	The target community ID.

Details

Update the name of the specified community channel.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The update result is obtained through the [ZIMCommunityChannelNameUpdatedCallback] callback.

Available since：3.0.0.

updateCommunityChannelAvatarUrl

updateCommunityChannelAvatarUrl(channelAvatarUrl: string, channelID: string, communityID: string): Promise<ZIMCommunityChannelAvatarUrlUpdatedResult>

Update the community channel avatar URL.

Parameters

Name	Type	Description
channelAvatarUrl	string	The new channel avatar URL.
channelID	string	The channel ID to update the avatar URL for.
communityID	string	The target community ID.

Details

Update the avatar URL of the specified community channel.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The update result is obtained through the [ZIMCommunityChannelAvatarUrlUpdatedCallback] callback.

Available since：3.0.0.

updateCommunityChannelNotice

updateCommunityChannelNotice(channelNotice: string, channelID: string, communityID: string): Promise<ZIMCommunityChannelNoticeUpdatedResult>

Update the community channel notice.

Parameters

Name	Type	Description
channelNotice	string	The new channel notice content.
channelID	string	The channel ID to update the notice for.
communityID	string	The target community ID.

Details

Update the notice content of the specified community channel.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The update result is obtained through the [ZIMCommunityChannelNoticeUpdatedCallback] callback.

Available since：3.0.0.

setCommunityChannelAttributes

setCommunityChannelAttributes(channelAttributes: Map<string, string>, channelID: string, communityID: string): Promise<ZIMCommunityChannelAttributesOperatedResult>

Set community channel attributes.

Parameters

Name	Type	Description
channelAttributes	Map<string, string>	The channel attributes to set, in key-value pairs.
channelID	string	The target channel ID.
communityID	string	The target community ID.

Details

Set custom attributes for the specified community channel.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The result is obtained through the [ZIMCommunityChannelAttributesOperatedCallback] callback.

Available since：3.0.0.

deleteCommunityChannelAttributes

deleteCommunityChannelAttributes(keys: string[], channelID: string, communityID: string): Promise<ZIMCommunityChannelAttributesOperatedResult>

Delete community channel attributes.

Parameters

Name	Type	Description
keys	string[]	The list of channel attribute keys to delete.
channelID	string	The target channel ID.
communityID	string	The target community ID.

Details

Delete custom attributes of the specified community channel.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The deletion result is obtained through the [ZIMCommunityChannelAttributesOperatedCallback] callback.

Available since：3.0.0.

queryCommunityChannelsInfo

queryCommunityChannelsInfo(channelIDs: string[], communityID: string): Promise<ZIMCommunityChannelsInfoQueriedResult>

Query community channel information.

Parameters

Name	Type	Description
channelIDs	string[]	The list of channel IDs to query information for.
communityID	string	The target community ID.

Details

Query the detailed information of multiple channels in the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The query result is obtained through the [ZIMCommunityChannelsInfoQueriedCallback] callback.

Available since：3.0.0.

queryCommunityChannelList

queryCommunityChannelList(communityID: string, count: number, config: ZIMCommunityChannelListQueryConfig): Promise<ZIMCommunityChannelListQueriedResult>

Query the community channel list.

Parameters

Name	Type	Description
communityID	string	The community ID to query the channel list for.
count	number	The number of channels to query.
config	ZIMCommunityChannelListQueryConfig	Community channel list query configuration (optional).

Details

Query the channel list of the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The query result is obtained through the [ZIMCommunityChannelListQueriedCallback] callback.

Available since：3.0.0.

muteCommunityChannels

muteCommunityChannels(isMute: boolean, channelIDs: string[], communityID: string, config: ZIMCommunityChannelMuteConfig): Promise<ZIMCommunityChannelsMutedResult>

Mute community channels.

Parameters

Name	Type	Description
isMute	boolean	Whether to mute. true means mute, false means unmute.
channelIDs	string[]	The list of channel IDs to mute/unmute.
communityID	string	The target community ID.
config	ZIMCommunityChannelMuteConfig	Community channel mute configuration (optional).

Details

Mute or unmute channels in the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Related callbacks：The operation result is obtained through the [ZIMCommunityChannelsMutedCallback] callback.

Available since：3.0.0.

muteCommunityMembers

muteCommunityMembers(isMute: boolean, userIDs: string[], communityID: string, config: ZIMCommunityMemberMuteConfig): Promise<ZIMCommunityMembersMutedResult>

Mute community members.

Parameters

Name	Type	Description
isMute	boolean	Whether to mute. true means mute, false means unmute.
userIDs	string[]	The list of user IDs to mute/unmute.
communityID	string	The target community ID.
config	ZIMCommunityMemberMuteConfig	Community member mute configuration (optional).

Details

Mute or unmute members in the specified community.

When to call：Can be called after creating a ZIM instance via [create] and logging in.
Caution：Only the community owner and administrators can call this.
Related callbacks：The operation result is obtained through the [ZIMCommunityMembersMutedCallback] callback.

Available since：3.0.0.

ZIMEventHandler

Details

ZIM SDK event handler class.

Methods

onError

onError(zim: ZIM, errorInfo: ZIMError): void

The callback for error information.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
errorInfo	ZIMError	The error information

Details

When an exception occurs in the SDK, the callback will prompt detailed exception information.

Use cases：It is recommended that developers, after integrating the SDK, listen to this callback during the debugging phase and print error information to the console to promptly identify and fix errors that occur during development.
Triggered when：This callback is triggered when an error occurs internally in the SDK. For error codes, refer to the official website documentation.

Available since：1.0.0 and above.

onExperimentalEventReceived

onExperimentalEventReceived(zim: ZIM, content: string): void

Experimental API callback.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
content	string	Callback content in JSON string format.

Details

Receive experimental API callbacks. Please use this feature with the assistance of ZEGO technical support.

Available since：2.28.0 and above.

onTokenWillExpire

onTokenWillExpire(zim: ZIM, result: ZIMTokenWillExpireEventResult): void

A reminder callback that the token is about to expire.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMTokenWillExpireEventResult	The token will expire event callback result

Details

When developers use authentication tokens for login, the token update logic can be handled through this event when the token is about to expire.

Triggered when：When the authentication token has only 30 seconds remaining, the SDK will trigger this callback to notify developers to update the authentication token. If the token passed during [login] has less than 30 seconds of validity, this callback will be triggered immediately after [login] succeeds.
Caution：When this callback is received, developers should promptly call [renewToken] to update the token.
References：For details, please refer to the authentication token generation guide at https://doc-zh.zego.im/article/11617 .

Available since：1.1.0 and above.

onConnectionStateChanged

onConnectionStateChanged(zim: ZIM, result: ZIMConnectionStateChangedEventResult): void

The event callback when the connection state changes.

Parameters

Name	Type	Description
zim	ZIM	zim ZIM instance.
result	ZIMConnectionStateChangedEventResult	The connection state changed event callback result

Details

When the connection state changes, this callback notifies the user of the current state and event.

Use cases：When you need to monitor the connection state and the events that cause connection state changes, you can use [ZIMConnectionState] and [ZIMConnectionEvent] in this callback to implement different business logic.
Triggered when：This callback is triggered when the SDK performs login, logout, or when the network is temporarily interrupted.
Caution：In the case of connection state changes caused by general network exceptions, developers do not need to perform reconnection themselves. The SDK will continuously attempt to reconnect until successful.

Available since：1.1.0 and above.

onUserInfoUpdated

onUserInfoUpdated(zim: ZIM, result: ZIMUserInfoUpdatedEventResult): void

In the multi-terminal login scenario, after the user modifies their information on device A, other online multi-terminal devices will receive this callback. For offline devices, after the user goes online, they need to call the [queryUsersInfo] interface to actively query user information.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMUserInfoUpdatedEventResult	The user info changed event callback result

Details

In multi-device login scenarios, after the user modifies their information on device A, other online multi-device devices will receive this callback. For offline devices, after the user comes online, they need to call the [queryUsersInfo] interface to actively query user information.

Triggered when：When the current user on another device modifies their own user information, this callback is triggered on all currently online devices.

Available since：2.11.0 and above.

onUserRuleUpdated

onUserRuleUpdated(zim: ZIM, result: ZIMUserRuleUpdatedEventResult): void

Triggered when the user rule changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMUserRuleUpdatedEventResult	The user rule changed event callback result

Details

When the current user changes user rules via [updateUserOfflinePushRule], this callback notifies other online multi-device devices.

Triggered when：When the current user on another device modifies their own user rules, this callback is triggered on all currently online devices.

Available since：2.15.0 and above.

onUserStatusUpdated

onUserStatusUpdated(zim: ZIM, result: ZIMUserStatusUpdatedEventResult): void

User online status change notification.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMUserStatusUpdatedEventResult	The user status changed event callback result

Details

Event notification when the online status of subscribed users changes.

Use cases：When your business needs to monitor the online status of certain users, such as displaying online group members, subscribe to those users via [subscribeUsersStatus]. Changes to those users' online status and platform list during the subscription period will be notified through this callback.
Triggered when：After the current user first subscribes to a target user, this event is triggered when the target user is first added to the subscription list, or when the subscribed user's online status or online platform list changes. Additionally, if the current user has multi-device login enabled and the online platform changes, this callback will also be triggered.
Caution：When the [onUserStatusUpdated] callback returns the current user's userStatus information, the onlineStatus will be [ZIMUserOnlineStatusUnknown] and lastUpdateTime will be 0, which does not accurately reflect the online status. Please use [onConnectionStateChanged] to map the current user's online status.

Available since：2.18.0 and above.

onConversationChanged

onConversationChanged(zim: ZIM, result: ZIMConversationChangedEventResult): void

Received notification callback for session update.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationChangedEventResult	The conversation changed event callback result

Details

Trigger this callback to return notification of session updates when a session is added, deleted, or modified.

Triggered when：Notifications are triggered when a new message is updated in the session, or when the session itself is added, deleted, or modified.
Caution：ConversationID is the same as single chat toUserID and group chat groupID.
Related APIs：Through [sendMessage], [deleteConversation] [deleteMessages], [clearConversationUnreadMessageCount] trigger.

Available since：2.0.0 and above.

onConversationTotalUnreadMessageCountUpdated

onConversationTotalUnreadMessageCountUpdated(zim: ZIM, result: ZIMConversationTotalUnreadMessageCountUpdatedEventResult): void

Received notification callback for session update.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationTotalUnreadMessageCountUpdatedEventResult	The conversation total unread message count changed event callback result

Details

This callback returns the total number of unread messages across all conversations.

Triggered when：Immediately after the SDK logs in, a notification of the current total unread message count is triggered. It is also triggered when new messages are received or when the unread count of a conversation is cleared.
Caution：If a conversation is set to do-not-disturb mode, changes to its unread count will not drive changes to the total unread count.

Available since：2.0.0 and above.

onConversationMessageReceiptChanged

onConversationMessageReceiptChanged(zim: ZIM, result: ZIMConversationMessageReceiptChangedEventResult): void

Received notification callback when the message receiver has read this receipt message.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationMessageReceiptChangedEventResult	The conversation message receipt changed event callback result

Details

When the message receiver has read the session, the message sender knows through this callback.

Triggered when：Trigger a notification when the message receiver has read the session.
Related APIs：[sendConversationMessageReceiptRead]

Available since：2.5.0 and above.

onConversationsAllDeleted

onConversationsAllDeleted(zim: ZIM, result: ZIMConversationsAllDeletedEventResult): void

When multiple login ends delete all sessions, the local end triggers the callback to notify the local end that all sessions are deleted.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationsAllDeletedEventResult	The conversations all deleted event callback result

Details

When multiple login ends delete all sessions, the local end triggers the callback to notify the local end that all sessions are deleted.

Triggered when：When another end clears all unread sessions, the local end triggers a notification.
Caution：After calling the SDK [deleteAllConversations] interface to delete all conversations, [onConversationChanged] will not be triggered. It is recommended that developers, upon receiving this callback, call [queryConversationList] again to sync the conversation list UI to the latest state.
Related APIs：[deleteAllConversations].

Available since：2.12.0 and above.

onConversationSyncStateChanged

onConversationSyncStateChanged(zim: ZIM, result: ZIMConversationSyncStateChangedEventResult): void

Notification of synchronization status change events between the conversation list and the server

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationSyncStateChangedEventResult	The callback result of the conversation list and server status synchronization event

Details

After the SDK first logs in and starts the process of syncing conversations from the server, this callback is triggered to return notifications of conversation updates when the process completes or fails.

Triggered when：This callback is triggered when the SDK performs the sync conversation list operation after the first login or after reconnecting from a network disconnect.
Caution：Even if the conversation list does not need to be synced, the SDK will still trigger the sync completion callback so that developers can display or dismiss UI loading indicators.

Available since：2.21.0 and above.

onPeerMessageReceived

deprecated

onPeerMessageReceived(zim: ZIM, result: ZIMConversationMessageReceivedEventResult): void

The callback for receiving peer-to-peer message.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationMessageReceivedEventResult	The receive peer message event callback result

Details

When online, users can receive online peer-to-peer messages through this callback. After re-logging in to the ZIM SDK, users can receive all peer-to-peer messages received during the offline period (up to 7 days) through this callback.

Triggered when：This callback is triggered when a peer-to-peer message sent by another user is received.
Related APIs：[sendMessage]

Available since：2.18.0 and above.

Deprecated

This API was deprecated in version 3.0.0. Please use [onMessageReceived] instead.

onRoomMessageReceived

deprecated

onRoomMessageReceived(zim: ZIM, result: ZIMConversationMessageReceivedEventResult): void

The callback for receiving room message.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationMessageReceivedEventResult	The receive room message event callback result

Details

When online, users can receive online room messages through this callback. After recovering from offline to online, if the user is still in the room, they can receive all room messages from the offline period through this callback (this capability requires the room offline message storage feature to be enabled).

Triggered when：This callback is triggered when the current user is in a room and other users in the same room send messages to the room the current user has joined or created.
Related APIs：[sendMessage]

Available since：2.18.0 and above.

Deprecated

This API was deprecated in version 3.0.0. Please use [onMessageReceived] instead.

onGroupMessageReceived

deprecated

onGroupMessageReceived(zim: ZIM, result: ZIMConversationMessageReceivedEventResult): void

The callback for receiving group message.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMConversationMessageReceivedEventResult	The receive group message event callback result

Details

When online, users can receive online group messages through this callback. After re-logging in to the ZIM SDK, users can receive all group chat messages received during the offline period (up to 7 days) through this callback.

Triggered when：This callback is triggered when group members in the same group send messages.
Related APIs：[sendMessage]

Available since：2.18.0 and above.

Deprecated

This API was deprecated in version 3.0.0. Please use [onMessageReceived] instead.

onMessageReceived

onMessageReceived(zim: ZIM, result: ZIMMessageReceivedEventResult): void

The callback for receiving message.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageReceivedEventResult	The receive group message event callback result

Details

When online, users can receive online messages through this callback. After re-logging in to the ZIM SDK, users can receive all single chat and group chat messages received during the offline period (up to 7 days); if the room has the offline message storage feature enabled, room messages can also be received.

Triggered when：This callback is triggered when a peer-to-peer message, room message, group message, or community channel message is received.
Related APIs：[sendMessage]

Available since：3.0.0 and above.

onBroadcastMessageReceived

onBroadcastMessageReceived(zim: ZIM, result: ZIMBroadcastMessageReceivedEventResult): void

The callback for receiving broadcast message.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMBroadcastMessageReceivedEventResult	The event result for receiving broadcast message.

Details

The callback is received when the server interface [SendMessageToAllUsers] sends a message.

Triggered when：This callback is received after logging in to the ZIM service and the server call the [SendMessageToAllUsers] interface to send a message.

Available since：2.10.0 or later.

onMessageSentStatusChanged

onMessageSentStatusChanged(zim: ZIM, result: ZIMMessageSentStatusChangedEventResult): void

The callback for message sent status changed.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageSentStatusChangedEventResult	The message sent status changed event callback result

Details

This callback is received when the message sending status changes.

Triggered when：When the current user sends a message and the message status changes from sending to sent successfully or send failed, this callback will be triggered.
Caution：Only the device user who actually sends the message can receive this callback. Other devices in a multi-device login scenario will not receive this callback.
Related APIs：[sendMessage]

Available since：2.6.0 and above.

onMessageReceiptChanged

onMessageReceiptChanged(zim: ZIM, result: ZIMMessageReceiptChangedEventResult): void

Received notification callback when the message receiver confirms that the message has been read.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageReceiptChangedEventResult	The message receipt change event callback result

Details

When the message receiver confirms that the message has been read, the message sender knows through this callback.

Triggered when：Trigger a notification when the message receiver has read the message.
Related APIs：Triggered when the peer calls via [sendMessageReceiptsRead].

Available since：2.5.0 and above.

onMessageRevokeReceived

onMessageRevokeReceived(zim: ZIM, result: ZIMMessageRevokeReceivedEventResult): void

Received notification callback when some one else sends a message and then revoke a message sent by themselves.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageRevokeReceivedEventResult	The message revoke event callback result

Details

This callback is received when some one else sends a message and then revoke.

Triggered when：This callback occurs when a ZIM instance is created with [create] and the other user revoke a message.
Related APIs：You can revoke message to other members via [revokeMessage].

Available since：2.5.0 and above.

onMessageReactionsChanged

onMessageReactionsChanged(zim: ZIM, result: ZIMMessageReactionsChangedEventResult): void

The callback is received when reactions change

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageReactionsChangedEventResult	The message reaction change event callback result

Details

This callback is received when the reaction types in a message increase or decrease, or when the user count and count of a specific reaction change.

Triggered when：This callback is triggered when the current user has already received a message in the conversation and the reaction content of the message changes.
Related APIs：[addMessageReaction], [deleteMessageReaction]

Available since：2.28.0 and above.

onMessageDeleted

onMessageDeleted(zim: ZIM, result: ZIMMessageDeletedEventResult): void

The callback is received when a message is deleted.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageDeletedEventResult	The message delete event callback result

Details

In multi-device login scenarios, after the user deletes server-side messages on device A, other online multi-device devices will receive this callback.

Triggered when：When another device of the current user in a multi-device online login performs message deletion, the online user on the current device will trigger this callback.
Caution：When other users in a conversation delete messages, other users will not receive this callback. This callback only takes effect for the user who performs the deletion.
Related APIs：[deleteMessages], [deleteAllMessage], [deleteAllConversationMessages]

Available since：2.11.0 and above.

onMessageRepliedInfoChanged

onMessageRepliedInfoChanged(zim: ZIM, result: ZIMMessageRepliedInfoChangedEventResult): void

The callback is received when the message replied information changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageRepliedInfoChangedEventResult	The message replied information change event callback result

Details

Users in the conversation will receive this callback when the source message referenced by a reply message is deleted, revoked, or its content is edited.

Triggered when：This callback is triggered when the current user has already received a message in the conversation and the reply content carried by that message changes.
Use cases：This allows developers to be notified in advance of source message status changes for quoted messages in the chat view before the reply source message is fetched, enabling timely UI refresh.
Related APIs：[deleteMessages], [revokeMessage], [editMessage]

Available since：2.17.0 and above.

onMessageRepliedCountChanged

onMessageRepliedCountChanged(zim: ZIM, result: ZIMMessageRepliedCountChangedEventResult): void

The callback is received when the message replied count changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageRepliedCountChangedEventResult	The message replied count change event callback result

Details

When messages continue to be replied to in the same reply chain, changes to the reply count of the source message are notified through this callback.

Triggered when：This callback is triggered when the current user has received the source message and the message is replied to.
Related APIs：[replyMessage].

Available since：2.17.0 and above.

onMessageEdited

onMessageEdited(zim: ZIM, result: ZIMMessageEditedEventResult): void

The callback is received when a message is edited.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessageEditedEventResult	The message edited event callback result.

Details

Users in the conversation will receive this callback when a message is edited.

Triggered when：This callback is triggered when the current user has already received a message in the conversation and that message is subsequently edited.
Related APIs：[editMessage].

Available since：2.20.0 and above.

onMessagePinStatusChanged

onMessagePinStatusChanged(zim: ZIM, result: ZIMMessagePinStatusChangedEventResult): void

The callback is received when a message is pinned.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMMessagePinStatusChangedEventResult	The message edited event callback result.

Details

This callback is received when a message in the conversation is successfully pinned or unpinned, or when the pinned message information changes.

Triggered when：This callback is triggered when a message in the conversation is successfully pinned or unpinned, or when the pinned message information changes.
Related APIs：[pinMessage].

Available since：2.25.0 and above.

onRoomStateChanged

onRoomStateChanged(zim: ZIM, result: ZIMRoomStateChangedEventResult): void

The event callback when the room connection status changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMRoomStateChangedEventResult	The room state change event callback result

Details

Event callback when the room connection status changes. It is recommended that developers always listen to this callback to properly manage the room lifecycle.

Triggered when：This callback is triggered when the room connection status changes, such as when entering or leaving a room, a temporary network interruption, or a room connection timeout.
Caution：Since the SDK does not perform unlimited reconnection for room connections, developers need to selectively perform limited reconnection according to their own business requirements.
References：https://doc-zh.zego.im/faq/zim-reconnect-support

onRoomMemberJoined

onRoomMemberJoined(zim: ZIM, result: ZIMRoomMemberChangedEventResult): void

Callback when other members join the room.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMRoomMemberChangedEventResult	The room member joined event callback result

Details

After joining a room, this callback will be triggered when other members also join the room.

Triggered when：This callback is triggered when the current user is online in the room and other users join the room.
Caution：If the current user is temporarily offline due to network issues when other users enter the room, this callback will not be re-sent after reconnection. Developers can use [queryRoomMemberList] to get the latest room member list at that time.
Related APIs：[enterRoom], [joinRoom].

Available since：1.1.0 and above.

onRoomMemberLeft

onRoomMemberLeft(zim: ZIM, result: ZIMRoomMemberChangedEventResult): void

Callback when other members leave the room.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMRoomMemberChangedEventResult	The room member left event callback result

Details

After joining a room, this callback will be triggered when other members leave the room.

Triggered when：This callback is triggered when the current user is online in the room and other users leave the room.
Caution：If the current user is temporarily offline due to network issues when other users leave the room, this callback will not be re-sent after reconnection. Developers can use [queryRoomMemberList] to get the latest room member list at that time.
Related APIs：[leaveRoom].

Available since：1.1.0 and above.

onRoomAttributesUpdated

onRoomAttributesUpdated(zim: ZIM, result: ZIMRoomAttributesUpdatedEventResult): void

Event callback when the room attributes changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMRoomAttributesUpdatedEventResult	The room attribute change event callback result

Details

When the room attributes in the room change, this callback notifies the users.

Triggered when：When first joining a room, if there are room attributes in the room at that time, a callback is triggered once, which developers can use to save as initial attribute values. This callback is also triggered when other users in the room change room attributes (triggered when the current user is online or successfully reconnects after a brief offline period).
Use cases：In voice chat room scenarios, room attributes can be used to manage microphone seat information.
Related APIs：[setRoomAttributes], [deleteRoomAttributes].

Available since：1.3.0 and above.

onRoomAttributesBatchUpdated

onRoomAttributesBatchUpdated(zim: ZIM, result: ZIMRoomAttributesUpdatedEventResult): void

Event callback when the room attributes batch changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMRoomAttributesUpdatedEventResult	The room attribute batch change event callback result

Details

When room attributes in the room change in batch, this callback notifies the users.

Triggered when：This callback is triggered when another user in the room calls the batch attribute change interface for room attributes.
Use cases：In voice chat room scenarios, room attributes can be used to manage microphone seat information.
Related APIs：[beginRoomAttributesBatchOperation], [endRoomAttributesBatchOperation].

Available since：1.3.0 and above.

onRoomMemberAttributesUpdated

onRoomMemberAttributesUpdated(zim: ZIM, result: ZIMRoomMemberAttributesUpdatedEventResult): void

Event callback when the room member attributes changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMRoomMemberAttributesUpdatedEventResult	The room member attribute change event callback result

Details

When the member user attributes in the room change, this callback notifies the users.

Triggered when：This callback is triggered when another user's attributes are changed in the room and the current user is online.
Use cases：When business additional information needs to be recorded for each member in the room, this callback can be used to receive changes and refresh the UI.
Related APIs：[setRoomMemberAttributes].

Available since：1.3.0 and above.

onGroupStateChanged

onGroupStateChanged(zim: ZIM, result: ZIMGroupStateChangedEventResult): void

Event callback when the group state changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupStateChangedEventResult	The group state change event callback result

Details

Callback notification of group status change. Used to describe the current lifecycle state of the group and the events triggered when the lifecycle state changes.

Use cases：Scenarios that require interaction based on the group status.
Triggered when：A notification is triggered when a group is created, joined, left, or dismissed.
Related APIs：[createGroup] creates a group; [joinGroup] joins a group; [leaveGroup] leaves a group; [dismissGroup] dismisses a group.

Available since：2.0.0 and above.

onGroupNameUpdated

onGroupNameUpdated(zim: ZIM, result: ZIMGroupNameUpdatedEventResult): void

Event callback when the group name changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupNameUpdatedEventResult	Group name change event result.

Details

Group name change notification callback.

Use cases：When the group name changes, you need to synchronize the latest group name.
Triggered when：Triggered when the group name changes.
Related APIs：[updateGroupName], which updates the group name.

Available since：2.0.0 and above.

onGroupAvatarUrlUpdated

onGroupAvatarUrlUpdated(zim: ZIM, result: ZIMGroupAvatarUrlUpdatedEventResult): void

Event callback when the group avatar changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupAvatarUrlUpdatedEventResult	Group avatar change event result.

Details

Notification callback when the group avatar URL changes.

Use cases：When the group avatar URL changes, you need to synchronize the latest group avatar URL.
Triggered when：The group avatar URL changes.
Related APIs：[updateGroupAvatarUrl], which updates the group avatar URL.

Available since：2.0.0 and above.

onGroupNoticeUpdated

onGroupNoticeUpdated(zim: ZIM, result: ZIMGroupNoticeUpdatedEventResult): void

Event callback when the group notice changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupNoticeUpdatedEventResult	Group notice change event result.

Details

Group notice change notification callback.

Use cases：When the group notice changes, you need to synchronize the latest notice content.
Triggered when：Triggered when the group notice changes.
Related APIs：[updateGroupNotice], which updates the group notice.

Available since：2.0.0 and above.

onGroupAliasUpdated

onGroupAliasUpdated(zim: ZIM, result: ZIMGroupAliasUpdatedEventResult): void

Event callback when the group alias changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupAliasUpdatedEventResult	Group alias change event result.

Details

Group alias change notification callback.

Use cases：When the group alias changes, you need to synchronize the latest alias content.
Triggered when：Triggered when the current user who set the group alias or their online multi-device devices change the group alias.
Caution：The group alias feature is only visible to the user who set it. Therefore, changes to the group alias by the current user will not be pushed to other users in the group.
Related APIs：[updateGroupAlias], which updates the group alias.

Available since：2.0.0 and above.

onGroupAttributesUpdated

onGroupAttributesUpdated(zim: ZIM, result: ZIMGroupAttributesUpdatedEventResult): void

Event callback when the group attributes change.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupAttributesUpdatedEventResult	Group attribute change event result.

Details

Group attribute change notification callback.

Use cases：When group attributes are changed, you need to synchronize the latest group attributes.
Triggered when：Triggered when group attributes are set, updated, or deleted.
Related APIs：[setGroupAttributes] updates group attributes; [deleteGroupAttributes] deletes group attributes.

Available since：2.0.0 and above.

onGroupMutedInfoUpdated

onGroupMutedInfoUpdated(zim: ZIM, result: ZIMGroupMutedInfoUpdatedEventResult): void

Event callback when the group is muted.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupMutedInfoUpdatedEventResult	Group mute event result.

Details

Notification callback when the group mute information changes.

Triggered when：When the group mute information changes, users in the group will trigger this callback.
Related APIs：[muteGroup], group mute.

Available since：2.14.0 and above.

onGroupVerifyInfoUpdated

onGroupVerifyInfoUpdated(zim: ZIM, result: ZIMGroupVerifyInfoUpdatedEventResult): void

Event callback when the group verification information changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupVerifyInfoUpdatedEventResult	Group verification information change event result.

Details

Notification callback when the group join verification mode changes.

Triggered when：When the group owner or administrator changes the group join verification mode, users in the group will trigger this callback.
Related APIs：[updateGroupJoinMode, updateGroupInviteMode, updateGroupBeInviteMode].

onGroupMemberStateChanged

onGroupMemberStateChanged(zim: ZIM, result: ZIMGroupMemberStateChangedEventResult): void

Event callback when the group member status changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupMemberStateChangedEventResult	Group member status change event result.

Details

Callback notification when group member status changes.

Use cases：Scenarios that require interaction based on group member states, such as displaying group member join/leave notification UI.
Triggered when：Notification is triggered when a group is created, joined, left, or dismissed, or a user is invited to join or kicked out of the group.
Related APIs：[createGroup] creates a group, [joinGroup] joins a group, [leaveGroup] leaves a group, [dismissGroup] dismisses a group, [inviteUsersIntoGroup] invites users into the group, [kickGroupMembers] kicks out members.

Available since：2.0.0 and above.

onGroupMemberInfoUpdated

onGroupMemberInfoUpdated(zim: ZIM, result: ZIMGroupMemberInfoUpdatedEventResult): void

Event callback when the group member information changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupMemberInfoUpdatedEventResult	Group member information change event result.

Details

Callback for group member basic information change events, including group member nickname, role, and other change events.

Use cases：After the basic information of group members is changed, scenarios that require displaying or interacting with group members on the page, such as displaying notifications when a group member's role changes.
Triggered when：After group member information changes, users in the group will trigger this notification.
Related APIs：[setGroupMemberNickname] updates group member nickname; [setGroupMemberRole] updates group member role; [transferGroupOwner] transfers group ownership.

onGroupApplicationListChanged

onGroupApplicationListChanged(zim: ZIM, result: ZIMGroupApplicationListChangedEventResult): void

Event callback when the group application list changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupApplicationListChangedEventResult	Group application list change event result.

Details

This callback is triggered when the group join application list changes.

Related APIs：[sendGroupJoinApplication], [sendGroupInviteApplications].

Available since：2.15.0 and above.

onGroupApplicationUpdated

onGroupApplicationUpdated(zim: ZIM, result: ZIMGroupApplicationUpdatedEventResult): void

Event callback when the group application information changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMGroupApplicationUpdatedEventResult	Group application information change event result.

Details

This callback is triggered when the group join application list information changes.

Related APIs：[acceptGroupJoinApplication], [rejectGroupJoinApplication], [acceptGroupInviteApplication], [rejectGroupInviteApplication].

Available since：2.15.0 and above.

onCallInvitationCreated

onCallInvitationCreated(zim: ZIM, result: ZIMCallInvitationCreatedEventResult): void

Event callback when the call invitation is created.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCallInvitationCreatedEventResult	Call invitation creation event result.

Details

After the inviter initiates a call invitation and the inviter is online, this callback will be received.

Triggered when：If the inviter has multiple online devices, all multi-device devices of the current user will trigger this callback after the inviter sends the call invitation.
Related APIs：[callInvite].

Available since：2.13.0 and above.

onCallInvitationReceived

onCallInvitationReceived(zim: ZIM, result: ZIMCallInvitationReceivedEventResult): void

Event callback when the call invitation is received.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCallInvitationReceivedEventResult	Call invitation reception event result.

Use cases：The invitee will call this callback after the inviter sends a call invitation.
Triggered when：After creating a ZIM instance through [create].
Caution：If the user is not in the invitation list or not online, this callback will not be called.
Related APIs：[callInvite].

Available since：2.0.0 and above.

onCallInvitationCancelled

onCallInvitationCancelled(zim: ZIM, result: ZIMCallInvitationCancelledEventResult): void

Event callback when the call invitation is cancelled.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCallInvitationCancelledEventResult	Call invitation cancellation event result.

Use cases：The invitee will call this callback after the inviter cancels the call invitation.
Triggered when：After creating a ZIM instance through [create].
Caution：If the user is not in the cancel invitation list or is offline, this callback will not be called.
Related APIs：[callCancel].

Available since：2.0.0 and above.

onCallInvitationEnded

onCallInvitationEnded(zim: ZIM, result: ZIMCallInvitationEndedEventResult): void

Event callback when the call invitation is ended.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCallInvitationEndedEventResult	Call invitation end event result.

Details

After an advanced mode call invitation is established and a participant ends the call, all participants will receive this callback.

Caution：If the user is not a participant who initiated this call or is not online, this callback will not be received.
Related APIs：[callEnd].

Available since：2.9.0 and above.

onCallInvitationTimeout

onCallInvitationTimeout(zim: ZIM, result: ZIMCallInvitationTimeoutEventResult): void

Event callback when the call invitation times out.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCallInvitationTimeoutEventResult	Call invitation timeout event result.

Details

When the call invitation times out, the invitee does not respond and will receive a callback.

Use cases：If the invitee does not respond before the timeout period, this callback will be received.
Triggered when：After creating a ZIM instance through [create].
Caution：If the user is not on the invitation list or is not online, the callback will not be received.
Related APIs：[callInvite], [callAccept], [callReject].

Available since：2.9.0 and above.

onCallUserStateChanged

onCallUserStateChanged(zim: ZIM, result: ZIMCallUserStateChangedEventResult): void

Event callback when the call invitation user status changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCallUserStateChangedEventResult	Call invitation user status change event result.

Details

Listen for calling user status changes.

Triggered when：When a new member is invited to a call, or a member accepts, rejects, exits, or a member response times out, all users on the current call invitation whose status is "Inviting," "Accepted," and "Received" receive the callback here. If the member is not online at the time of notification, the call is still ongoing when the login succeeds. The status changes of all members during the offline period will be sent to the user at one time.
Caution：If the user is not the inviter who initiated this call invitation or is not online, the callback will not be received.
Related APIs：[callInvite], [callingInvite], [callAccept], [callReject],[callQuit].

Available since：2.9.0 and above.

onFriendListChanged

onFriendListChanged(zim: ZIM, result: ZIMFriendListChangedEventResult): void

Event callback when the friend list changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMFriendListChangedEventResult	Friend list change event result.

Details

When the friend list changes, this callback is triggered for the current user and all devices logged in by the current user.

Triggered when：This callback is triggered when the current user's friend list changes, i.e., when a friend is added, deleted, or similar events occur.
Related APIs：[addFriend], [deleteFriends].

Available since：2.14.0 and above.

onFriendInfoUpdated

onFriendInfoUpdated(zim: ZIM, result: ZIMFriendInfoUpdatedEventResult): void

Event callback when the friend information changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMFriendInfoUpdatedEventResult	Friend information change event result.

Details

This callback is triggered when friend information is updated.

Triggered when：This callback is triggered when a friend's basic information changes, such as avatar or name, or when the current user or another online device modifies a friend's alias or attributes.
Related APIs：[updateFriendAlias], [updateFriendAttributes].

Available since：2.14.0 and above.

onFriendApplicationListChanged

onFriendApplicationListChanged(zim: ZIM, result: ZIMFriendApplicationListChangedEventResult): void

Event callback when the friend application list changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMFriendApplicationListChangedEventResult	Friend application list change event result.

Details

This callback is triggered when the friend application list changes.

Triggered when：This callback is triggered when a user applies to become a friend, or when you send a friend application to a user, causing changes to the friend application list.
Related APIs：[sendFriendApplication].

Available since：2.14.0 and above.

onFriendApplicationUpdated

onFriendApplicationUpdated(zim: ZIM, result: ZIMFriendApplicationUpdatedEventResult): void

Event callback when the friend application information changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMFriendApplicationUpdatedEventResult	Friend application information change event result.

Details

This callback is triggered when the status or information of the friend application list is updated.

Triggered when：This callback is triggered when the other party accepts or rejects your friend application, or when you accept or reject the other party's friend application, causing changes to the friend application information.
Related APIs：[acceptFriendApplication], [rejectFriendApplication].

Available since：2.14.0 and above.

onBlacklistChanged

onBlacklistChanged(zim: ZIM, result: ZIMBlacklistChangedEventResult): void

Event callback when the blacklist changes.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMBlacklistChangedEventResult	Blacklist change event result.

Details

This callback is triggered when the current user's blacklist changes.

Triggered when：This callback is triggered for the current user and all online devices when the current user adds or removes a user from the blacklist.
Related APIs：[addUsersToBlacklist], [removeUsersFromBlacklist].

Available since：2.13.0 and above.

onCommunityListChanged

onCommunityListChanged(zim: ZIM, result: ZIMCommunityListChangedEventResult): void

Received notification callback for community list changed.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCommunityListChangedEventResult	The community list changed event callback result

Details

This callback is received when the current user's own community list changes, or when attributes such as the total unread count of joined communities change.

Triggered when：This callback is triggered when the current user joins a new community, leaves a joined community, or when the total unread count of a joined community changes.
Use cases：Used to display the list of communities the current user has joined in the UI and subsequent changes.
Caution：Only communities that you have joined will trigger this callback notification. Communities you have not joined will not trigger this callback.
Related APIs：[createCommunity], [joinCommunity], [leaveCommunity], [dismissCommunity].

Available since：3.0.0 and above.

onCommunityInfoUpdated

onCommunityInfoUpdated(zim: ZIM, result: ZIMCommunityInfoUpdatedEventResult): void

Received notification callback for community info updated.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCommunityInfoUpdatedEventResult	The community info list updated event callback result

Details

This callback is received when the current community information changes.

Triggered when：When the current community information changes, such as when the community name, avatar, notice, or other attributes are modified by the community owner or administrator, community members will trigger this callback.
Use cases：Used to display the latest community attribute data in the UI.
Caution：Due to the large scale of community membership, when community attributes change, push notifications are only sent to users who have recently called [queryCommunityInfo]. Users who do not receive the push notification can also obtain the latest community attributes via [queryCommunityInfo].
Related APIs：[updateCommunityName], [updateCommunityAvatarUrl], [updateCommunityNotice], [setCommunityAttributes], [deleteCommunityAttributes].

Available since：3.0.0 and above.

onCommunityMemberStateChanged

onCommunityMemberStateChanged(zim: ZIM, result: ZIMCommunityMemberStateChangedEventResult): void

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCommunityMemberStateChangedEventResult	The community member state change event callback result

Details

This callback is received when the status of members in the community changes.

Triggered when：This callback is triggered when events that change the community member status occur, such as a community member joining or leaving.
Caution：Due to the large scale of community membership, when a community member's status changes, push notifications are only sent to users who have recently called [queryCommunityInfo]. Users who do not receive the push notification can also obtain the latest community member list via [queryCommunityMemberList].
Related APIs：[joinCommunity], [leaveCommunity], [inviteUsersIntoCommunity], [kickCommunityMembers].

Available since：3.0.0 and above.

onCommunityMemberInfoUpdated

onCommunityMemberInfoUpdated(zim: ZIM, result: ZIMCommunityMemberInfoUpdatedEventResult): void

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCommunityMemberInfoUpdatedEventResult	The community member state change event callback result

Details

This callback is received when member information in the community changes.

Triggered when：This callback is triggered when a community member's role changes, when a community member is muted or unmuted, or when their basic user information changes.
Caution：Due to the large scale of community membership, when a community member's status changes, push notifications are only sent to users who have recently called [queryCommunityInfo]. Users who do not receive the push notification can also obtain the latest community member information via [queryCommunityMembers].
Related APIs：[updateCommunityMemberRole], [muteCommunityMembers].

Available since：3.0.0 and above.

onCommunityChannelListChanged

onCommunityChannelListChanged(zim: ZIM, result: ZIMCommunityChannelListChangedEventResult): void

Received notification callback for community channel list changed.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCommunityChannelListChangedEventResult	The community channel list changed event callback result

Details

This callback is received when the community channel list changes or when attributes within a channel change.

Triggered when：This callback is triggered when a channel in the community is created or deleted, or when messages are produced in a channel (similar to conversation-related operations).
Use cases：Used by developers to render the user chat activity in community channels in real time.
Related APIs：[sendMessage], [createCommunityChannel], [dismissCommunityChannel], [clearConversationUnreadMessageCount], etc.

Available since：3.0.0 and above.

onCommunityChannelInfoUpdated

onCommunityChannelInfoUpdated(zim: ZIM, result: ZIMCommunityChannelInfoUpdatedEventResult): void

Received notification callback for community info updated.

Parameters

Name	Type	Description
zim	ZIM	ZIM instance.
result	ZIMCommunityChannelInfoUpdatedEventResult	The community channel info list updated event callback result

Details

This callback is received when the attributes of a channel in the community change.

Triggered when：When the community channel name, channel notice, channel attributes, channel mute, or other attributes are changed by the community owner or administrator, active users in the channel will trigger this callback.
Caution：Due to the large scale of community membership, ZIM filters active users based on each user's API call behavior to push channel information change notifications. Users who do not receive the push notification can also obtain the latest community channel information via [queryCommunityChannelsInfo].
Related APIs：[updateCommunityChannelName], [updateCommunityChannelAvatarUrl], [updateCommunityChannelNotice], [setCommunityChannelAttributes], [deleteCommunityChannelAttributes].

Available since：3.0.0 and above.