import { ZIMAppConfig, ZIMBlacklistCheckedResult, ZIMBlacklistQueriedResult, ZIMBlacklistQueryConfig, ZIMBlacklistUsersAddedResult, ZIMBlacklistUsersRemovedResult, ZIMCallAcceptanceSentResult, ZIMCallAcceptConfig, ZIMCallCancelConfig, ZIMCallCancelSentResult, ZIMCallEndConfig, ZIMCallEndSentResult, ZIMCallingInvitationSentResult, ZIMCallingInviteConfig, ZIMCallInvitationListQueriedResult, ZIMCallInvitationQueryConfig, ZIMCallInvitationSentResult, ZIMCallInviteConfig, ZIMCallJoinConfig, ZIMCallJoinSentResult, ZIMCallQuitConfig, ZIMCallQuitSentResult, ZIMCallRejectConfig, ZIMCallRejectionSentResult, ZIMCombineMessage, ZIMCombineMessageDetailQueriedResult, ZIMCommunityAttributesOperatedResult, ZIMCommunityAvatarUrlUpdatedResult, ZIMCommunityChannelAttributesOperatedResult, ZIMCommunityChannelAvatarUrlUpdatedResult, ZIMCommunityChannelCreateConfig, ZIMCommunityChannelCreatedResult, ZIMCommunityChannelDismissedResult, ZIMCommunityChannelInfo, ZIMCommunityChannelListQueriedResult, ZIMCommunityChannelListQueryConfig, ZIMCommunityChannelMuteConfig, ZIMCommunityChannelNameUpdatedResult, ZIMCommunityChannelNoticeUpdatedResult, ZIMCommunityChannelsInfoQueriedResult, ZIMCommunityChannelsMutedResult, ZIMCommunityCreateConfig, ZIMCommunityCreatedResult, ZIMCommunityDismissedResult, ZIMCommunityInfo, ZIMCommunityInfoQueriedResult, ZIMCommunityJoinedResult, ZIMCommunityLeftResult, ZIMCommunityListQueriedResult, ZIMCommunityListQueryConfig, ZIMCommunityMemberListQueriedResult, ZIMCommunityMemberListQueryConfig, ZIMCommunityMemberMuteConfig, ZIMCommunityMemberRoleUpdatedResult, ZIMCommunityMembersKickedResult, ZIMCommunityMembersMutedResult, ZIMCommunityMembersQueriedResult, ZIMCommunityMessageNotificationStatus, ZIMCommunityNameUpdatedResult, ZIMCommunityNoticeUpdatedResult, ZIMCommunityNotificationStatusSetResult, ZIMCommunityOwnerTransferredResult, ZIMCommunityUsersInvitedResult, ZIMConversationBaseInfo, ZIMConversationDeleteConfig, ZIMConversationDeletedResult, ZIMConversationDraftSetResult, ZIMConversationFilterOption, ZIMConversationListQueriedResult, ZIMConversationMarkSetResult, ZIMConversationMessageReceiptReadSentResult, ZIMConversationNotificationStatus, ZIMConversationNotificationStatusSetResult, ZIMConversationPinnedListQueriedResult, ZIMConversationPinnedStateUpdatedResult, ZIMConversationQueriedResult, ZIMConversationQueryConfig, ZIMConversationSearchConfig, ZIMConversationsSearchedResult, ZIMConversationTotalUnreadMessageCountQueriedResult, ZIMConversationTotalUnreadMessageCountQueryConfig, ZIMConversationType, ZIMConversationUnreadMessageCountClearedResult, ZIMFriendAddConfig, ZIMFriendAddedResult, ZIMFriendAliasUpdatedResult, ZIMFriendApplicationAcceptConfig, ZIMFriendApplicationAcceptedResult, ZIMFriendApplicationListQueriedResult, ZIMFriendApplicationListQueryConfig, ZIMFriendApplicationRejectConfig, ZIMFriendApplicationRejectedResult, ZIMFriendApplicationSendConfig, ZIMFriendApplicationSentResult, ZIMFriendAttributesUpdatedResult, ZIMFriendDeleteConfig, ZIMFriendListQueriedResult, ZIMFriendListQueryConfig, ZIMFriendRelationCheckConfig, ZIMFriendsDeletedResult, ZIMFriendSearchConfig, ZIMFriendsInfoQueriedResult, ZIMFriendsRelationCheckedResult, ZIMFriendsSearchedResult, ZIMGeofencingType, ZIMGroupAdvancedConfig, ZIMGroupAliasUpdatedResult, ZIMGroupApplicationListQueriedResult, ZIMGroupApplicationListQueryConfig, ZIMGroupAttributesOperatedResult, ZIMGroupAttributesQueriedResult, ZIMGroupAvatarUrlUpdatedResult, ZIMGroupBeInviteMode, ZIMGroupBeInviteModeUpdatedResult, ZIMGroupCreatedResult, ZIMGroupDismissedResult, ZIMGroupInfo, ZIMGroupInfoQueriedResult, ZIMGroupInviteApplicationAcceptConfig, ZIMGroupInviteApplicationAcceptedResult, ZIMGroupInviteApplicationRejectConfig, ZIMGroupInviteApplicationRejectedResult, ZIMGroupInviteApplicationSendConfig, ZIMGroupInviteApplicationsSentResult, ZIMGroupInviteMode, ZIMGroupInviteModeUpdatedResult, ZIMGroupJoinApplicationAcceptConfig, ZIMGroupJoinApplicationAcceptedResult, ZIMGroupJoinApplicationRejectConfig, ZIMGroupJoinApplicationRejectedResult, ZIMGroupJoinApplicationSendConfig, ZIMGroupJoinApplicationSentResult, ZIMGroupJoinedResult, ZIMGroupJoinMode, ZIMGroupJoinModeUpdatedResult, ZIMGroupLeftResult, ZIMGroupListQueriedResult, ZIMGroupListQueryConfig, ZIMGroupMemberCountQueriedResult, ZIMGroupMemberInfoQueriedResult, ZIMGroupMemberKickedResult, ZIMGroupMemberListQueriedResult, ZIMGroupMemberMuteConfig, ZIMGroupMemberMutedListQueriedResult, ZIMGroupMemberNicknameUpdatedResult, ZIMGroupMemberQueryConfig, ZIMGroupMemberRoleUpdatedResult, ZIMGroupMemberSearchConfig, ZIMGroupMembersMutedResult, ZIMGroupMembersSearchedResult, ZIMGroupMessageReceiptMemberListQueriedResult, ZIMGroupMessageReceiptMemberQueryConfig, ZIMGroupMuteConfig, ZIMGroupMutedResult, ZIMGroupNameUpdatedResult, ZIMGroupNoticeUpdatedResult, ZIMGroupOwnerTransferredResult, ZIMGroupSearchConfig, ZIMGroupsSearchedResult, ZIMGroupUsersInvitedResult, ZIMLogConfig, ZIMLoginConfig, ZIMLogoutConfig, ZIMMessage, ZIMMessageDeleteConfig, ZIMMessageDeletedResult, ZIMMessageEditConfig, ZIMMessageEditedResult, ZIMMessageInsertedResult, ZIMMessageLocalExtendedDataUpdatedResult, ZIMMessagePinConfig, ZIMMessageQueriedResult, ZIMMessageQueryConfig, ZIMMessageReactionAddConfig, ZIMMessageReactionAddedResult, ZIMMessageReactionDeletedResult, ZIMMessageReactionUserListQueriedResult, ZIMMessageReactionUserQueryConfig, ZIMMessageReceiptsInfoQueriedResult, ZIMMessageReceiptsReadSentResult, ZIMMessageRepliedListQueriedResult, ZIMMessageRepliedListQueryConfig, ZIMMessageRevokeConfig, ZIMMessageRevokedResult, ZIMMessageSearchConfig, ZIMMessageSendConfig, ZIMMessageSendNotification, ZIMMessageSentResult, ZIMMessagesGlobalSearchedResult, ZIMMessagesSearchedResult, ZIMPinnedMessageListQueriedResult, ZIMRoomAdvancedConfig, ZIMRoomAllLeftResult, ZIMRoomAttributesBatchOperatedResult, ZIMRoomAttributesBatchOperationConfig, ZIMRoomAttributesDeleteConfig, ZIMRoomAttributesOperatedResult, ZIMRoomAttributesQueriedResult, ZIMRoomAttributesSetConfig, ZIMRoomCreatedResult, ZIMRoomEnteredResult, ZIMRoomInfo, ZIMRoomJoinedResult, ZIMRoomLeftResult, ZIMRoomMemberAttributesListQueriedResult, ZIMRoomMemberAttributesQueryConfig, ZIMRoomMemberAttributesSetConfig, ZIMRoomMemberQueriedResult, ZIMRoomMemberQueryConfig, ZIMRoomMembersAttributesOperatedResult, ZIMRoomMembersAttributesQueriedResult, ZIMRoomMembersQueriedResult, ZIMRoomOnlineMemberCountQueriedResult, ZIMRoomSwitchedResult, ZIMSelfUserInfoQueriedResult, ZIMSendingMessageCancelConfig, ZIMSubscribedUserStatusListQueriedResult, ZIMSubscribedUserStatusQueryConfig, ZIMTokenRenewedResult, ZIMUserAvatarUrlUpdatedResult, ZIMUserCustomStatusUpdateConfig, ZIMUserCustomStatusUpdatedResult, ZIMUserExtendedDataUpdatedResult, ZIMUserNameUpdatedResult, ZIMUserOfflinePushRule, ZIMUserOfflinePushRuleUpdatedResult, ZIMUsersInfoQueriedResult, ZIMUsersInfoQueryConfig, ZIMUsersStatusQueriedResult, ZIMUsersStatusSubscribedResult, ZIMUsersStatusUnsubscribedResult, ZIMUserStatusSubscribeConfig } from './ZIMDefines'; import { ZIMEventHandler } from './ZIMEventHandler'; export declare abstract class ZIM { /** * Gets the SDK's version number. * * Available since: 1.1.0. * Description: Get the SDK version. * Use cases: * 1. When the SDK is running, the developer finds that it does not match the expected situation and submits the problem and related logs to the ZEGO technical staff for locating. The ZEGO technical staff may need the information of the engine version to assist in locating the problem. * 2. Developers can also collect this information as the version information of the engine used by the app, so that the SDK corresponding to each version of the app on the line. * When to call: It can be called at any time. */ static getVersion(): string; /** * Create a ZIM instance. * * Available since: 2.3.0 and above. * Description: 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. * Restrictions: Currently only one instance is supported, repeated calls will return [null]. * Caution: * 1. Currently, the [create] function can only create one instance at most. If it is called multiple times, only the first one will return a valid instance, and the rest will be [null]. The developer should save the ZIM instance by himself, and ensure that the life cycle of the instance is available in the process of using the ZIM business function; or after calling [create], he can use [getInstance] to obtain its singleton object and call other member functions. * 2. If you use this function to create an instance, you must pass in both AppID and AppSign (exclude Web platform). * Scope of impact: Failure to call this function will prevent other member functions from being called. * Platform differences: When calling this function on the Android platform, in addition to the appID, the Application class object must also be passed in. * * @param appConfig ZIMAppConfig */ static create(appConfig: ZIMAppConfig): ZIM | null; /** * Get the ZIM singleton object. * * Available since: 2.3.0 and above. * Description: 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]. */ static getInstance(): ZIM | null; /** * Set ZIM advanced configuration. * * 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]. * * @param key Configuration Key * @param value Configuration value */ static setAdvancedConfig(key: string, value: string): void; /** * Set geofence-related configurations. * * Available since: 2.12.0 and above. * Description: 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. * Restrictions: If you need to use this function, please contact ZEGO technical support. * 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. * * @param areaList Geofencing area list * @param type Geofencing type */ static setGeofencingConfig(areaList: number[], type: ZIMGeofencingType): boolean; /** * Set log related configuration. * * Available since: 1.1.0 and above. * Description: 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. * * @param config Custom log configuration */ abstract setLogConfig(config: ZIMLogConfig): void; /** * Destroy the ZIM instance. * * Available since: 1.1.0 and above. * Description: 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. */ abstract destroy(): 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. * * Available since: 1.1.0 and above. * Description: 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. * * @param type Event type * @param listener Event callback */ abstract on(type: K, listener: ZIMEventHandler[K]): void; /** * Remove event notification callback. * * Available since: 1.1.0 and above. * Description: 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. * * @param type Event type */ abstract off(type: K): void; /** * Upload log and call after setting up log path. * * Available since: 1.2.0 and above. * Description: 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. * Restrictions: If this interface is invoked repeatedly within 10 minutes, only the last invocation takes effect. * Caution: If you call [destory] 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 [destory] or exit the App after receiving the callback for successful upload. * Related callbacks: Developers can get the upload results through the callback parameter. */ abstract uploadLog(): Promise; /** * Login, you must log in before using all functions. * * Available since: 2.13.0 and above. * Description: 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). * * @param userID Used to identify user information, the unique ID of the user. * @param config Various parameters used for specific login actions. */ abstract login(userID: string, config: ZIMLoginConfig): Promise; /** * Logout parameter configuration. * * Available since: 1.1.0 or above. * Description: 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]. */ abstract logout(config?: ZIMLogoutConfig): void; /** * Update the authentication token. * * Available since: 1.1.0 or above. * Description: 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. * * @param token The token issued by the developer's business server, used to ensure security. The generation rules are detailed in ZEGO document website. */ abstract renewToken(token: string): Promise; /** * Call the experimental API. * * 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. * * @param params Parameters in the format of a JSON string, please consult ZEGO technical support for details. */ abstract callExperimentalAPI(params: string): Promise; /** * Update user's user name. * * Available since: 2.2.0 or above. * Description: 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]. * * @param userName User name , It is customized by the developer. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes. */ abstract updateUserName(userName: string): Promise; /** * Update user's avatar URL. * * Available since: 2.3.0 and above. * Description: 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. * Restrictions: There is no limit on special characters and a maximum of 500 bytes. * Related callbacks: [ZIMUserAvatarUrlUpdatedCallback]. * Related APIs: [queryUsersInfo]. * * @param userAvatarUrl User avatar URL wanted to changed to. */ abstract updateUserAvatarUrl(userAvatarUrl: string): Promise; /** * Update user's user extended data. * * Available since: 2.2.0 or above. * Description: 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: [ onUserNameUpdatedCallback ]. * Related APIs: [updateUserName] and [ queryUsersInfo ]. * * @param extendedData User extended data wanted to changed to . */ abstract updateUserExtendedData(extendedData: string): Promise; /** * Update user's custom rule of offline push. * * Available since: 2.15.0 and later versions. * Description: 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 * * @param offlinePushRule 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. */ abstract updateUserOfflinePushRule(offlinePushRule: ZIMUserOfflinePushRule): Promise; /** * Update user's 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. * * @param customStatus User custom status. * @param config Config of user custom status. */ abstract updateUserCustomStatus(customStatus: string, config?: ZIMUserCustomStatusUpdateConfig): Promise; /** * Update the number of iOS offline notification badges. * * Available since: 2.28.0 or above. * Description: 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]. * * @param badge The user’s expected APP badge value. */ abstract updateUserBadge(badge: number): Promise; /** * Query user information. * * Available since: 2.3.0 or above. * Description: 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]. * 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. * * @param userIDs userID list. * @param config Query user information configuration. */ abstract queryUsersInfo(userIDs: string[], config: ZIMUsersInfoQueryConfig): Promise; /** * Query the user statuses of other users. * * Available since: 2.18.0 * Description: 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. * * @param userIDs User ID list. */ abstract queryUsersStatus(userIDs: string[]): Promise; /** * Query user information and user rules. * * Available since: 2.15.0 . * Description: 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. * Restrictions: ZIMSelfUserInfoQueriedCallback、userInfoUpdated、userRuleUpdated */ abstract querySelfUserInfo(): Promise; /** * Subscribe to the user status of other users * * Available since: 2.18.0 * Description: 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. * 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. * 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] * * @param userIDs User ID list. * @param config Configuration for subscribing to user status. */ abstract subscribeUsersStatus(userIDs: string[], config: ZIMUserStatusSubscribeConfig): Promise; /** * This command is used to batch unsubscribe the target users in the current user subscription list. * * Available since: 2.18.0 * Description: 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. * Restrictions: The maximum number of userids passed in at a time is 100. * Caution: You cannot cancel a user that is not in the current user subscription list. * Related callbacks: ZIMUsersStatusUnsubscribedCallback. * Related APIs: subscribeUsersStatus、queryUsersStatus、querySubscribedUserStatusList. * * @param userIDs User ID list. */ abstract unsubscribeUsersStatus(userIDs: string[]): Promise; /** * This command is used to query the user status subscription list of the current user. * * Available since: 2.18.0 * Description: 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. * 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. * Related callbacks: ZIMSubscribedUserStatusListQueriedCallback、subscribeUsersStatus、unsubscribeUsersStatus. * Related APIs: subscribeUsersStatus、unsubscribeUsersStatus. * * @param config Configuration for querying subscribed user status list. */ abstract querySubscribedUserStatusList(config: ZIMSubscribedUserStatusQueryConfig): Promise; /** * Query the conversation list. * * 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. * * @param config Configuration for session queries. * @param option Filter options for session queries. */ abstract queryConversationList(config: ZIMConversationQueryConfig, option?: ZIMConversationFilterOption): Promise; /** * Query a conversation by conversation ID and conversation type. * * Available since: 2.8.0 and above. * Description: 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. * Restrictions: There is no limit to the frequency of use, available after login, unavailable after logout. * Related callbacks: [ZIMConversationQueriedCallback]. * * @param conversationID Conversation ID. * @param conversationType Conversation type. */ abstract queryConversation(conversationID: string, conversationType: ZIMConversationType): Promise; /** * Query the conversation pinned list. * * Available since: 2.8.0 and above. * Description: 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. * Restrictions: There is no limit to the frequency of use, available after login, unavailable after logout. * 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. * * @param config Configuration for session queries. */ abstract queryConversationPinnedList(config: ZIMConversationQueryConfig): Promise; /** * Modify the conversation pinned state. * * Available since: 2.8.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * Related callbacks: [ZIMConversationPinnedStateUpdatedCallback]. * * @param isPinned Whether the conversation is pinned, true is pinned, false is unpinned. * @param conversationID Conversation ID. * @param conversationType Conversation type. */ abstract updateConversationPinnedState(isPinned: boolean, conversationID: string, conversationType: ZIMConversationType): Promise; /** * delete the conversation. * * Available since: 2.0.0 and above. * Description: 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] * * @param conversationID conversationID. * @param conversationType conversationtype. * @param config delete the session's configuration. */ abstract deleteConversation(conversationID: string, conversationType: ZIMConversationType, config: ZIMConversationDeleteConfig): Promise; /** * delete all conversations. * * Available since: 2.12.0 and above. * Description: 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] * * @param config delete all conversation's configuration. */ abstract deleteAllConversations(config: ZIMConversationDeleteConfig): Promise; /** * clear session unreads. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Valid after login, invalid after logout. * Scope of impact: Calling this method will trigger a total readings not updated callback [conversationTotalUnreadMessageCountUpdated], would trigger a session to update callbacks [conversationChanged]. * Related callbacks: [ZIMConversationUnreadMessageCountClearedCallback]. * Related APIs: [conversationTotalUnreadMessageCountUpdated]、[conversationChanged]. * * @param conversationID conversationID. * @param conversationType conversation type. */ abstract clearConversationUnreadMessageCount(conversationID: string, conversationType: ZIMConversationType): Promise; /** * clear all conversations unreads. * * Available since: 2.12.0 and above. * Description: 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. * Restrictions: Valid after login, invalid after logout. * Scope of impact: Calling this method will trigger a total readings not updated callback [onConversationTotalUnreadMessageCountUpdated]. * Related callbacks: [ZIMConversationTotalUnreadMessageCountClearedCallback]. * Related APIs: [onConversationTotalUnreadMessageCountUpdated]. */ abstract clearConversationTotalUnreadMessageCount(): Promise; /** * Query the conversations total unread message count by config. * * Available since: 2.17.0 and above. * Description: 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. * Restrictions: There is no limit on the frequency of use; it is available after logging in and not available after logging out. * Related callbacks: [ZIMConversationTotalUnreadMessageCountQueriedCallback]. * * @param config Configuration for querying the total unread count of the conversation. */ abstract queryConversationTotalUnreadMessageCount(config: ZIMConversationTotalUnreadMessageCountQueryConfig): Promise; /** * Set the conversation notification state. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Valid after login, invalid after logout. * Scope of impact: After the DND state is enabled, receiving messages is not triggered [conversationTotalUnreadMessageCountUpdated]。 * Related callbacks: [ZIMConversationNotificationStatusSetCallback]。 * Related APIs: [conversationTotalUnreadMessageCountUpdated]。 * * @param status the session notification state. * @param conversationID Conversation ID. Currently, only "group" conversations and "peer"(only for 2.14.0 or above version) conversations can be set by notification state. * @param conversationType Conversation type, such as peer, group, etc. */ abstract setConversationNotificationStatus(status: ZIMConversationNotificationStatus, conversationID: string, conversationType: ZIMConversationType): Promise; /** * Sets all received receipts for the conversation as read. * * Available since: 2.5.0 and above. * Description: 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]. * * @param conversationID Conversation ID. * @param conversationType Conversation type, such as peer, group, etc. */ abstract sendConversationMessageReceiptRead(conversationID: string, conversationType: ZIMConversationType): Promise; /** * Set a conversation draft. * * Available since: 2.14.0 and above. * Description: 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] * * @param draft Drafts that need to be set. * @param conversationID Conversation ID. * @param conversationType Conversation type, such as peer, group, etc. */ abstract setConversationDraft(draft: string, conversationID: string, conversationType: ZIMConversationType): Promise; /** * Set the conversation marked status. * * Available since: 2.17.0 and above. * Description: 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. * Restrictions: The range for setting marks is [1, 20]. A maximum of 100 conversations are supported for marking at one time. * Related callbacks: [ZIMConversationMarkSetCallback]。 * * @param markType Mark value that needs to be set. * @param enable Whether to enable the mark value. * @param conversationInfos Conversation information list that needs to be set. */ abstract setConversationMark(markType: number, enable: boolean, conversationInfos: ZIMConversationBaseInfo[]): Promise; /** * Search local conversations on local messages. * * Available since: 2.9.0 and above. * Description: 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. * Restrictions: effective after logging in and becomes invalid after logging out. Searching is not supported in room scenarios (conversationType=1). * Related callbacks: [ZIMConversationsSearchedCallback]. * * @param config Global search conversation config. */ abstract searchLocalConversations(config: ZIMConversationSearchConfig): Promise; /** * send message. * * Available since: 2.4.0 and above. * Description: 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. * Restrictions: The interval between sending messages should be greater than 100ms. Available after login, unavailable after logout. * Related callbacks: [ZIMMessageSentCallback], [ZIMMessageSendNotification], [onReceivePeerMessage], [onReceiveRoomMessage], [onReceiveGroupMessage], [onConversationChanged], [onConversationTotalUnreadMessageCountUpdated]. * Related APIs: [queryHistoryMessage], [deleteAllMessage], [deleteMessages],[sendMediaMessage]. * * @param message The message to be sent. * @param toConversationID The conversation ID the message needs to be sent. * @param conversationType The conversation type the message needs to be sent. * @param config Related configuration for sending messages. * @param notification Related notifications when messages are sent. */ abstract sendMessage(message: ZIMMessage, toConversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSendConfig, notification?: ZIMMessageSendNotification): Promise; /** * Query historical messages. * * Available since: 2.0.0 and above. * Description: 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. * 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. * Related callbacks: [ZIMMessageQueriedCallback]. * * @param conversationID The session ID of the queried historical message. * @param conversationType conversation type. * @param config Query the configuration of historical messages. */ abstract queryHistoryMessage(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageQueryConfig): Promise; /** * Query messages based on the message seq list. * * Available since: 2.19.0 and above. * * @param messageSeqs The list of message sequence numbers to query. * @param conversationID The session ID of the queried message. * @param conversationType conversation type. */ abstract queryMessages(messageSeqs: number[], conversationID: string, conversationType: ZIMConversationType): Promise; /** * delete message. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Effective after login. * 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]. * * @param messageList List of deleted messages. * @param conversationID The session ID of the deleted message. * @param conversationType conversation type. * @param config Delete the configuration of the message. */ abstract deleteMessages(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageDeleteConfig): Promise; /** * Delete all message. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Effective after login, invalid after logout. * 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]. * * @param conversationID The session ID of the message to be deleted. * @param conversationType conversation type. * @param config delete message configuration. */ abstract deleteAllMessage(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageDeleteConfig): Promise; /** * Delete all messages for all conversations. * * Available since: 2.14.0 and above. * Description: 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. * Restrictions: Effective after login. * 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]. * * @param config delete message configuration. */ abstract deleteAllConversationMessages(config: ZIMMessageDeleteConfig): Promise; /** * Insert a message to the local DB. * * Available since: 2.4.0 and above. * Description: 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]. * * @param message The message to be sent. * @param conversationID Conversation ID. * @param conversationType Conversation type. * @param senderUserID The sender ID of this message. */ abstract insertMessageToLocalDB(message: ZIMMessage, conversationID: string, conversationType: ZIMConversationType, senderUserID: string): Promise; /** * Set the receipt of a batch of messages to become read. * * Available since: 2.5.0 and above. * Description: 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]. * Restrictions: Only support the settings for received messages with receipt status as PROCESSING. * Related callbacks: [ZIMMessageReceiptsReadSentCallback]. * Related APIs: [sendMessage]. * * @param messageList The list of messages to be read with no more than 10 messages. * @param conversationID Conversation ID. * @param conversationType Conversation type. */ abstract sendMessageReceiptsRead(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): Promise; /** * Query the receipt information of a batch of messages. * * Available since: 2.5.0 and above. * Description: 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]. * Restrictions: Only messages whose statuses are not NONE and UNKNOWN are supported. * Related callbacks: [ZIMMessageReceiptsInfoQueriedCallback]. * Related APIs: [queryGroupMessageReceiptReadMemberList] , [queryGroupMessageReceiptUnreadMemberList]. * * @param messageList list of messages to query. * @param conversationID Conversation ID. * @param conversationType Conversation type. */ abstract queryMessageReceiptsInfo(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): Promise; /** * revoke message. * * Available since: 2.5.0 and above. * Description: 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. * 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. * Related callbacks: If the revoked message is the latest message of the session, the [conversationChanged] callback will be triggered, and if the message is unread, the [conversationTotalUnreadMessageCountUpdated] callback will be triggered. * * @param message The message needs to be revoke. * @param config Revoke the configuration of the message. */ abstract revokeMessage(message: ZIMMessage, config?: ZIMMessageRevokeConfig): Promise; /** * Update the local expandable field of the message. * * Available since: 2.2.0 or above. * Description: 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 ]. * * @param localExtendedData 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. * @param message Message body to be updated */ abstract updateMessageLocalExtendedData(localExtendedData: string, message: ZIMMessage): Promise; /** * Edit message. * * Available since: 2.20.0 and above. * Description: 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], [ZIMMessageEditedResult], [messageEdited], [conversationChanged], [messageRepliedInfoChanged]. * Related APIs: [queryHistoryMessage], [sendMessage]. * * @param message The message needs to be edited. * @param config Edit the configuration of the message. * @param notification Message send notification object (optional). */ abstract editMessage(message: ZIMMessage, config: ZIMMessageEditConfig, notification?: ZIMMessageSendNotification): Promise; /** * Cancels sending of media message. * * Available since: 2.22.0 and above. * Description: This method can be used to cancel the sending of a local media file upload message. * Related APIs: [queryHistoryMessage], [sendMessage]. * * @param message The message needs to be cancelled to be sent. * @param config The configuration of cancelling to be sent message. */ abstract cancelSendingMessage(message: ZIMMessage, config: ZIMSendingMessageCancelConfig): Promise; /** * Search local message list. * * Available since: 2.9.0 and above. * Description: 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. * Restrictions: Effective after login, invalid after logout. Searching is not supported in the room scene (conversationType=1). * Related callbacks: [ZIMMessagesSearchedCallback]. * * @param conversationID The conversation ID of the local message to be search. * @param conversationType conversation type. * @param config Search the configuration of local messages. */ abstract searchLocalMessages(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSearchConfig): Promise; /** * Search global local message list. * * Available since: 2.9.0 and above. * Description: 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. * Restrictions: Effective after login, invalid after logout. Searching global is not supported in the room scene (conversationType=1). * Related callbacks: [ZIMMessagesGlobalSearchedCallback]. * * @param config Search global the configuration of local messages. */ abstract searchGlobalLocalMessages(config: ZIMMessageSearchConfig): Promise; /** * add message reaction * * Available since: 2.28.0 and above. * Description: 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. * Restrictions: You can only use it after logging in. And only supports message reactions for single chat and group chat * 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. * * @param reactionType Type of reaction, defined by you, with a maximum length of 32 bytes. * @param message The message needs reaction. * @param config Added configuration for reactions. It now supports reacting multiple times to the same item and increases the aggregated count accordingly. */ abstract addMessageReaction(reactionType: string, message: ZIMMessage, config?: ZIMMessageReactionAddConfig): Promise; /** * delete message reaction * * Available since: 2.10.0 and above. * Description: 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. * Restrictions: You can only use it after logging in. And only supports message statements for single chat and group chat * 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. * * @param reactionType Reaction type. It must be the type of reaction made by the local user. * @param message The message needs reaction delete. */ abstract deleteMessageReaction(reactionType: string, message: ZIMMessage): Promise; /** * Delete all of your reactions under this message * * Available since: 2.28.0 and above. * Description: 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. * Restrictions: You can only use it after logging in. And only supports message statements for single chat and group chat * 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. * * @param message The message needs reaction delete. */ abstract deleteMessageAllReactions(message: ZIMMessage): Promise; /** * query message reaction userlist * * Available since: 2.10.0 and above. * Description: 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. * Restrictions: You can only use it after logging in. And only supports message statements for single chat and group chat * * @param message The message needs querying reaction user list. * @param config reaction user query config. */ abstract queryMessageReactionUserList(message: ZIMMessage, config: ZIMMessageReactionUserQueryConfig): Promise; /** * query combine message detail * * Available since: 2.14.0 and above. * Description: 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. * Restrictions: You can only use it after logging in. * * @param message The combine message needs querying message list. */ abstract queryCombineMessageDetail(message: ZIMCombineMessage): Promise; /** * send reply message. * * Available since: 2.17.0 and above. * Description: 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. * Restrictions: The interval between sending messages should be greater than 100ms. Available after login, unavailable after logout. * Related callbacks: [onReceivePeerMessage], [onReceiveGroupMessage]. * Related APIs: [queryHistoryMessage], [sendMessage], [sendMediaMessage]. * * @param message The message needs to be sent. * @param toOriginalMessage The message needs to be replied. * @param config The configuration of the message needs to be sent. * @param notification The notification of the message needs to be sent. */ abstract replyMessage(message: ZIMMessage, toOriginalMessage: ZIMMessage, config: ZIMMessageSendConfig, notification?: ZIMMessageSendNotification): Promise; /** * Query message replied list. * * Available since: 2.17.0 and above. * Description: 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. * * @param message The message needs to be queried replied list. * @param config The configuration of the message needs to be queried replied list. */ abstract queryMessageRepliedList(message: ZIMMessage, config: ZIMMessageRepliedListQueryConfig): Promise; /** * Pin message. * * 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. * * @param message The message needs to be pinned. * @param isPinned Whether to pin. * @param config Pinning configuration parameters. */ abstract pinMessage(message: ZIMMessage, isPinned: boolean, config?: ZIMMessagePinConfig): Promise; /** * Query pinned message list. * * Available since: 2.25.0 and above. * Description: 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. * Restrictions: The SDK must be logged in and the message pinning feature must be supported to use this interface. * Related callbacks: [ZIMPinnedMessageListQueriedCallback]. * * @param conversationID Conversation ID. * @param conversationType Conversation type. */ abstract queryPinnedMessageList(conversationID: string, conversationType: ZIMConversationType): Promise; /** * Create a room with advanced settings * * Available since: 1.3.0. * Description: 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. * Restrictions: If the room already exists, calling this API will result in an error. Please refer to the returned error code for handling. * 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. * * @param roomInfo The configuration information of the room to be created. * @param config The advanced properties of the room to be created. */ abstract createRoom(roomInfo: ZIMRoomInfo, config?: ZIMRoomAdvancedConfig): Promise; /** * Join a room. * * Available since: 1.1.0 or above. * Description: 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]. * * @param roomID ID of the room to join. */ abstract joinRoom(roomID: string): Promise; /** * Enter the room. If the room does not exist, it will be created automatically. * * Available since: 2.1.0. * Description: 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 [onRoomEntered] callback. * Related APIs: You can enter the room through [enterRoom], and leave the room through [leaveRoom]. * * @param roomInfo Configuration information for the room that will be created. Only the first user who enters the room creates roomName and takes effect. * @param config Advanced properties of the room that will be created. Only the first user who enters the room is configured to take effect. */ abstract enterRoom(roomInfo: ZIMRoomInfo, config?: ZIMRoomAdvancedConfig): Promise; /** * 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. * * Available since: 2.18.0. * Description: 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: 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. * * @param fromRoomID ID of the source room to switch. * @param toRoomInfo Configuration information for the room to switch to. * @param isCreateWhenRoomNotExisted Whether to create the room if it does not exist. * @param config Advanced properties for the room to switch to. */ abstract switchRoom(fromRoomID: string, toRoomInfo: ZIMRoomInfo, isCreateWhenRoomNotExisted: boolean, config?: ZIMRoomAdvancedConfig): Promise; /** * Leave a room. * * Available since: 1.1.0 or above. * Description: 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]. * * @param roomID ID of the room to leave. */ abstract leaveRoom(roomID: string): Promise; /** * Leave all rooms entered. * * Available since: 2.15.0 or above. * Description: 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. */ abstract leaveAllRoom(): Promise; /** * Query the list of members in the room. * * Available since: 1.1.0 or above. * Description: 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]. * * @param roomID ID of the room to query. * @param config Configuration of query room member operation. */ abstract queryRoomMemberList(roomID: string, config: ZIMRoomMemberQueryConfig): Promise; /** * Query the information of the specified userID in the specified room. * * Available since: 2.8.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout, up to ten users can be queried at one time. * * @param userIDs List of user IDs to query. * @param roomID The room ID of the specified room. */ abstract queryRoomMembers(userIDs: string[], roomID: string): Promise; /** * Query the number of online members in the room. * * Available since: 1.1.0 or above. * Description: 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 [queryRoomMember]. * * @param roomID ID of the room to query. */ abstract queryRoomOnlineMemberCount(roomID: string): Promise; /** * Set room attributes (use this for all additions and changes). * * Available since: 1.3.0. * Description: 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. * Restrictions: You can set a maximum of 20 properties per room. * 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. * * @param roomAttributes Room attributes to be set. * @param roomID To modify the room number of the room attribute. * @param config Behavior configuration of the operation. */ abstract setRoomAttributes(roomAttributes: Record, roomID: string, config: ZIMRoomAttributesSetConfig): Promise; /** * Delete room attributes. * * Available since: 1.3.0. * 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. * Description: Used to delete room attributes. * * @param keys The key of the room attribute to be deleted. * @param roomID To modify the room number of the room attribute * @param config Behavior configuration of the operation. */ abstract deleteRoomAttributes(keys: string[], roomID: string, config: ZIMRoomAttributesDeleteConfig): Promise; /** * Open combination room attribute operation. * * Available since: 1.3.0. * 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. * Description: Used to turn on the combination of room attributes. * * @param roomID The number of the room where the combined operation needs to be turned on. * @param config The configuration of the combined operation. */ abstract beginRoomAttributesBatchOperation(roomID: string, config: ZIMRoomAttributesBatchOperationConfig): void; /** * Complete the property operation of the combined room. * * Available since: 1.3.0. * Description: 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]. * Restrictions: Requires that batch operations have been started in the room. * 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. * * @param roomID To modify the room number of the room attribute. */ abstract endRoomAttributesBatchOperation(roomID: string): Promise; /** * Query all properties of the room. * * Available since: 1.3.0. * 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. * Description: Used to query room attributes. * * @param roomID Need to query the room number of the custom attributes. */ abstract queryRoomAllAttributes(roomID: string): Promise; /** * Set room member attributes (use this for all additions and changes). * * Available since: 2.4.0 and above. * Description: 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. * 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. * Related callbacks: [ZIMRoomMembersAttributesOperatedCallback],[onRoomMemberAttributesUpdated]. * Related APIs: [queryRoomMembersAttributes], [queryRoomMemberAttributesList]. * * @param attributes Room member attributes to be set. * @param userIDs A list of userIDs to set. * @param roomID Room ID. * @param config Behavior configuration of the operation. */ abstract setRoomMembersAttributes(attributes: Record, userIDs: string[], roomID: string, config: ZIMRoomMemberAttributesSetConfig): Promise; /** * Batch query the room user attributes of the members in the room. * * Available since: 2.4.0 or later. * Description: 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. * Restrictions: The maximum call frequency is 5 times within 30 seconds by default, and the maximum query time is 100 people. * 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. * * @param userIDs A list of userIDs to query. * @param roomID Room ID. */ abstract queryRoomMembersAttributes(userIDs: string[], roomID: string): Promise; /** * paginate the room user properties that have room property members in the room. * * Available since: 2.4.0 or later. * Description: 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. * Restrictions: The maximum call frequency is 5 times within 30 seconds by default, and the maximum query time is 100 people. * 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. * * @param roomID Room ID. * @param config Behavior configuration of the operation. */ abstract queryRoomMemberAttributesList(roomID: string, config: ZIMRoomMemberAttributesQueryConfig): Promise; /** * Create a group with the andvanced info such as group attributes and group notice. * * Available since: 2.0.0 and above. * Description: 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. * * @param groupInfo Configuration information for the group to be created. * @param userIDs List of users invited to the group. * @param config Create the relevant configuration of the group. */ abstract createGroup(groupInfo: ZIMGroupInfo, userIDs: string[], config?: ZIMGroupAdvancedConfig): Promise; /** * Dismiss the group. * * Available since: 2.0.0 and above. * Description: 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. * * @param groupID The ID of the group to be dismissed. */ abstract dismissGroup(groupID: string): Promise; /** * Join a group. * * Available since: 2.0.0 and above. * Description: 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. * * @param groupID The group ID to join. */ abstract joinGroup(groupID: string): Promise; /** * Leave the group. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * 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. * * @param groupID The group ID to leave. */ abstract leaveGroup(groupID: string): Promise; /** * invite some members into the group. * * Available since: 2.0.0 and above. * Description: 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. * 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. * 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. * * @param userIDs The list of user IDs to invite into the group. * @param groupID The target group ID. */ abstract inviteUsersIntoGroup(userIDs: string[], groupID: string): Promise; /** * kick some members out of the group. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: You can't kick someone unless you're the leader of the group. * 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]. * * @param userIDs The list of user IDs to kick out of the group. * @param groupID The target group ID. */ abstract kickGroupMembers(userIDs: string[], groupID: string): Promise; /** * Transfer the group owner. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: You cannot transfer a group owner if you are not a group owner. * Related callbacks: Through the callback [ZIMGroupOwnerTransferredCallback] can get the result of the transfer of the group manager. * * @param toUserID The user ID of the new group owner. * @param groupID The target group ID. */ abstract transferGroupOwner(toUserID: string, groupID: string): Promise; /** * Query group information. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * Related callbacks: Through the callback [ZIMGroupInfoQueriedCallback] can query the result of the group information. * * @param groupID The group ID of the group information to be queried. */ abstract queryGroupInfo(groupID: string): Promise; /** * Query group member information. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * Related callbacks: Through the callback [ZIMGroupMemberInfoQueriedCallback] can get the query specifies the result of group membership information. * * @param userID User ID of the queried member information. * @param groupID The ID of the group whose member information will be queried. */ abstract queryGroupMemberInfo(userID: string, groupID: string): Promise; /** * Query the group list. * * Available since: 2.27.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * Related callbacks: Through the callback [ZIMGroupListQueiedCallback] can get a check list of all current group results. * * @param count The number of groups to query. * @param config Group list query configuration. */ abstract queryGroupList(count: number, config: ZIMGroupListQueryConfig): Promise; /** * Query the list of group members. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * Related callbacks: Through the callback [ZIMGroupMemberListQueriedCallback] can query the result of the group member list. * * @param groupID The group ID of the group member list to be queried. * @param config Group member query configuration. */ abstract queryGroupMemberList(groupID: string, config: ZIMGroupMemberQueryConfig): Promise; /** * Query the number of group members in a specified group. * * Available since: 2.2.0 or above. * Description: 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. * Restrictions: This function can only query the group that the user has entered. * Related callbacks: [ZIMGroupMemberCountQueriedCallback]. * * @param groupID The group ID of the group to be queried. */ abstract queryGroupMemberCount(groupID: string): Promise; /** * Update the group name. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Group members and group owners can change the group name. The maximum length of the name is 100 bytes. * Related callbacks: Through the callback [ZIMGroupNameUpdatedCallback] can get the result of the change of name, through [onGroupNoticeUpdated] can get update group name information. * * @param groupName The new group name. * @param groupID The target group ID. */ abstract updateGroupName(groupName: string, groupID: string): Promise; /** * Update the group avatar URL. * * Available since: 2.3.0 and above. * Description: 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. * Restrictions: Group members and group owners can modify the group avatar, with a maximum length of 500 bytes. * 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. * * @param groupAvatarUrl The new group avatar URL. * @param groupID The target group ID. */ abstract updateGroupAvatarUrl(groupAvatarUrl: string, groupID: string): Promise; /** * Update group announcements. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Only group members can update the group bulletin. The maximum number of bytes is 300. There is no special character limit. * Related callbacks: Through callback [ZIMGroupNoticeUpdateCallback] can get update group of the results announcement, announcement by [onGroupNoticeUpdated] can get update group information. * * @param groupNotice The new group notice content. * @param groupID The target group ID. */ abstract updateGroupNotice(groupNotice: string, groupID: string): Promise; /** * Update the group alias. * * Available since: 2.18.0 and above. * Description: 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. * * @param groupAlias The new group alias. * @param groupID The target group ID. */ abstract updateGroupAlias(groupAlias: string, groupID: string): Promise; /** * Update group verification mode. * * Available since: 2.15.0 and above. * Description: 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. * * @param mode The group join mode. * @param groupID The target group ID. */ abstract updateGroupJoinMode(mode: ZIMGroupJoinMode, groupID: string): Promise; /** * Update group verification mode. * * Available since: 2.15.0 and above. * Description: 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. * * @param mode The group invite mode. * @param groupID The target group ID. */ abstract updateGroupInviteMode(mode: ZIMGroupInviteMode, groupID: string): Promise; /** * Update group verification mode. * * Available since: 2.15.0 and above. * Description: 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. * * @param mode The group be-invite mode. * @param groupID The target group ID. */ abstract updateGroupBeInviteMode(mode: ZIMGroupBeInviteMode, groupID: string): Promise; /** * Add or update group attributes. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Only group members can set group attributes. * Related callbacks: Through the callback [ZIMGroupAttributesOperatedCallback] can get the result of the set of attributes. * Related APIs: [deleteGroupAttributes] can be used to deleteGroupAttributes, [queryGroupAttributes] can be used to queryGroupAttributes, [queryAllGroupAttributes] can be used to queryAllGroupAttributes. * * @param groupAttributes The group attributes to set, in key-value pairs. * @param groupID The target group ID. */ abstract setGroupAttributes(groupAttributes: Record, groupID: string): Promise; /** * Delete group attributes. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Only group members can delete group attributes. * 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. * * @param keys The list of group attribute keys to delete. * @param groupID The target group ID. */ abstract deleteGroupAttributes(keys: string[], groupID: string): Promise; /** * Query group attributes by keys. * * Available since: 2.0.0 and above. * Description: 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]. * Restrictions: Available after login, unavailable after logout. * Related callbacks: Through the callback [ZIMGroupAttributesQuriedCallback] can get query attributes of the specified group of results. * Related APIs: [queryAllGroupAttributes] Queries all group attributes. * * @param keys The list of group attribute keys to query. * @param groupID The target group ID. */ abstract queryGroupAttributes(keys: string[], groupID: string): Promise; /** * Query all attributes of the group. * * Available since: 2.0.0 and above. * Description: 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. * * @param groupID The target group ID. */ abstract queryGroupAllAttributes(groupID: string): Promise; /** * Set the group member role. * * Available since: 2.0.0 and above. * Description: 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. * Restrictions: Non-group master unavailable. * Related callbacks: Through the callback [ZIMGroupMemberRoleUpdatedCallback] can be set up to get the results of the group of members of the role. * * @param role The role value to set for the group member. * @param forUserID The user ID of the target group member. * @param groupID The target group ID. */ abstract setGroupMemberRole(role: number, forUserID: string, groupID: string): Promise; /** * Set the group member nickname. * * Available since: 2.0.0 and above. * Description: 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. * 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. * Related callbacks: Through the callback [ZIMGroupMemberNicknameUpdatedCallback] can be set up to get the results of the group members nickname. * * @param nickname The new group member nickname. * @param forUserID The user ID of the target group member. * @param groupID The target group ID. */ abstract setGroupMemberNickname(nickname: string, forUserID: string, groupID: string): Promise; /** * Mute a group. * * Available since: 2.14.0 and above. * Description: 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. * Restrictions: This can be called by the group owner and group administrators. * 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 [onGroupMuteInfoUpdated]. * * @param isMute Whether to mute. true means mute, false means unmute. * @param groupID The target group ID. * @param config Group mute configuration. */ abstract muteGroup(isMute: boolean, groupID: string, config: ZIMGroupMuteConfig): Promise; /** * Mute group members. * * Available since: 2.14.0 and above. * Description: 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. * Restrictions: This can be called by the group owner and group administrators. * 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]. * * @param isMute Whether to mute. true means mute, false means unmute. * @param userIDs The list of user IDs to mute/unmute. * @param groupID The target group ID. * @param config Group member mute configuration. */ abstract muteGroupMembers(isMute: boolean, userIDs: string[], groupID: string, config: ZIMGroupMemberMuteConfig): Promise; /** * Query the list of group muted members. * * Available since: 2.14.0 and above. * Description: 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. * Restrictions: Available after login, unavailable after logout. * Related callbacks: Through the callback [ZIMGroupMembersMutedCallback] can query the result of the group muted member list. * * @param groupID The target group ID. * @param config Group muted member list query configuration. */ abstract queryGroupMemberMutedList(groupID: string, config: ZIMGroupMemberQueryConfig): Promise; /** * Query the list of group message read members. * * Available since: 2.5.0 and above. * Description: 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. * 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. * 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]. * * @param message The group message to query the read member list of. * @param groupID The target group ID. * @param config Group message receipt member query configuration. */ abstract queryGroupMessageReceiptReadMemberList(message: ZIMMessage, groupID: string, config: ZIMGroupMessageReceiptMemberQueryConfig): Promise; /** * Query the list of group message unread members. * * Available since: 2.5.0 and above. * Description: 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. * 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. * 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]. * * @param message The group message to query the unread member list of. * @param groupID The target group ID. * @param config Group message receipt member query configuration. */ abstract queryGroupMessageReceiptUnreadMemberList(message: ZIMMessage, groupID: string, config: ZIMGroupMessageReceiptMemberQueryConfig): Promise; /** * Search local groups. * * Available since: 2.9.0 and above. * Description: 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] * Restrictions: Takes effect after login, becomes invalid after logout. * Related callbacks: [ZIMGroupsSearchedCallback]. * * @param config Configuration for searching groups. */ abstract searchLocalGroups(config: ZIMGroupSearchConfig): Promise; /** * Search local group members. * * Available since: 2.9.0 and above. * Description: 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. * Restrictions: Takes effect after login, becomes invalid after logout. * Related callbacks: [ZIMGroupMembersSearchedCallback]. * * @param groupID Group ID of the joined group. * @param config The configuration for searching group members. */ abstract searchLocalGroupMembers(groupID: string, config: ZIMGroupMemberSearchConfig): Promise; /** * Send an application to join the group. * * Available since: 2.15.0 and above. * Description: 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. * * @param groupID The group ID to apply to join. * @param config Group join application configuration. */ abstract sendGroupJoinApplication(groupID: string, config: ZIMGroupJoinApplicationSendConfig): Promise; /** * Accept an application to join the group. * * Available since: 2.15.0 and above. * Description: 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. * * @param userID The user ID of the applicant. * @param groupID The target group ID. * @param config Configuration for accepting the group join application. */ abstract acceptGroupJoinApplication(userID: string, groupID: string, config: ZIMGroupJoinApplicationAcceptConfig): Promise; /** * Reject an application to join the group. * * Available since: 2.15.0 and above. * Description: 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. * * @param userID The user ID of the applicant. * @param groupID The target group ID. * @param config Configuration for rejecting the group join application. */ abstract rejectGroupJoinApplication(userID: string, groupID: string, config: ZIMGroupJoinApplicationRejectConfig): Promise; /** * Send an application to invite the group. * * Available since: 2.15.0 and above. * Description: 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. * * @param userIDs The list of user IDs to invite. * @param groupID The target group ID. * @param config Group invite application configuration. */ abstract sendGroupInviteApplications(userIDs: string[], groupID: string, config: ZIMGroupInviteApplicationSendConfig): Promise; /** * Accept an application to invite to the group. * * Available since: 2.15.0 and above. * Description: 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. * * @param inviterUserID The user ID of the inviter. * @param groupID The target group ID. * @param config Configuration for accepting the group invite application. */ abstract acceptGroupInviteApplication(inviterUserID: string, groupID: string, config: ZIMGroupInviteApplicationAcceptConfig): Promise; /** * Reject an application to invite to the group. * * Available since: 2.15.0 and above. * Description: 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. * * @param inviterUserID The user ID of the inviter. * @param groupID The target group ID. * @param config Configuration for rejecting the group invite application. */ abstract rejectGroupInviteApplication(inviterUserID: string, groupID: string, config: ZIMGroupInviteApplicationRejectConfig): Promise; /** * Query the group application list. * * Available since: 2.15.0 and above. * Description: 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. * * @param config Group application list query configuration. */ abstract queryGroupApplicationList(config: ZIMGroupApplicationListQueryConfig): Promise; /** * Initiate a call invitation. * * Available since: 2.0.0 and above. * Description: 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]. * * @param invitees The list of invitee user IDs. * @param config Call invitation configuration. */ abstract callInvite(invitees: string[], config: ZIMCallInviteConfig): Promise; /** * Cancel the call invitation. * * Available since: 2.0.0 and above. * Description: 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]. * * @param invitees The list of invitee user IDs to cancel the invitation for. * @param callID The call invitation ID to cancel. * @param config Call cancel configuration. */ abstract callCancel(invitees: string[], callID: string, config: ZIMCallCancelConfig): Promise; /** * Accept the call invitation. * * Available since: 2.0.0 and above. * Description: 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]. * * @param callID The call invitation ID to accept. * @param config Call accept configuration. */ abstract callAccept(callID: string, config: ZIMCallAcceptConfig): Promise; /** * Reject the call invitation. * * Available since: 2.0.0 and above. * Description: 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]. * * @param callID The ID of the call invitation to be rejected. * @param config Related configuration for rejecting call invitations. */ abstract callReject(callID: string, config: ZIMCallRejectConfig): Promise; /** * Invite other users to join the call invitation. * * Available since: 2.9.0 and above. * Description: 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]. * * @param invitees The list of user IDs to invite into the call. * @param callID The current call invitation ID. * @param config Configuration for inviting during an active call. */ abstract callingInvite(invitees: string[], callID: string, config: ZIMCallingInviteConfig): Promise; /** * Join an advanced mode call, or switch the main device for the advanced mode call (multi-terminal login only). * * Available since: 2.12.0. * Description: 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. * * @param callID The call invitation ID to join. * @param config Call join configuration. */ abstract callJoin(callID: string, config: ZIMCallJoinConfig): Promise; /** * Quit the current call invitation. * * Available since: 2.9.0 and above. * Description: 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]. * * @param callID The call invitation ID to quit. * @param config Call quit configuration. */ abstract callQuit(callID: string, config: ZIMCallQuitConfig): Promise; /** * End the call invitation. * * Available since: 2.9.0 and above. * Description: 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]. * * @param callID The call invitation ID to end. * @param config Call end configuration. */ abstract callEnd(callID: string, config: ZIMCallEndConfig): Promise; /** * Query the call invitation list. * * Available since: 2.9.0 and above. * Description: 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]. * * @param config Call invitation list query configuration. */ abstract queryCallInvitationList(config: ZIMCallInvitationQueryConfig): Promise; /** * Add friends directly. * * Available since: 2.14.0 or above. * Description: 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]. * * @param userID The user ID to add as a friend. * @param config Friend add configuration. */ abstract addFriend(userID: string, config: ZIMFriendAddConfig): Promise; /** * Delete friends. * * Available since: 2.14.0 or above. * Description: 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: [friendListChanged]. * * @param userIDs The list of friend user IDs to delete. * @param config Friend delete configuration. */ abstract deleteFriends(userIDs: string[], config: ZIMFriendDeleteConfig): Promise; /** * Check friend relationships. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendAddedResult]. * * @param userIDs The list of user IDs to check friend relationships with. * @param config Friend relation check configuration. */ abstract checkFriendsRelation(userIDs: string[], config: ZIMFriendRelationCheckConfig): Promise; /** * Update friend alias. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendAliasUpdatedResult]. * * @param friendAlias The new friend alias. * @param userID The user ID of the friend to update the alias for. */ abstract updateFriendAlias(friendAlias: string, userID: string): Promise; /** * Update friend attributes. * * Available since: 2.14.0 or above. * Description: 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. * * @param friendAttributes The friend attributes to update, in key-value pairs. * @param userID The user ID of the friend to update attributes for. */ abstract updateFriendAttributes(friendAttributes: Record, userID: string): Promise; /** * Query friend information in batches. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendListQueriedResult]. * * @param userIDs The list of friend user IDs to query information for. */ abstract queryFriendsInfo(userIDs: string[]): Promise; /** * Query the friends list. * * Available since: 2.14.0 or above. * Description: 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]. * * @param config Friend list query configuration. */ abstract queryFriendList(config: ZIMFriendListQueryConfig): Promise; /** * Search local friends. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendsSearchedResult]. * * @param config Friend search configuration. */ abstract searchLocalFriends(config: ZIMFriendSearchConfig): Promise; /** * Send a friend application. * * Available since: 2.14.0 and above. * Description: 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: [friendApplicationListChanged]. * * @param userID The user ID to send the friend application to. * @param config Friend application configuration. */ abstract sendFriendApplication(userID: string, config: ZIMFriendApplicationSendConfig): Promise; /** * Accept a friend application. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendApplicationAcceptedResult]. * * @param userID The user ID of the friend application sender. * @param config Configuration for accepting the friend application. */ abstract acceptFriendApplication(userID: string, config: ZIMFriendApplicationAcceptConfig): Promise; /** * Reject a friend application. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendApplicationRejectedResult]. * * @param userID The user ID of the friend application sender. * @param config Configuration for rejecting the friend application. */ abstract rejectFriendApplication(userID: string, config: ZIMFriendApplicationRejectConfig): Promise; /** * Query the friend application list. * * Available since: 2.14.0 or above. * Description: 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: [ZIMFriendApplicationListQueriedResult]. * * @param config Friend application list query configuration. */ abstract queryFriendApplicationList(config: ZIMFriendApplicationListQueryConfig): Promise; /** * Add users to the blacklist. * * Available since: 2.13.0 or above. * Description: 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]. * Restrictions: The number of userID passed in at one time cannot exceed 20. * * @param userIDs The list of user IDs to add to the blacklist. */ abstract addUsersToBlacklist(userIDs: string[]): Promise; /** * Remove the user from the blacklist. * * Available since: 2.13.0 or above. * Description: 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]. * Restrictions: The number of userID passed in at one time cannot exceed 20. * * @param userIDs The list of user IDs to remove from the blacklist. */ abstract removeUsersFromBlacklist(userIDs: string[]): Promise; /** * Query the blacklist. * * Available since: 2.13.0 or above. * Description: 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]. * * @param config Blacklist query configuration. */ abstract queryBlacklist(config: ZIMBlacklistQueryConfig): Promise; /** * Check if the user is on the blacklist. * * Available since: 2.13.0 or above. * Description: 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]. * * @param userID The user ID to check whether it is on the blacklist. */ abstract checkUserIsInBlacklist(userID: string): Promise; /** * Create a community. * * Available since: Coming soon. * Description: Coming soon. * Use cases: Coming soon. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Caution: Available after login, unavailable after logout. * Related callbacks: The result of creating the community is obtained through the [ZIMCommunityCreatedCallback] callback. * Related APIs: You can use [joinCommunity] to join a community, [leaveCommunity] to leave a community, or [dismissCommunity] to dismiss a community. * * @param communityInfo Information for the community to be created. * @param config Create the relevant configuration of the community. */ abstract createCommunity(communityInfo: ZIMCommunityInfo, config?: ZIMCommunityCreateConfig): Promise; /** * Dismiss a community. * * Available since: Coming soon. * Description: After a community is created, the community owner can dismiss it through this interface. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Caution: Only the community owner can dismiss the community. * Related callbacks: The result of dismissing the community is obtained through the [ZIMCommunityDismissedCallback] callback. * * @param communityID The ID of the community to dismiss. */ abstract dismissCommunity(communityID: string): Promise; /** * Join a community. * * Available since: Coming soon. * Description: Users can join the specified community through this interface. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result of joining the community is obtained through the [ZIMCommunityJoinedCallback] callback. * * @param communityID The community ID to join. */ abstract joinCommunity(communityID: string): Promise; /** * Leave a community. * * Available since: Coming soon. * Description: After a user joins a community, they can leave through this interface. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result of leaving the community is obtained through the [ZIMCommunityLeftCallback] callback. * * @param communityID The community ID to leave. */ abstract leaveCommunity(communityID: string): Promise; /** * Invite users into a community. * * Available since: Coming soon. * Description: Invite specified users to join the community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result of inviting users is obtained through the [ZIMCommunityUsersInvitedCallback] callback. * * @param userIDs The list of user IDs to invite. * @param communityID The target community ID. */ abstract inviteUsersIntoCommunity(userIDs: string[], communityID: string): Promise; /** * Kick members from a community. * * Available since: Coming soon. * Description: Remove specified users from the community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Caution: Only the community owner and administrators can call this. * Related callbacks: The result of kicking members is obtained through the [ZIMCommunityMembersKickedCallback] callback. * * @param userIDs The list of user IDs to kick from the community. * @param communityID The target community ID. */ abstract kickCommunityMembers(userIDs: string[], communityID: string): Promise; /** * Query the community list. * * Available since: Coming soon. * Description: Query the list of communities that the current user has joined. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The query result is obtained through the [ZIMCommunityListQueriedCallback] callback. * * @param count The number of communities to query. * @param config Community list query configuration (optional). */ abstract queryCommunityList(count: number, config?: ZIMCommunityListQueryConfig): Promise; /** * Update the community name. * * Available since: Coming soon. * Description: Update the name of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityNameUpdatedCallback] callback. * * @param communityName The new community name. * @param communityID The target community ID. */ abstract updateCommunityName(communityName: string, communityID: string): Promise; /** * Update the community avatar URL. * * Available since: Coming soon. * Description: Update the avatar URL of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityAvatarUrlUpdatedCallback] callback. * * @param communityAvatarUrl The new community avatar URL. * @param communityID The target community ID. */ abstract updateCommunityAvatarUrl(communityAvatarUrl: string, communityID: string): Promise; /** * Update the community notice. * * Available since: Coming soon. * Description: Update the notice of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityNoticeUpdatedCallback] callback. * * @param communityNotice The new community notice content. * @param communityID The target community ID. */ abstract updateCommunityNotice(communityNotice: string, communityID: string): Promise; /** * Set community attributes. * * Available since: Coming soon. * Description: Set custom attributes for the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityAttributesOperatedCallback] callback. * * @param communityAttributes The community attributes to set, in key-value pairs. * @param communityID The target community ID. */ abstract setCommunityAttributes(communityAttributes: Record, communityID: string): Promise; /** * Delete community attributes. * * Available since: Coming soon. * Description: Delete custom attributes of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityAttributesOperatedCallback] callback. * * @param keys The list of community attribute keys to delete. * @param communityID The target community ID. */ abstract deleteCommunityAttributes(keys: string[], communityID: string): Promise; /** * Set the community notification status. * * Available since: Coming soon. * Description: Set the message notification status (e.g. do not disturb) for the current user in the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityNotificationStatusSetCallback] callback. * * @param status The notification status to set. * @param communityID The target community ID. */ abstract setCommunityNotificationStatus(status: ZIMCommunityMessageNotificationStatus, communityID: string): Promise; /** * Query community information. * * Available since: Coming soon. * Description: Query detailed information of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityInfoQueriedCallback] callback. * * @param communityID The community ID to query information for. */ abstract queryCommunityInfo(communityID: string): Promise; /** * Update a community member's role. * * Available since: Coming soon. * Description: Update the role of the specified community member. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Caution: Only the community owner can call this. * Related callbacks: The result is obtained through the [ZIMCommunityMemberRoleUpdatedCallback] callback. * * @param memberRole The role value to set for the member. * @param forUserID The user ID of the target community member. * @param communityID The target community ID. */ abstract updateCommunityMemberRole(memberRole: number, forUserID: string, communityID: string): Promise; /** * Transfer the community owner. * * Available since: Coming soon. * Description: The community owner can transfer ownership to a specified user. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Caution: Only the community owner can call this. * Related callbacks: The result is obtained through the [ZIMCommunityOwnerTransferredCallback] callback. * * @param toUserID The user ID of the new community owner. * @param communityID The target community ID. */ abstract transferCommunityOwner(toUserID: string, communityID: string): Promise; /** * Query the community member list. * * Available since: Coming soon. * Description: Query the member list of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityMemberListQueriedCallback] callback. * * @param communityID The community ID to query the member list for. * @param count The number of members to query. * @param config Community member list query configuration (optional). */ abstract queryCommunityMemberList(communityID: string, count: number, config?: ZIMCommunityMemberListQueryConfig): Promise; /** * Query specific community members' information. * * Available since: Coming soon. * Description: Query the member information of specific users in the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityMembersQueriedCallback] callback. * * @param userIDs The list of user IDs to query information for. * @param communityID The target community ID. */ abstract queryCommunityMembers(userIDs: string[], communityID: string): Promise; /** * Create a community channel. * * Available since: Coming soon. * Description: Coming soon. * Use cases: Coming soon. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * * @param channelInfo Information for the community channel to be created. * @param config Create the relevant configuration of the community channel. */ abstract createCommunityChannel(channelInfo: ZIMCommunityChannelInfo, config?: ZIMCommunityChannelCreateConfig): Promise; /** * Dismiss a community channel. * * Available since: Coming soon. * Description: Dismiss the specified channel in the community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelDismissedCallback] callback. * * @param channelID The channel ID to dismiss. * @param communityID The target community ID. */ abstract dismissCommunityChannel(channelID: string, communityID: string): Promise; /** * Update the community channel name. * * Available since: Coming soon. * Description: Update the name of the specified community channel. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelNameUpdatedCallback] callback. * * @param channelName The new channel name. * @param channelID The channel ID to update the name for. * @param communityID The target community ID. */ abstract updateCommunityChannelName(channelName: string, channelID: string, communityID: string): Promise; /** * Update the community channel avatar URL. * * Available since: Coming soon. * Description: Update the avatar URL of the specified community channel. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelAvatarUrlUpdatedCallback] callback. * * @param channelAvatarUrl The new channel avatar URL. * @param channelID The channel ID to update the avatar URL for. * @param communityID The target community ID. */ abstract updateCommunityChannelAvatarUrl(channelAvatarUrl: string, channelID: string, communityID: string): Promise; /** * Update the community channel notice. * * Available since: Coming soon. * Description: Update the notice of the specified community channel. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelNoticeUpdatedCallback] callback. * * @param channelNotice The new channel notice content. * @param channelID The channel ID to update the notice for. * @param communityID The target community ID. */ abstract updateCommunityChannelNotice(channelNotice: string, channelID: string, communityID: string): Promise; /** * Set community channel attributes. * * Available since: Coming soon. * Description: Set custom attributes for the specified community channel. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelAttributesOperatedCallback] callback. * * @param channelAttributes The channel attributes to set, in key-value pairs. * @param channelID The target channel ID. * @param communityID The target community ID. */ abstract setCommunityChannelAttributes(channelAttributes: Record, channelID: string, communityID: string): Promise; /** * Delete community channel attributes. * * Available since: Coming soon. * Description: Delete custom attributes of the specified community channel. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelAttributesOperatedCallback] callback. * * @param keys The list of channel attribute keys to delete. * @param channelID The target channel ID. * @param communityID The target community ID. */ abstract deleteCommunityChannelAttributes(keys: string[], channelID: string, communityID: string): Promise; /** * Query community channel information. * * Available since: Coming soon. * Description: Query detailed information of multiple channels in the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelsInfoQueriedCallback] callback. * * @param channelIDs The list of channel IDs to query information for. * @param communityID The target community ID. */ abstract queryCommunityChannelsInfo(channelIDs: string[], communityID: string): Promise; /** * Query the community channel list. * * Available since: Coming soon. * Description: Query the channel list of the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelListQueriedCallback] callback. * * @param communityID The community ID to query the channel list for. * @param count The number of channels to query. * @param config Community channel list query configuration (optional). */ abstract queryCommunityChannelList(communityID: string, count: number, config?: ZIMCommunityChannelListQueryConfig): Promise; /** * Mute community channels. * * Available since: Coming soon. * Description: Mute or unmute channels in the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Related callbacks: The result is obtained through the [ZIMCommunityChannelsMutedCallback] callback. * * @param isMute Whether to mute. true means mute, false means unmute. * @param channelIDs The list of channel IDs to mute/unmute. * @param communityID The target community ID. * @param config Community channel mute configuration (optional). */ abstract muteCommunityChannels(isMute: boolean, channelIDs: string[], communityID: string, config?: ZIMCommunityChannelMuteConfig): Promise; /** * Mute community members. * * Available since: Coming soon. * Description: Mute or unmute members in the specified community. * When to call: The ZIM instance can be invoked after being created by [create] and logged in. * Caution: Only the community owner and administrators can call this. * Related callbacks: The result is obtained through the [ZIMCommunityMembersMutedCallback] callback. * * @param isMute Whether to mute. true means mute, false means unmute. * @param userIDs The list of user IDs to mute/unmute. * @param communityID The target community ID. * @param config Community member mute configuration (optional). */ abstract muteCommunityMembers(isMute: boolean, userIDs: string[], communityID: string, config?: ZIMCommunityMemberMuteConfig): Promise; }