In-app Chat

Common Class

All Categories

Interface

2026-07-24


ZIMError	ZIMAppConfig
ZIMLogConfig	ZIMUserInfo
ZIMUserFullInfo	ZIMUserOfflinePushRule
ZIMUserRule	ZIMUserStatus
ZIMUserStatusSubscription	ZIMSelfUserInfo
ZIMUserStatusSubscribeConfig	ZIMSubscribedUserStatusQueryConfig
ZIMUserCustomStatusUpdateConfig	ZIMErrorUserInfo
ZIMLoginConfig	ZIMLogoutConfig
ZIMUsersInfoQueryConfig	ZIMOfflinePushPrivateMessageTemplate
ZIMVoIPConfig	ZIMPushConfig
ZIMMessageReactionAddConfig	ZIMMessageReactionUserInfo
ZIMMessageReaction	ZIMMessageReactionSimpleInfo
ZIMMessageReactionUserFullInfo	ZIMMessageReactionUserChangeInfo
ZIMMessageLiteInfo	ZIMTextMessageLiteInfo
ZIMCustomMessageLiteInfo	ZIMCombineMessageLiteInfo
ZIMRevokeMessageLiteInfo	ZIMMediaMessageLiteInfo
ZIMImageMessageLiteInfo	ZIMFileMessageLiteInfo
ZIMAudioMessageLiteInfo	ZIMVideoMessageLiteInfo
ZIMMultipleMessageLiteInfo	ZIMMessageRepliedInfo
ZIMMessage	ZIMMediaMessage
ZIMTextMessage	ZIMCustomMessage
ZIMCommandMessage	ZIMBarrageMessage
ZIMImageMessage	ZIMFileMessage
ZIMAudioMessage	ZIMVideoMessage
ZIMRevokeMessage	ZIMCombineMessage
ZIMTipsMessage	ZIMMultipleMessage
ZIMMessageRootRepliedInfo	ZIMMessageRootRepliedCountInfo
ZIMMessageMentionedInfo	ZIMMessageReceivedInfo
ZIMMessageSendConfig	ZIMMessageQueryConfig
ZIMMessageRevokeConfig	ZIMMessageDeleteConfig
ZIMMessageSendNotification	ZIMMediaMessageSendNotification
ZIMMessageReceiptInfo	ZIMMessageReactionUserQueryConfig
ZIMMessageSentStatusChangeInfo	ZIMMessageSearchConfig
ZIMMessageRepliedListQueryConfig	ZIMMessageEditConfig
ZIMSendingMessageCancelConfig	ZIMMessagePinConfig
ZIMTipsMessageChangeInfo	ZIMTipsMessageGroupChangeInfo
ZIMTipsMessageGroupMemberChangeInfo	ZIMTipsMessagePinStatusChangeInfo
ZIMMessagePinStatusChangeInfo	ZIMMessageReactionChangeInfo
ZIMConversation	ZIMConversationBaseInfo
ZIMGroupConversation	ZIMConversationQueryConfig
ZIMConversationFilterOption	ZIMConversationTotalUnreadMessageCountQueryConfig
ZIMConversationDeleteConfig	ZIMConversationChangeInfo
ZIMConversationSearchConfig	ZIMConversationSearchInfo
ZIMRoomInfo	ZIMRoomFullInfo
ZIMRoomMemberInfo	ZIMRoomMemberQueryConfig
ZIMRoomAdvancedConfig	ZIMRoomAttributesSetConfig
ZIMRoomAttributesBatchOperationConfig	ZIMRoomAttributesDeleteConfig
ZIMRoomAttributesUpdateInfo	ZIMRoomMemberAttributesInfo
ZIMRoomMemberAttributesOperatedInfo	ZIMRoomMemberAttributesUpdateInfo
ZIMRoomMemberAttributesSetConfig	ZIMRoomMemberAttributesQueryConfig
ZIMRoomOperatedInfo	ZIMGroupInfo
ZIMGroupMuteInfo	ZIMGroupVerifyInfo
ZIMGroupFullInfo	ZIMGroup
ZIMGroupMemberSimpleInfo	ZIMGroupEnterInfo
ZIMGroupMemberInfo	ZIMGroupOperatedInfo
ZIMGroupMemberQueryConfig	ZIMGroupAdvancedConfig
ZIMGroupAttributesUpdateInfo	ZIMGroupMessageReceiptMemberQueryConfig
ZIMGroupMessageReceiptMemberListQueryConfig	ZIMGroupSearchConfig
ZIMGroupSearchInfo	ZIMGroupMemberSearchConfig
ZIMGroupMuteConfig	ZIMGroupMemberMuteConfig
ZIMGroupMemberMutedListQueryConfig	ZIMGroupApplicationInfo
ZIMGroupJoinApplicationSendConfig	ZIMGroupJoinApplicationAcceptConfig
ZIMGroupJoinApplicationRejectConfig	ZIMGroupInviteApplicationSendConfig
ZIMGroupInviteApplicationAcceptConfig	ZIMGroupInviteApplicationRejectConfig
ZIMGroupApplicationListQueryConfig	ZIMGroupListQueryConfig
ZIMCallUserInfo	ZIMCallInviteConfig
ZIMCallingInviteConfig	ZIMCallJoinConfig
ZIMCallQuitConfig	ZIMCallEndConfig
ZIMCallCancelConfig	ZIMCallAcceptConfig
ZIMCallRejectConfig	ZIMCallInvitationQueryConfig
ZIMCallInfo	ZIMCallUserStateChangeInfo
ZIMBlacklistQueryConfig	ZIMFriendAddConfig
ZIMFriendDeleteConfig	ZIMFriendListQueryConfig
ZIMFriendSearchConfig	ZIMFriendRelationCheckConfig
ZIMFriendRelationInfo	ZIMFriendInfo
ZIMFriendApplicationSendConfig	ZIMFriendApplicationAcceptConfig
ZIMFriendApplicationRejectConfig	ZIMFriendApplicationListQueryConfig
ZIMFriendApplicationInfo	ZIMCommunityInfo
ZIMCommunity	ZIMCommunityFullInfo
ZIMCommunityCreateConfig	ZIMCommunityListQueryConfig
ZIMCommunityChangeInfo	ZIMCommunityMemberListQueryConfig
ZIMCommunityFullInfoUpdateInfo	ZIMCommunityMemberEnterInfo
ZIMCommunityMemberMuteInfo	ZIMCommunityMemberInfo
ZIMCommunityMemberSimpleInfo	ZIMCommunityMemberStateChangeInfo
ZIMCommunityMemberInfoUpdateInfo	ZIMCommunityChannelInfo
ZIMCommunityChannelMuteInfo	ZIMCommunityChannel
ZIMCommunityChannelFullInfo	ZIMCommunityChannelCreateConfig
ZIMCommunityChannelListQueryConfig	ZIMCommunityChannelChangeInfo
ZIMCommunityChannelFullInfoUpdateInfo	ZIMCommunityChannelMuteConfig
ZIMCommunityMemberMuteConfig	ZIMConnectionStateChangedEventResult
ZIMTokenWillExpireEventResult	ZIMUserInfoUpdatedEventResult
ZIMUserStatusUpdatedEventResult	ZIMUserRuleUpdatedEventResult
ZIMConversationChangedEventResult	ZIMConversationsAllDeletedEventResult
ZIMConversationSyncStateChangedEventResult	ZIMConversationTotalUnreadMessageCountUpdatedEventResult
ZIMConversationMessageReceiptChangedEventResult	ZIMMessageReceiptChangedEventResult
ZIMMessageRevokeReceivedEventResult	ZIMMessageReactionsChangedEventResult
ZIMMessageRepliedCountChangedEventResult	ZIMMessageRepliedInfoChangedEventResult
ZIMMessageDeletedEventResult	ZIMMessageSentStatusChangedEventResult
ZIMBroadcastMessageReceivedEventResult	ZIMConversationMessageReceivedEventResult
ZIMMessageReceivedEventResult	ZIMMessageEditedEventResult
ZIMMessagePinStatusChangedEventResult	ZIMRoomStateChangedEventResult
ZIMRoomMemberChangedEventResult	ZIMRoomAttributesUpdatedEventResult
ZIMRoomMemberAttributesUpdatedEventResult	ZIMGroupStateChangedEventResult
ZIMGroupNameUpdatedEventResult	ZIMGroupAvatarUrlUpdatedEventResult
ZIMGroupNoticeUpdatedEventResult	ZIMGroupAliasUpdatedEventResult
ZIMGroupAttributesUpdatedEventResult	ZIMGroupMutedInfoUpdatedEventResult
ZIMGroupVerifyInfoUpdatedEventResult	ZIMGroupApplicationListChangedEventResult
ZIMGroupApplicationUpdatedEventResult	ZIMGroupMemberStateChangedEventResult
ZIMGroupMemberInfoUpdatedEventResult	ZIMCallInvitationCreatedEventResult
ZIMCallInvitationReceivedEventResult	ZIMCallInvitationCancelledEventResult
ZIMCallInvitationTimeoutEventResult	ZIMCallInvitationEndedEventResult
ZIMCallUserStateChangedEventResult	ZIMBlacklistChangedEventResult
ZIMFriendListChangedEventResult	ZIMFriendInfoUpdatedEventResult
ZIMFriendApplicationListChangedEventResult	ZIMFriendApplicationUpdatedEventResult
ZIMCommunityListChangedEventResult	ZIMCommunityInfoUpdatedEventResult
ZIMCommunityMemberStateChangedEventResult	ZIMCommunityMemberInfoUpdatedEventResult
ZIMCommunityChannelListChangedEventResult	ZIMCommunityChannelInfoUpdatedEventResult
ZIMLogUploadedResult	ZIMLoggedInResult
ZIMTokenRenewedResult	ZIMUserNameUpdatedResult
ZIMUserAvatarUrlUpdatedResult	ZIMUserExtendedDataUpdatedResult
ZIMUserCustomStatusUpdatedResult	ZIMUsersInfoQueriedResult
ZIMUserOfflinePushRuleUpdatedResult	ZIMSelfUserInfoQueriedResult
ZIMUsersStatusQueriedResult	ZIMUsersStatusSubscribedResult
ZIMUsersStatusUnsubscribedResult	ZIMSubscribedUserStatusListQueriedResult
ZIMConversationQueriedResult	ZIMConversationListQueriedResult
ZIMConversationTotalUnreadMessageCountQueriedResult	ZIMConversationDeletedResult
ZIMConversationsAllDeletedResult	ZIMConversationUnreadMessageCountClearedResult
ZIMConversationTotalUnreadMessageCountClearedResult	ZIMConversationNotificationStatusSetResult
ZIMConversationMessageReceiptReadSentResult	ZIMConversationPinnedStateUpdatedResult
ZIMConversationPinnedListQueriedResult	ZIMConversationDraftSetResult
ZIMConversationMarkSetResult	ZIMConversationMessageDestructDurationSetResult
ZIMConversationsSearchedResult	ZIMMessageSentResult
ZIMMessageAttachedResult	ZIMMediaUploadingProgress
ZIMMultipleMediaUploadingProgress	ZIMMessageQueriedResult
ZIMMessageDeletedResult	ZIMConversationMessagesAllDeletedResult
ZIMMessageRevokedResult	ZIMMessageInsertedResult
ZIMMessageLocalExtendedDataUpdatedResult	ZIMMessageReceiptsReadSentResult
ZIMMessageReceiptsInfoQueriedResult	ZIMMessagesSearchedResult
ZIMMessagesGlobalSearchedResult	ZIMMessageReactionAddedResult
ZIMMessageReactionDeletedResult	ZIMMessageReactionUserListQueriedResult
ZIMCombineMessageDetailQueriedResult	ZIMMessageRepliedListQueriedResult
ZIMMessageEditedResult	ZIMSendingMessageCancelledResult
ZIMMessagePinnedResult	ZIMPinnedMessageListQueriedResult
ZIMRoomCreatedResult	ZIMRoomJoinedResult
ZIMRoomEnteredResult	ZIMRoomSwitchedResult
ZIMRoomLeftResult	ZIMRoomAllLeftResult
ZIMRoomMemberQueriedResult	ZIMRoomMembersQueriedResult
ZIMRoomOnlineMemberCountQueriedResult	ZIMRoomAttributesOperatedResult
ZIMRoomAttributesBatchOperatedResult	ZIMRoomAttributesQueriedResult
ZIMRoomMembersAttributesOperatedResult	ZIMRoomMembersAttributesQueriedResult
ZIMRoomMemberAttributesListQueriedResult	ZIMGroupCreatedResult
ZIMGroupDismissedResult	ZIMGroupJoinedResult
ZIMGroupLeftResult	ZIMGroupUsersInvitedResult
ZIMGroupMemberKickedResult	ZIMGroupOwnerTransferredResult
ZIMGroupNameUpdatedResult	ZIMGroupAvatarUrlUpdatedResult
ZIMGroupNoticeUpdatedResult	ZIMGroupAliasUpdatedResult
ZIMGroupInfoQueriedResult	ZIMGroupAttributesOperatedResult
ZIMGroupAttributesQueriedResult	ZIMGroupMemberRoleUpdatedResult
ZIMGroupMemberNicknameUpdatedResult	ZIMGroupMemberInfoQueriedResult
ZIMGroupListQueriedResult	ZIMGroupMemberListQueriedResult
ZIMGroupMemberCountQueriedResult	ZIMGroupMessageReceiptMemberListQueriedResult
ZIMGroupMutedResult	ZIMGroupMembersMutedResult
ZIMGroupMemberMutedListQueriedResult	ZIMGroupsSearchedResult
ZIMGroupMembersSearchedResult	ZIMGroupJoinModeUpdatedResult
ZIMGroupInviteModeUpdatedResult	ZIMGroupBeInviteModeUpdatedResult
ZIMGroupJoinApplicationSentResult	ZIMGroupJoinApplicationAcceptedResult
ZIMGroupJoinApplicationRejectedResult	ZIMGroupInviteApplicationsSentResult
ZIMGroupInviteApplicationAcceptedResult	ZIMGroupInviteApplicationRejectedResult
ZIMGroupApplicationListQueriedResult	ZIMCallInvitationSentResult
ZIMCallingInvitationSentResult	ZIMCallCancelSentResult
ZIMCallAcceptanceSentResult	ZIMCallRejectionSentResult
ZIMCallJoinSentResult	ZIMCallQuitSentResult
ZIMCallEndSentResult	ZIMCallInvitationListQueriedResult
ZIMFriendAddedResult	ZIMFriendsDeletedResult
ZIMFriendListQueriedResult	ZIMFriendsInfoQueriedResult
ZIMFriendsRelationCheckedResult	ZIMFriendApplicationSentResult
ZIMFriendApplicationAcceptedResult	ZIMFriendApplicationRejectedResult
ZIMFriendApplicationListQueriedResult	ZIMFriendAliasUpdatedResult
ZIMFriendAttributesUpdatedResult	ZIMFriendsSearchedResult
ZIMBlacklistUsersAddedResult	ZIMBlacklistUsersRemovedResult
ZIMBlacklistQueriedResult	ZIMBlacklistCheckedResult
ZIMCommunityCreatedResult	ZIMCommunityDismissedResult
ZIMCommunityJoinedResult	ZIMCommunityLeftResult
ZIMCommunityListQueriedResult	ZIMCommunityNameUpdatedResult
ZIMCommunityAvatarUrlUpdatedResult	ZIMCommunityNoticeUpdatedResult
ZIMCommunityAttributesOperatedResult	ZIMCommunityNotificationStatusSetResult
ZIMCommunityInfoQueriedResult	ZIMCommunityUsersInvitedResult
ZIMCommunityMembersKickedResult	ZIMCommunityMemberRoleUpdatedResult
ZIMCommunityOwnerTransferredResult	ZIMCommunityMemberListQueriedResult
ZIMCommunityMembersQueriedResult	ZIMCommunityChannelCreatedResult
ZIMCommunityChannelDismissedResult	ZIMCommunityChannelNameUpdatedResult
ZIMCommunityChannelAvatarUrlUpdatedResult	ZIMCommunityChannelNoticeUpdatedResult
ZIMCommunityChannelAttributesOperatedResult	ZIMCommunityChannelsInfoQueriedResult
ZIMCommunityChannelListQueriedResult	ZIMCommunityMembersMutedResult
ZIMCommunityChannelsMutedResult

ZIMError

Error infomation

Details

Error infomation.

Declared in ZIMDefines.ts

Properties

code

code: ZIMErrorCode

Description: The storage path of the log files. Refer to the official website document for the default path.

message

message: string

Description: Error infomation description.

ZIMAppConfig

ZIM application configuration, including AppID and AppSign.

Declared in ZIMDefines.ts

Properties

appID

appID: unsigned int

Description

, please go to the ZEGO official website console to apply for it. Required: Required.

ZIMLogConfig

Log configuration

Details

Configure the storage path of log files and the maximum log file size.

Declared in ZIMDefines.ts

Properties

logLevel

ZIMUserInfo

User information object.

Details

Identifies a unique user.

Declared in ZIMDefines.ts

Caution：Note that the userID must be unique under the same appID, otherwise mutual kicks out will occur. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.

Properties

userID

userID: string

User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

userName

userName: string

Description: User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.Required: Not required.Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.

userAvatarUrl

userAvatarUrl: string

User avatar URL

userExtendedData

userExtendedData: string

User extended data. This field is currently only available in room related interfaces.

type

type: ZIMUserInfoType

User Type. This field is used to identify which subclass the current entity belongs to.

ZIMUserFullInfo

User full information object.

Details

Identifies a unique user.

Declared in ZIMDefines.ts

Caution：Note that the userID must be unique under the same appID, otherwise mutual kicks out will occur. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.

Properties

baseInfo

baseInfo: ZIMUserInfo

Description: User basic information.

ZIMUserOfflinePushRule

Data class of the user's offline push rule.

Details

Data class of the user's offline push rule.

Declared in ZIMDefines.ts

Properties

onlinePlatforms

onlinePlatforms: ZIMPlatformType[]

With the data in the class member variables notToReceiveOfflinePushPlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.

notToReceiveOfflinePushPlatforms

notToReceiveOfflinePushPlatforms: ZIMPlatformType[]

With the data in the class member variables onlinePlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.

ZIMUserRule

User rule configuration.

Declared in ZIMDefines.ts

Properties

offlinePushRule

offlinePushRule: ZIMUserOfflinePushRule

The user's current rule information.

ZIMUserStatus

User status data

Details

Contains data about the user's online status.

Declared in ZIMDefines.ts

Properties

userID

userID: string

A unique identifier for a single user.

onlineStatus

onlineStatus: ZIMUserOnlineStatus

Enumeration that represents the current online status of the user.

onlinePlatforms

onlinePlatforms: ZIMPlatformType[]

The list of online platforms of the current user can be used to display the online platforms of the user, such as iPhone online and PC online. Please refer to ZIMPlatform for the meanings of the numbers.

customStatus

customStatus: string

User-defined status. The default maximum value is 64 bytes. The default expiration time is 1 day. At login, if the field is an empty string (which is the default), the current user's custom state is not modified.

customStatusExpiredTime

customStatusExpiredTime: number

Expired timestamp of the custom status.

lastUpdateTime

lastUpdateTime: number

Timestamp when user onlineStatus or customStatus was last changed, whichever is the greater.

lastOnlineStatusUpdateTime

lastOnlineStatusUpdateTime: number

The timestamp of the last change of the user onlineStatus, which can be used to show that the user was offline/logged in before xxx minutes.

lastCustomStatusUpdateTime

lastCustomStatusUpdateTime: number

The timestamp when User customStatus was last changed, which can be used to show when the custom status was last changed.

ZIMUserStatusSubscription

User status subscription information. Contains the user's online status, a list of online platforms, subscription expiration time stamps, and more.

Details

User status subscription information. Contains the user's online status, a list of online platforms, subscription expiration time stamps, and more.

Declared in ZIMDefines.ts

Properties

userStatus

userStatus: ZIMUserStatus

The online status of the user.

subscribeExpiredTime

subscribeExpiredTime: number

The timestamp when the user's subscription expired.

ZIMSelfUserInfo

Carry user information and rules of the current user.

Details

Carry user information and rules of the current user.

Declared in ZIMDefines.ts

Properties

userFullInfo

userFullInfo: ZIMUserFullInfo

Personal information of the current user.

userRule

userRule: ZIMUserRule

Rules for the current user, setting information.

userStatus

userStatus: ZIMUserStatus

The online status of the user.

ZIMUserStatusSubscribeConfig

subscribeUsersStatus Configuration items of the online status interface for subscribing users in batches.

Details

subscribeUsersStatus Configuration items of the online status interface for subscribing users in batches.

Declared in ZIMDefines.ts

Properties

subscriptionDuration

subscriptionDuration: number

Subscription duration, in minutes.

ZIMSubscribedUserStatusQueryConfig

QuerySubscribedUserStatusList query subscription list interface configuration items.

Details

QuerySubscribedUserStatusList query subscription list interface configuration items.

Declared in ZIMDefines.ts

Properties

userIDs

userIDs: string[]

List of user IDs to query.

ZIMUserCustomStatusUpdateConfig

User custom status update configuration.

Details

Update user custom status parameters.

Declared in ZIMDefines.ts

Properties

duration

duration: number

Duration of user custom status.

ZIMErrorUserInfo

Error user information class.

Details

Used to show the failed user and the reason for the failure.

Declared in ZIMDefines.ts

Properties

userID

userID: string

reason

reason: unsigned int

Description Reason for the query failure.

ZIMLoginConfig

Configuration of login-related parameters.

Details

Declared in ZIMDefines.ts

Use cases：Used to set different parameters during login.

Properties

userName

userName: string

Description: User name.Use cases: Used in the scenario where user nickname is modified during login, leave it blank if no change is needed.Required: No.

token

token: string

Description: Token carried during login.Use cases: Only pass this parameter in the scenario where token is used for authentication.Required: No.

isOfflineLogin

isOfflineLogin: boolean

Description: Whether it is offline login.Use cases: Set this parameter to true when performing offline login.Required: No.Default value: false.

customStatus

customStatus: string

Description: Custom status.Use cases: Only pass this parameter when you need to customize the user status during login.Required: No.

customStatusDuration

customStatusDuration: number

Description: Expired duration of the custom status.

ZIMLogoutConfig

Configuration of logout-related parameters.

Details

Parameters related to logout.

Declared in ZIMDefines.ts

Use cases：Used to configure specific behaviors during logout.

Properties

isClearDB

isClearDB: boolean

Whether to clear the current user’s local DB data when logging out. Default: [false].

ZIMUsersInfoQueryConfig

User information query configuration.

Details

User information query configuration, you can choose to query from the local or from the server. Query the unlimited frequency constraints from the local, and query the limited frequency constraints from the server. You can only query the detailed configuration of 10 users within 10 s.

Declared in ZIMDefines.ts

Properties

isQueryFromServer

isQueryFromServer: boolean

Detail description: Whether to query user details from the server. Query the unlimited frequency constraints from the local, and query the limited frequency constraints from the server. You can only query the detailed configuration of 10 users within 10 s.Required: not required.Default: false.

ZIMOfflinePushPrivateMessageTemplate

The private message template is currently only applicable to the OPPO manufacturer.

Details

According to OPUSH DMS template check ability to access instructions, OPPO in new message classification on the basis of the new push DMS templates, After you have configured the private message template in the OPPO console, if you need to apply the corresponding template during push notifications, you can assign a value to the privateMessageTemplate in ZIMPushConfig.

Declared in ZIMDefines.ts

Properties

templateID

templateID: string

Description: The private message template ID is currently only applicable to OPPO manufacturers. Please fill in the template ID preset in the OPPO Open Platform console.

titleParameters

titleParameters: string

Description: To replace the content of the preset title field in the template, a json string needs to be filled in, such as "{"user_name":" Li Hua "}".

contentParameters

contentParameters: string

Description: To replace the content of the preset fields in the template, a json string needs to be filled in, such as "{"city":" Shenzhen "}".

ZIMVoIPConfig

Provides information about the iOS VoIP offline push.

Details

Provides information about the iOS VoIP offline push.

Declared in ZIMDefines.ts

Properties

iOSVoIPHandleType

iOSVoIPHandleType: ZIMCXHandleType

Description: The type of contact information for the VoIP caller, by default, is generic.

iOSVoIPHandleValue

iOSVoIPHandleValue: string

Description: The contact information of the VoIP caller. It is related to iOSVoIPHandleType. When iOSVoIPHandleType is PhoneNumber, the Value is a sequence of digits; when iOSVoIPHandleType is EmailAddress, the Value is an email address; when the contact information is of other types, the Value typically follows some domain-specific format, such as a username, numeric ID, or URL.

iOSVoIPHasVideo

iOSVoIPHasVideo: boolean

Description: Video call or not. The default value is audio

ZIMPushConfig

Description: Offline push configuration.

Details

Configuration before sending offline push.

Declared in ZIMDefines.ts

Properties

title

title: string

Description: Used to set the push title.Required: Not required.

content

content: string

Description: Used to set offline push content.Required: Not required.

payload

payload: string

Description: This parameter is used to set the pass-through field of offline push.Required: Not required.

resourcesID

resourcesID: string

Description: Offline push advanced configuration for mapping console Settings, with the maximum of 32 characters and defined by yourself.Required: Not required.

threadID

threadID: string

Description: Used to set the thread ID of offline push.Required: Not required.

enableBadge

enableBadge: boolean

Description: Push whether to carry corner information switch.

badgeIncrement

badgeIncrement: number

Description: The incremental index number carried by the push.

voIPConfig

voIPConfig: ZIMVoIPConfig

Description: If you use Flutter, RN ZPNs, offline push receiving device has iOS and uses VoIP push type, you can customize some VoIP options with this parameter.

privateMessageTemplate

privateMessageTemplate: ZIMOfflinePushPrivateMessageTemplate

Description: If you use OPPO Push, you can carry the push template through this field.

ZIMMessageReactionAddConfig

Add configuration for message reactions.

Details

Configuration class for adding message reactions.

Declared in ZIMDefines.ts

Properties

increaseCount

increaseCount: number

Description: When this value is greater than 0, the same user is allowed to react multiple times with the same reaction type, and the counts from those reactions will be accumulated.

ZIMMessageReactionUserInfo

reaction user information.

Details

A class describing reaction user.

Declared in ZIMDefines.ts

Properties

userID

userID: string

Description: user ID

ZIMMessageReaction

message reaction infos

Details

message reaction infos.

Declared in ZIMDefines.ts

Properties

reactionType

reactionType: string

Description: Type of reaction, defined by you, with a maximum length of 32 bytes.

conversationID

conversationID: string

Description: conversationID.

conversationType

conversationType: ZIMConversationType

Description: conversation type.

messageID

messageID: string

Detail description: reaction message ID.

messageSeq

messageSeq: number

Detail description: message sequence.

totalCount

totalCount: unsigned int

Description: The reaction users number.

isSelfIncluded

isSelfIncluded: boolean

Description: The reaciton users if included myself.

userList

userList: ZIMMessageReactionUserInfo[]

Description: Reaction user info list.

sumCount

sumCount: number

Detailed description: The sum count of reaction.

ZIMMessageReactionSimpleInfo

message reaction infos

Details

message reaction infos.

Declared in ZIMDefines.ts

Properties

reactionType

reactionType: string

Description: Type of reaction, defined by you, with a maximum length of 32 bytes.

sumCount

sumCount: number

Detailed description: The sum count of reaction.

ZIMMessageReactionUserFullInfo

message reaction user full information.

Details

A class describing reaction user.

Declared in ZIMDefines.ts

Properties

userID

userID: string

Description: user ID

reactions

reactions: ZIMMessageReactionSimpleInfo[]

Description: A list of summary information for the current user’s reactions under this message.

ZIMMessageReactionUserChangeInfo

User operation change information for message reactions.

Details

A class that describes reaction change information.

Declared in ZIMDefines.ts

Properties

userID

userID: string

user ID.

reactionType

reactionType: string

Type of reaction, defined by you, with a maximum length of 32 bytes.

action

action: ZIMMessageReactionUserChangeAction

reaction change action.

sumCount

sumCount: number

Description: The sum count for the current reaction type.

ZIMMessageLiteInfo

Base class of message lite info object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.ts

Properties

type

type: ZIMMessageType

Description: Message type.

ZIMTextMessageLiteInfo

Normal text message lite info object.

Declared in ZIMDefines.ts

Properties

message

message: string

Description: Text message content.

type

type: ZIMMessageType.Text

ZIMCustomMessageLiteInfo

Custom message lite information.

Declared in ZIMDefines.ts

Properties

message

message: string

Description: Custom message content.

searchedContent

searchedContent: string

Description: Custom message search content.

subType

subType: number

Description: Custom message sub-type.

type

type: ZIMMessageType.Custom

ZIMCombineMessageLiteInfo

Base class for combine message lite info objects.

Declared in ZIMDefines.ts

Properties

title

title: string

Description: Combine message title.

summary

summary: string

Description: Combine message summary.

type

type: ZIMMessageType.Combine

ZIMRevokeMessageLiteInfo

Base class for revoke message lite info objects.

Declared in ZIMDefines.ts

Properties

type

type: ZIMMessageType.Revoke

ZIMMediaMessageLiteInfo

Base class for media message lite info objects.

Declared in ZIMDefines.ts

Properties

fileSize

fileSize: number

Description: Media file size.

fileName

fileName: string

Description: Media file name.

fileLocalPath

fileLocalPath: File | string

Description: Media file local path.

fileDownloadUrl

fileDownloadUrl: string

Description: Media file download address.

ZIMImageMessageLiteInfo

Image message lite information.

Declared in ZIMDefines.ts

Properties

originalImageWidth

originalImageWidth: number

Description: Original image width.

originalImageHeight

originalImageHeight: number

Description: Original image height.

largeImageWidth

largeImageWidth: number

Description: Large image width.

largeImageHeight

largeImageHeight: number

Description: Large image height.

largeImageDownloadUrl

largeImageDownloadUrl: string

Description: Large image download address.

thumbnailWidth

thumbnailWidth: number

Description: Thumbnail image width.

thumbnailHeight

thumbnailHeight: number

Description: Thumbnail image height.

thumbnailDownloadUrl

thumbnailDownloadUrl: string

Description: Thumbnail image download address.

type

type: ZIMMessageType.Image

ZIMFileMessageLiteInfo

File message lite information.

Declared in ZIMDefines.ts

Properties

type

type: ZIMMessageType.File

ZIMAudioMessageLiteInfo

Audio message lite information.

Declared in ZIMDefines.ts

Properties

audioDuration

audioDuration: number

Description: Audio duration.

type

type: ZIMMessageType.Audio

ZIMVideoMessageLiteInfo

Video message lite information.

Declared in ZIMDefines.ts

Properties

videoDuration

videoDuration: number

Description: Video duration.

videoFirstFrameWidth

videoFirstFrameWidth: number

Description: Video first frame width.

videoFirstFrameHeight

videoFirstFrameHeight: number

Description: Video first frame height.

videoFirstFrameDownloadUrl

videoFirstFrameDownloadUrl: string

Description: Video first frame download address.

type

type: ZIMMessageType.Video

ZIMMultipleMessageLiteInfo

Multiple messages lite information.

Declared in ZIMDefines.ts

Properties

messageInfoList

messageInfoList: ZIMMessageLiteInfo[]

Description: Message list.

type

type: ZIMMessageType.Multiple

ZIMMessageRepliedInfo

The reply message refers to the information of the source message.

Declared in ZIMDefines.ts

Properties

state

state: ZIMMessageRepliedInfoState

Description: Message replied state.

messageInfo

messageInfo: ZIMMessageLiteInfo

Description: Replied message lite information.

senderUserID

senderUserID: string

Description: Sender user ID of the replied message.

sentTime

sentTime: number

Description: Sent time of the replied message.

messageID

messageID: string

Description: ID of the replied message.

messageSeq

messageSeq: number

Description: Sequence number of the replied message.

ZIMMessage

Base class of message object

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.ts

Caution：Some of the parameters, such as Message ID, only have values during the callback. Developers do not need to assign values to these parameters when they actively create this object for sending messages.

Properties

type

type: ZIMMessageType

Identifies the type of this message.

messageID

messageID: string

Description: The unique ID that identifies this message.Use cases: Can be used to index other messages.Caution: When the developer actively creates a message, there is no need to modify this parameter.This parameter only has a value during callback.

localMessageID

localMessageID: string

Description: SDK locally generated MessageID, developers do not need to pay attention to.

messageSeq

messageSeq: number

Description: The sequence number of the message.

senderUserID

senderUserID: string

Description：Displays the userID of the sender of this message.

conversationID

conversationID: string

Description: Conversation ID. Ids of the same conversation type are unique.

conversationType

conversationType: ZIMConversationType

Description: The type of conversation to which the message belongs.

direction

direction: ZIMMessageDirection

Description: Used to describe whether a message is sent or received.

sentStatus

sentStatus: ZIMMessageSentStatus

Description: Describes the sending status of a message.

timestamp

timestamp: unsigned long long

Description: Identifies the sending time of a messageUse cases: Used to present the sending time of a message, and can be used for message sorting.Caution: This is a standard UNIX timestamp, in milliseconds.

orderKey

orderKey: number

Description

larger the orderKey, the newer the message, and can be used for ordering messages.

isUserInserted

isUserInserted: boolean

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].Default: false.

receiptStatus

receiptStatus: ZIMMessageReceiptStatus

Detailed Description: Describe the receipt status of the messageBusiness scenario: used to determine the status of the current message in the receipt message

extendedData

extendedData: string

Description: message extension field Use cases: You can add extended fields to the message and send it to the peer Required: no Caution

length is 1k, you can contact technical support for configuration Available since: 2.6.0 or higher

localExtendedData

localExtendedData: string

Description: The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

reactions

reactions: ZIMMessageReaction[]

Description: Message statement list, which can carry data strongly related to users such as emoji expressions and voting information.

isBroadcastMessage

isBroadcastMessage: boolean

Description: Whether the message is pushed by all employees. Required: Internal assignment.

mentionedUserIDs

mentionedUserIDs: string[]

Description: Whether to mention everyone. It can be presented as "@User". Use cases: For example, it can be used in sending messages. Required: No. Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves. Available since: 2.14.0 or above

isMentionAll

isMentionAll: boolean

Description: Whether to mention everyone. It can be presented as "@Everyone". Use cases: For example, it can be used in groups or rooms. Required: No. Default value: false. Recommended value: Set to true if you need to mention everyone. Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves. Available since: 2.14.0 or above

repliedInfo

repliedInfo: ZIMMessageRepliedInfo

Description: Message reply information.

rootRepliedCount

rootRepliedCount: number

Description: Root replied count.

isServerMessage

isServerMessage: boolean

Whether the message was sent by the server.

editorUserID

editorUserID: string

Description: The userID of the message editor.

editedTime

editedTime: number

Description: The time of message editing.

isGroupTargetedMessage

isGroupTargetedMessage: boolean

Indicates whether the message is a group-targeted message.

pinnedUserID

pinnedUserID: string

Description: The userID of the message pinner.

pinnedTime

pinnedTime: number

Description: The time of message pinning.

destructTime

destructTime: number

Description: The timestamp at which the message will be destroyed.

ZIMMediaMessage

Base class for media message objects.

Details

Identifies a media message.

Declared in ZIMDefines.ts

Caution：This base class is the basis of all media messages and contains the properties required by media messages.

Properties

fileLocalPath

fileLocalPath: File | string

Detail description: The local path of the media message. Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.

fileDownloadUrl

fileDownloadUrl: string

Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.Required or not: If an external URL is sent, this parameter is mandatory on the sender end.

fileUID

fileUID: string

Detail description: The unique ID of the media file. Required or not: The sender does not need to fill in, this value is generated by the SDK.

fileName

fileName: string

Detail description: The filename of the media file. Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.

fileSize

fileSize: number

Detail description: The size of the media file. Required or not: The sender does not need to fill in, this value is generated by the SDK.

ZIMTextMessage

Normal text message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.ts

Caution：If the Type parameter of the base class is Text during callback, you can force the base class message object to be of this type.

Properties

message

message: string

The content of the text message.

type

type: ZIMMessageType.Text

ZIMCustomMessage

Custom message object.

Details

Identifies a custom message.

Declared in ZIMDefines.ts

Caution：When calling back, if the Type parameter of the base class is Custom, the base class message object can be forcibly converted to this class.

Properties

message

message: string

The content of the text message.

searchedContent

searchedContent: string

Description: The search content of the message.

subType

subType: unsigned int

Description: The subtype of the message, which is used by customers to customize the usage of different custom messages. Required: The sender is required, otherwise the message will fail to be sent.

type

type: ZIMMessageType.Custom

ZIMCommandMessage

Custom binary message object.

Details

Identifies a binary message.

Declared in ZIMDefines.ts

Caution：If the Type parameter of the base class is Custom during callback, you can force the base class message object to be of this type.

Properties

message

message: bytes

The content of the custom message.

type

type: ZIMMessageType.Command

ZIMBarrageMessage

Barrage message class.

Details

The barrage message class does not appear in the session and does not store historical messages.

Declared in ZIMDefines.ts

Properties

message

message: string

Description: The content of the barrage message.

type

type: ZIMMessageType.Barrage

ZIMImageMessage

Image message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.ts

Caution：If the Type parameter of the base class is Image during callback, you can force the base class message object to be of this type.

Properties

thumbnailDownloadUrl

thumbnailDownloadUrl: string

Detail description: Thumbnail external download URL of the image file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users. Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.

largeImageDownloadUrl

largeImageDownloadUrl: string

Detail description: large Image external download URL of the image file. When developers upload large Images to their own servers, the SDK can pass through this field to other users.Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.

originalImageWidth

originalImageWidth: number

Detailed description: The width of the original image.

originalImageHeight

originalImageHeight: number

Detailed description: The height of the original image.

largeImageWidth

largeImageWidth: number

Detailed description: The width of the large image.

largeImageHeight

largeImageHeight: number

Detailed description: The height of the large image.

thumbnailWidth

thumbnailWidth: number

Detailed description: The width of the thumbnail.

thumbnailHeight

thumbnailHeight: number

Detailed description: The height of the thumbnail.

type

type: ZIMMessageType.Image

ZIMFileMessage

File message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.ts

Caution：If the Type parameter of the base class is File during callback, you can force the base class message object to be of this type.

Properties

type

type: ZIMMessageType.File

ZIMAudioMessage

Audio message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.ts

Caution：If the Type parameter of the base class is Audio during callback, you can force the base class message object to be of this type.

Properties

audioDuration

audioDuration: unsigned int

Detail description: The duration of the audio file. Required: Required by the sender, if not filled, the audio message will fail to be sent When sending local audio messages.

type

type: ZIMMessageType.Audio

ZIMVideoMessage

Video message object.

Details

Identifies a video message.

Declared in ZIMDefines.ts

Caution：When the Type parameter of the base class in the callback is Video, the base class message object can be cast to this class.

Properties

videoDuration

videoDuration: unsigned int

Detail description: The duration of the video file. Required: Required by the sender, if not filled, the video message will fail to be sent when sending local video messages.

videoFirstFrameDownloadUrl

videoFirstFrameDownloadUrl: string

Detail description: Video first frame external download URL of the video file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users. Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.

videoFirstFrameWidth

videoFirstFrameWidth: number

Detailed description: The width of the first frame of the video.

videoFirstFrameHeight

videoFirstFrameHeight: number

Detailed description: The height of the first frame of the video.

type

type: ZIMMessageType.Video

ZIMRevokeMessage

Base class for revoke message objects.

Details

Identifies a revoke message.

Declared in ZIMDefines.ts

Caution：This base class is the basis of all revoke messages and contains the properties required by revoke messages.

Properties

revokeType

revokeType: ZIMRevokeType

Detail description: revoke type.

revokeTimestamp

revokeTimestamp: number

Detail description: revoke timestamp.

operatedUserID

operatedUserID: string

Detail description: operated user ID.

originalMessageType

originalMessageType: ZIMMessageType

Description: original message type

originalTextMessageContent

originalTextMessageContent: string

Detail description: original text message content, if the message to be revoked is not a text message, this field is empty.

revokeExtendedData

revokeExtendedData: string

Detail description: revoke extended data.

revokeStatus

revokeStatus: ZIMMessageRevokeStatus

Detail description: revoke status.

type

type: ZIMMessageType.Revoke

ZIMCombineMessage

Base class for combine message objects.

Details

Identifies a combine message.

Declared in ZIMDefines.ts

Caution：This base class is the basis of all combine messages and contains the properties required by combine messages.

Properties

title

title: string

Detail description: Combine message title.

summary

summary: string

Detail description: The summary of combine message.

combineID

combineID: string

Detail description: Combine ID, internal used

messageList

messageList: ZIMMessage[]

List of child messages

type

type: ZIMMessageType.Combine

ZIMTipsMessage

Tips message object.

Details

Identifies a tips info message.

Declared in ZIMDefines.ts

Caution：If the Type parameter of the base class is Tips during callback, you can force the base class message object to be of this type.

Properties

event

event: ZIMTipsMessageEvent

Detail description: Tips event type.

operatedUser

operatedUser: ZIMUserInfo

Detail description: Operated user information.

targetUserList

targetUserList: ZIMUserInfo[]

Detail description: Target user list.

changeInfo

changeInfo: ZIMTipsMessageChangeInfo

Detail description: Change information.

type

type: ZIMMessageType.Tips

ZIMMultipleMessage

Multiple message object.

Declared in ZIMDefines.ts

Properties

messageInfoList

messageInfoList: ZIMMessageLiteInfo[]

Detail description: List of content in the multiple message.

failedIndexList

failedIndexList: number[]

Detail description: List of failed index in the multiple message.

type

type: ZIMMessageType.Multiple

ZIMMessageRootRepliedInfo

Reply to the root message of the message tree.

Declared in ZIMDefines.ts

Properties

state

state: ZIMMessageRepliedInfoState

Description: Message replied state.

message

message: ZIMMessage

Description: Root message.

senderUserID

senderUserID: string

Description: Sender user ID of the root message.

sentTime

sentTime: number

Description: Sent time of the root message.

repliedCount

repliedCount: number

Description: Root replied count.

ZIMMessageRootRepliedCountInfo

Information about the number of replies in the reply message tree.

Declared in ZIMDefines.ts

Properties

messageID

messageID: string

Description: Message ID.

conversationID

conversationID: string

Description: Conversation ID.

conversationType

conversationType: ZIMConversationType

Description: Conversation type.

count

count: number

Description: Root replied count.

ZIMMessageMentionedInfo

message mention information.

Declared in ZIMDefines.ts

message mention information.

Properties

messageID

messageID: string

Description: Message ID, used to match the notification information to which message it belongs toRequired or not: Developers do not need to fill in.

messageSeq

messageSeq: number

Description: Message sequence number, used to match the notification information to which message it belongs toRequired or not: Developers do not need to fill in.

fromUserID

fromUserID: string

Description: From which user. Required: Developers do not need to fill in.

type

type: ZIMMessageMentionedType

Details Description: Type of notification, used to distinguish between reminding oneself and reminding everyone. Required: Developers do not need to fill in.

ZIMMessageReceivedInfo

A structure in which the message receiving event carries relevant information.

Declared in ZIMDefines.ts

Properties

conversationID

conversationID: string

Description: The ID of conversation.

conversationType

conversationType: ZIMConversationType

Description: The type of conversation.

isOfflineMessage

isOfflineMessage: boolean

Description: Whether it is an offline message.

ZIMMessageSendConfig

Configurations related to sending messages.

Details

Configurations related to sending messages.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Description: Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this. Required: Not mandatory.

priority

priority: ZIMMessagePriority

Enumeration value used to set message priority. Required: Must mandatory.

hasReceipt

hasReceipt: boolean

Detailed description: When sending a message, whether the message has a receipt.Business scenario: use when you need to bring a receipt for a message.Required: not required.Default value: false.

isNotifyMentionedUsers

isNotifyMentionedUsers: boolean

Whether to send push notifications to mentioned users.

isRetrySend

isRetrySend: boolean

Whether to resend the failed message.

disableUnreadMessageCount

disableUnreadMessageCount: boolean

When sending messages that would otherwise affect the other party's unread count, should they no longer be counted as unread by the other party? Whether required: Not required. Default value: false.

isAllowMultipleMessagePartialFailed

isAllowMultipleMessagePartialFailed: boolean

Whether to allow some sub-messages to fail to send when sending a multiple message. Whether required: Not required. Default value: false.

ZIMMessageQueryConfig

Example Query message configuration.

Details

Example Query the configurations of messages.

Declared in ZIMDefines.ts

Properties

nextMessage

nextMessage: ZIMMessage

Description: Query the anchor point of the message. Required: This parameter is not required for the first query but is required for subsequent paging queries.

count

count: unsigned int

Description: Number of query messages. Required: not required.

reverse

reverse: boolean

Description: Indicates whether the query is in reverse order. Required: not required. Default value: false.

mode

mode: ZIMMessageQueryMode

Description: Sets the mode for querying historical messages. Since the SDK can determine whether local data is complete and therefore return historical messages more quickly, it is recommended to use the default value in most cases. Required: No.

ZIMMessageRevokeConfig

Revoke configurations related to messages.

Details

Revoke configurations related to messages.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Description: Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this. Required: Not required.

revokeExtendedData

revokeExtendedData: string

Description: revoking additional messages. Required: Not required.

ZIMMessageDeleteConfig

Delete message configuration.

Details

Delete configurations related to messages.

Declared in ZIMDefines.ts

Properties

isAlsoDeleteServerMessage

isAlsoDeleteServerMessage: boolean

Description: Whether to remove flags for server messages. Required: not required. Default value: false.

ZIMMessageSendNotification

The notification callback when the message is sent, you can get the relevant information before the message object is sent through this notification

Details

Through this notification, developers can obtain relevant information before the message object is sent, such as localMessageID, etc.

Declared in ZIMDefines.ts

Use cases：When developers need to record and cache relevant information before sending a message, they can obtain it by listening to the notification.
Caution：If no monitoring is required, it can be passed [null].

Properties

onMessageAttached

onMessageAttached: ZIMMessageAttachedResult

Detail description: After the message falls into the local DB, the notification will be called back before the message is sent to the server. Business scenario: This interface can be used when the developer needs to obtain the relevant information in the message in advance before sending the message. Required: not required. If no monitoring is required, it can be passed empty. Default: empty.

onMediaUploadingProgress

onMediaUploadingProgress: ZIMMediaUploadingProgress

Description: Media file upload progress.

onMultipleMediaUploadingProgress

onMultipleMediaUploadingProgress: ZIMMultipleMediaUploadingProgress

Description: Multiple media file upload progress.

ZIMMediaMessageSendNotification

The notification callback when the media message is sent, you can get the relevant information before the message object is sent through this notification

Details

Through this notification, developers can obtain relevant information before the message object is sent, such as localMessageID, etc.

Declared in ZIMDefines.ts

Use cases：When developers need to record and cache relevant information before sending a message, they can obtain it by listening to the notification.
Caution：If no monitoring is required, it can be passed [null].

Properties

onMessageAttached

onMessageAttached: ZIMMessageAttachedResult

onMediaUploadingProgress

onMediaUploadingProgress: ZIMMediaUploadingProgress

Callback for media upload progress.

ZIMMessageReceiptInfo

receipt information.

Details

receipt information.

Declared in ZIMDefines.ts

Properties

status

status: ZIMMessageReceiptStatus

Detail description: receipt status.

messageID

messageID: string

Detailed Description: Message ID. Business scenario: Developers can match the loaded message list according to this ID. Is it required: No, SDK fills in.

conversationID

conversationID: string

Session ID.

conversationType

conversationType: ZIMConversationType

Session type.

readMemberCount

readMemberCount: unsigned int

Description: Number of read members.

unreadMemberCount

unreadMemberCount: unsigned int

Description: Number of unread members.

deliveredMemberCount

deliveredMemberCount: unsigned int

Description: Number of delivered members.

isSelfOperated

isSelfOperated: boolean

Description: Whether it is self-operated by multi-terminal.

readTime

readTime: number

Description: All the recipients have read the timestamp of that moment.

ZIMMessageReactionUserQueryConfig

Configuration for querying reaction user list

Details

When querying reaction member, you need to configure this object.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned long long

Description: The flag of the paging query. For the first query, set this field to an empty string. If the "nextFlag" field of the [ZIMMessageReactionUserListQueriedCallback] callback is not an empty string, it needs to be set here to continue the query on the next page.Required: Not required.

count

count: unsigned int

Description: How many members are retrieved in one query, 100 at most.Caution: To obtain members in pages to reduce overhead, it is recommended to obtain within 20 members at a time. If the value is 0, the SDK will query 100 members by default.Required: Required.

reactionType

reactionType: string

Description: reaction type, defined by you.

ZIMMessageSentStatusChangeInfo

Notice of Room Message Status Change.

Details

Notice of Room Message Status Change.

Declared in ZIMDefines.ts

Properties

status

status: ZIMMessageSentStatus

message sent status.

message

message: ZIMMessage

ZIMMessage.

reason

reason: string

This field stores the reason why a message was rejected by ZEGOCLOUD In-app Chat due to interception by the server-side callback on message not sent yer. If you have enabled the ZEGOCLOUD In-app Chat content moderation service and require this field to capture failure reasons caused by failed content moderation, contact ZEGOCLOUD Technical Support for configuration.

ZIMMessageSearchConfig

Message search configuration.

Details

Message search configuration.

Declared in ZIMDefines.ts

Properties

nextMessage

nextMessage: ZIMMessage

Paging fetch flag, which means fetching messages before or after nextMessage, with 'before' or 'after' determined by the order value. On the first search, nextMessage is null. On subsequent searches, nextMessage needs to pass in the last message in the message list queried last time.

count

count: unsigned int

count It is recommended to keep the number of items less than 20 to reduce performance overhead.

order

order: ZIMMessageOrder

When the 'order' is 'DESCENDING' during message search, it means querying messages with sending time earlier than nextMessage. If it's the first message query (i.e. nextMessage is null), then query from the last message stored locally forward. When 'order' is 'ASCENDING', it means querying messages with sending time later than nextMessage. If it's the first message query (i.e. nextMessage is null), then query from the first message stored locally backward. The default is 'DESCENDING'.

keywords

keywords: string[]

Search keywords, up to 5 keywords are supported, otherwise an error will be reported. For example: passing in '1' and '2' will make the search results only show messages that contain both keywords '1' and '2'.

messageTypes

messageTypes: ZIMMessageType[]

Message types, can be used to specify message types. Support passing in multiple types.

subMessageTypes

subMessageTypes: unsigned int[]

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

senderUserIDs

senderUserIDs: string[]

The user ID of the message sender, supporting up to 5 IDs. For example, if 'zego2023' is passed in, the search results will only display all the messages sent by the user 'zego2023' in that conversation.

startTime

startTime: number

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

endTime

endTime: number

The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.

ZIMMessageRepliedListQueryConfig

Configuration for querying reply message list.

Details

Configuration class for querying the replied message list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: number

The flag of paginated query. When querying for the first time, set this field to 0. If the 'nextFlag' field of the [queryMessageRepliedList] callback is not 0, it means that the query has not ended yet. You need to set it here to continue querying the next page.

count

count: number

The number of queries per query. The upper limit is 100. Exceeding 100 will result in an error.

ZIMMessageEditConfig

(Empty Class) Configurations related to editing messages.

Details

(Empty Class) Configurations related to editing messages.

Declared in ZIMDefines.ts

ZIMSendingMessageCancelConfig

(Empty Class) Configurations related to cancel sending messages.

Details

(Empty Class) Configurations related to cancel sending messages.

Declared in ZIMDefines.ts

ZIMMessagePinConfig

Pinning message configuration

Details

Pin configurations related to messages.

Declared in ZIMDefines.ts

Properties

disableAutoReplace

disableAutoReplace: boolean

When the number of pinned messages exceeds the limit, replacing older pinned messages in the pinned list during the next pin operation is not allowed. The default value is [false].

ZIMTipsMessageChangeInfo

Tips message additional information.

Details

Tips message additional information.

Declared in ZIMDefines.ts

Properties

type

type: ZIMTipsMessageChangeInfoType

Tips message additional information type.

ZIMTipsMessageGroupChangeInfo

Tips Additional information about change events related to the message group.

Details

Tips Additional information about change events related to the message group.

Declared in ZIMDefines.ts

Properties

groupDataFlag

groupDataFlag: number

If there are multiple changes in the group name, group avatar, and group announcement, you need to know which ones have changed based on the value of this field. Among them, 0b0001 is the group name, 0b0010 is the group notice, and 0b0100 is the group avatar.

groupName

groupName: string

If the group name is changed, the changed value will be displayed here.

groupNotice

groupNotice: string

If the group notice is changed, the changed value will be displayed here.

groupAvatarUrl

groupAvatarUrl: string

If the group avatar url is changed, the changed value will be displayed here.

groupMutedInfo

groupMutedInfo: ZIMGroupMuteInfo

If the group mute info is changed, the changed value will be displayed here.

ZIMTipsMessageGroupMemberChangeInfo

Tips Additional information about change events related to the message group member.

Details

Tips Additional information about change events related to the message group member.

Declared in ZIMDefines.ts

Properties

memberRole

memberRole: number

If a group member's role changes, the changed role will be displayed here.

muteExpiredTime

muteExpiredTime: number

If the group member's muting expired time changes, the new muting expired time will be displayed here.

groupNewOwner

groupNewOwner: ZIMGroupMemberSimpleInfo

Detailed description: tips message generated when the original group owner leaves the group and causes a change in the group owner. This field is true and indicates a newly created group owner.

ZIMTipsMessagePinStatusChangeInfo

Tips Additional information about change events related to the message pinned or unpined.

Details

Tips Additional information about change events related to the message pinned or unpined.

Declared in ZIMDefines.ts

Properties

isPinned

isPinned: boolean

Describes whether the current operation is a pin operation or an unpin operation.

ZIMMessagePinStatusChangeInfo

Notification of the message pinned status changed.

Details

When a message in a conversation is successfully pinned or unpinned and a notification is raised, this structure can be used to obtain the operated message and its current pinned status.

Declared in ZIMDefines.ts

Properties

pinStatus

pinStatus: ZIMMessagePinStatus

Message pin status

message

message: ZIMMessage

The message object whose pin status changed.

ZIMMessageReactionChangeInfo

message reaction change information.

Details

A class that describes reaction change information.

Declared in ZIMDefines.ts

Properties

message

message: ZIMMessage

Description: The message object containing updated reaction information, which can be used to directly replace the old data held by the developer.

userChangeInfoList

userChangeInfoList: ZIMMessageReactionUserChangeInfo[]

Description: A list of user reaction operation changes under the current message.

ZIMConversation

Session specific content.

Details

The specific content of the session.

Declared in ZIMDefines.ts

Properties

conversationID

conversationID: string

Conversation ID.

type

type: ZIMConversationType

Conversation type.

conversationName

conversationName: string

conversationName is the same as the groupName/userName value corresponding to the session.

conversationAvatarUrl

conversationAvatarUrl: string

Conversation avatar URL. The peer-to-peer conversation avatar URL is the same as the user avatar URL, and the group conversation avatar URL is the same as the group avatar URL.

conversationAlias

conversationAlias: string

After the friend remarks are set through [updateFriendAlias], this parameter is changed for each chat conversation. After setting a group alias by [updateGroupAlias], the corresponding group chat conversation's parameter will be modified synchronously.

notificationStatus

notificationStatus: ZIMConversationNotificationStatus

Conversation notification status.

unreadMessageCount

unreadMessageCount: number

Unread message count of the conversation.

lastMessage

lastMessage: ZIMMessage

The last message in the conversation.

orderKey

orderKey: number

OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.

isPinned

isPinned: boolean

Whether the conversation is pinned.

pinnedTime

pinnedTime: number

Description: The timestamp of conversation pinned.

mentionedInfoList

mentionedInfoList: ZIMMessageMentionedInfo[]

When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.

draft

draft: string

Conversation draft, when draft set conversation will carry this parameter.

marks

marks: number[]

Describes all the existing marks for the conversation.

readMessageSeq

readMessageSeq: number

Conversation read message sequence number.

isConversationDisabled

isConversationDisabled: boolean

Whether the conversation is unavailable.

selfMutedExpiredTime

selfMutedExpiredTime: number

The expiration timestamp of the self-mute for this conversation.

messageDestructDuration

messageDestructDuration: number

The timed message self-destruction duration for the conversation.

ZIMConversationBaseInfo

Conversation base information

Details

The base content of the session.

Declared in ZIMDefines.ts

Properties

conversationID

conversationID: string

Conversation ID. For single chat, the conversation ID is the other user ID. For group chat, the conversation ID is the group ID.

conversationType

conversationType: ZIMConversationType

Conversation type

ZIMGroupConversation

Group session object, extend from ZIMGroupConversation.

Details

Group session object, extend from ZIMGroupConversation.

Declared in ZIMDefines.ts

Properties

isDisabled

isDisabled: boolean

Whether the group session is unavailable.

mutedExpiredTime

mutedExpiredTime: number

The expiration date of the group gag.

ZIMConversationQueryConfig

Query the relevant configuration of the session.

Details

Configurable information when querying a session.

Declared in ZIMDefines.ts

Properties

nextConversation

nextConversation: ZIMConversation

Session that needs to be queried.

count

count: unsigned int

The number of sessions to query.

ZIMConversationFilterOption

Search filters related to the conversation.

Details

Configurable filter options when querying conversation list.

Declared in ZIMDefines.ts

Properties

conversationTypes

conversationTypes: ZIMConversationType[]

Conversation type list

marks

marks: number[]

Conversation mark list

isOnlyUnreadConversation

isOnlyUnreadConversation: boolean

Whether to query only unread conversations

pinnedFilter

pinnedFilter: ZIMConversationPinnedFilter

Conversation pinned filter

ZIMConversationTotalUnreadMessageCountQueryConfig

Search filters related to the conversation total unread message count.

Details

Configurable filter options when querying conversation total unread message count.

Declared in ZIMDefines.ts

Properties

conversationTypes

conversationTypes: ZIMConversationType[]

Conversation type list

marks

marks: number[]

Conversation mark list

ZIMConversationDeleteConfig

Conversation delete configuration

Details

Delete the related configuration of the session.

Declared in ZIMDefines.ts

Properties

isAlsoDeleteServerConversation

isAlsoDeleteServerConversation: boolean

Whether to delete server conversations at the same time

ZIMConversationChangeInfo

Conversation change information

Details

Contains information after session changes.

Declared in ZIMDefines.ts

Properties

event

event: ZIMConversationEvent

action

action: ZIMConversationListChangeAction

Conversation change action

conversation

conversation: ZIMConversation

Changed conversation

ZIMConversationSearchConfig

Conversation search configuration.

Details

Conversation search configuration.

Declared in ZIMDefines.ts

Properties

mode

mode: ZIMConversationSearchMode

Conversation search mode.

nextFlag

nextFlag: unsigned int

Pagination token, fill in 0 initially, and then fill in the nextFlag returned from the callback to retrieve data for the next page.

totalConversationCount

totalConversationCount: unsigned int

The number of messages that can be retrieved in one search. It is recommended to be less than 20 to reduce performance overhead.

keywords

keywords: string[]

Search keywords, supports up to 5. Otherwise, an error will occur. For example, if you pass in '1' and '2', the search results will only display conversations that contain both '1' and '2' keywords in the messages.

conversationMessageCount

conversationMessageCount: unsigned int

The number of local messages that can be retrieved for a single conversation in one search. It is recommended to be less than 10 to reduce performance overhead.

messageTypes

messageTypes: ZIMMessageType[]

Message types, can be used to specify message types. Support passing in multiple types.

subMessageTypes

subMessageTypes: unsigned int[]

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

senderUserIDs

senderUserIDs: string[]

Send user ID, supports up to 5. For example, if you pass in zego2023, the search results will only display conversations where messages have been sent by the user zego2023.

startTime

startTime: number

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

endTime

endTime: number

The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.

ZIMConversationSearchInfo

Conversation search result

Details

Information class for conversation search results.

Declared in ZIMDefines.ts

Properties

conversationID

conversationID: string

The conversation ID of the local message to be search.

conversationType

conversationType: ZIMConversationType

conversation type.

conversation

conversation: ZIMConversation

Conversation object.

totalMessageCount

totalMessageCount: unsigned int

Total message count.

messageList

messageList: ZIMMessage[]

Search results of messages.

ZIMRoomInfo

Room information object.

Details

Identifies a unique room.

Declared in ZIMDefines.ts

Properties

roomID

roomID: string

Room ID. a string with a maximum length of 128 bytes. It is customized by the developer and supports only digits, English characters, ~~, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~~'.

roomName

roomName: string

Room name, It is customized by the developer .a string with a maximum length of 64 bytes or less.

ZIMRoomFullInfo

The room details object.

Details

Identifies the detailed information of a room.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMRoomInfo

Room base information

ZIMRoomMemberInfo

Room user information.

Details

A class describing room user.

Declared in ZIMDefines.ts

ZIMRoomMemberQueryConfig

Configuration for querying room member.

Details

When querying member, you need to configure this object.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: string

The flag of the paging query. For the first query, set this field to an empty string. If the 'nextFlag' field of the callback is not an empty string, it needs to be set here to continue the query on the next page.

count

count: unsigned int

How many messages are retrieved in one query.

ZIMRoomAdvancedConfig

Room advanced configuration

Details

Room‘s advanced config.

Declared in ZIMDefines.ts

Properties

roomAttributes

roomAttributes: Map<string, string>

Room attributes of a room.

roomDestroyDelayTime

roomDestroyDelayTime: unsigned int

Room destruction time delayed, the unit is seconds. The maximum room destroy delay time is 3 hours.

ZIMRoomAttributesSetConfig

The behavior attribute set by the room attribute.

Details

The behavior attribute set by the room attribute.

Declared in ZIMDefines.ts

Properties

isForce

isForce: boolean

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.

isDeleteAfterOwnerLeft

isDeleteAfterOwnerLeft: boolean

Room attributes are automatically deleted after the owner leaves the room.

isUpdateOwner

isUpdateOwner: boolean

Whether to update the owner of the room attribute involved.

ZIMRoomAttributesBatchOperationConfig

The behavior attribute set by the room attribute.

Details

The behavior attribute set by the room attribute.

Declared in ZIMDefines.ts

Properties

isForce

isForce: boolean

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.

isDeleteAfterOwnerLeft

isDeleteAfterOwnerLeft: boolean

Room attributes are automatically deleted after the owner leaves the room.

isUpdateOwner

isUpdateOwner: boolean

Whether to update the owner of the room attribute involved.

ZIMRoomAttributesDeleteConfig

The behavior attribute set by the room attribute.

Details

The behavior attribute set by the room attribute.

Declared in ZIMDefines.ts

Properties

isForce

isForce: boolean

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be deleted.

ZIMRoomAttributesUpdateInfo

Room attribute update information

Details

Notice of Room Attribute Change.

Declared in ZIMDefines.ts

Properties

action

action: ZIMRoomAttributesUpdateAction

Behavioral information of room attribute change notification.

roomAttributes

roomAttributes: Map<string, string>

Room attributes.

ZIMRoomMemberAttributesInfo

Room user attribute information.

Details

Detail description: A class describing room user attributes, including UserID and its corresponding attributes.

Declared in ZIMDefines.ts

Properties

userID

userID: string

Detail description: User ID.

attributes

attributes: Map<string, string>

Detailed description: room user attributes.

ZIMRoomMemberAttributesOperatedInfo

Room user attribute operation information.

Details

Detail description: room user attribute operation information, including attributes of successful operation and keys of failure.

Declared in ZIMDefines.ts

Properties

attributesInfo

attributesInfo: ZIMRoomMemberAttributesInfo

Detailed description: room user attribute information.

errorKeys

errorKeys: string[]

Detail description: The key of the room user attribute operation failure.

ZIMRoomMemberAttributesUpdateInfo

Room user attribute update information.

Details

Detailed description: Room user attribute update information.

Declared in ZIMDefines.ts

Properties

attributesInfo

attributesInfo: ZIMRoomMemberAttributesInfo

Detailed description: room user attributes.

ZIMRoomMemberAttributesSetConfig

Room user property settings configuration.

Details

room user attribute setting configuration, including configurable whether to retain user attributes after the user leaves, etc.

Declared in ZIMDefines.ts

Use cases：When setting room user attributes, developers can choose to use them according to their actual application scenarios.

Properties

isDeleteAfterOwnerLeft

isDeleteAfterOwnerLeft: boolean

Default: true.

ZIMRoomMemberAttributesQueryConfig

Room member attribute query configuration

Details

Detailed description: room user attribute query configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: string

Detail description: Query anchor for room user properties.

count

count: unsigned int

count.

ZIMRoomOperatedInfo

Room operation information.

Details

Detailed description: Room operation information.

Declared in ZIMDefines.ts

Properties

userID

userID: string

Detail description: UserID of the operator.

ZIMGroupInfo

group information.

Details

group information.

Declared in ZIMDefines.ts

Properties

groupID

groupID: string

groupID.

groupName

groupName: string

Group name.

groupAvatarUrl

groupAvatarUrl: string

Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.

ZIMGroupMuteInfo

Group mute information.

Details

Group mute information.

Declared in ZIMDefines.ts

Properties

mode

mode: ZIMGroupMuteMode

Group mute mode.

expiredTime

expiredTime: number

Group mute expiration time, measured in seconds. When it's 0, there is no mute; when it's -1, it means permanent mute.

roles

roles: number[]

Detail description: Role list muted in the group.

ZIMGroupVerifyInfo

Verification mode for joining the group.

Details

Group verification information class, describing the group entry verification mode.

Declared in ZIMDefines.ts

Properties

joinMode

joinMode: ZIMGroupJoinMode

Verification mode for joining the group.

inviteMode

inviteMode: ZIMGroupInviteMode

Verification mode for invite to the group.

beInviteMode

beInviteMode: ZIMGroupBeInviteMode

Verification mode for being invited to the group.

ZIMGroupFullInfo

complete group information.

Details

complete group information.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMGroupInfo

basic group information.

groupNotice

groupNotice: string

Group of announcement.

groupAttributes

groupAttributes: Map<string, string>

group properties.

groupAlias

groupAlias: string

the group alias defined by user, which is visible only to that user.

notificationStatus

notificationStatus: ZIMGroupMessageNotificationStatus

group message notification status.

mutedInfo

mutedInfo: ZIMGroupMuteInfo

Group mute info.

createTime

createTime: number

The timestamp of the server when the group was created.

maxMemberCount

maxMemberCount: unsigned int

The maximum number of group members.

verifyInfo

verifyInfo: ZIMGroupVerifyInfo

Verification mode for joining the group.

ZIMGroup

complete group information for group list.

Details

complete group information for group list.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMGroupInfo

basic group information.

groupAlias

groupAlias: string

the group alias defined by user, which is visible only to that user.

notificationStatus

notificationStatus: ZIMGroupMessageNotificationStatus

group message notification status.

ZIMGroupMemberSimpleInfo

Group member simple information.

Details

Simple information class for group members.

Declared in ZIMDefines.ts

Properties

memberNickname

memberNickname: string

Group member nickname.

memberRole

memberRole: number

group role.

ZIMGroupEnterInfo

Information about group members when they join the group.

Details

Information class for a user entering a group.

Declared in ZIMDefines.ts

Properties

enterTime

enterTime: number

The timestamp of the server when joining the group.

enterType

enterType: ZIMGroupEnterType

Group entry type.

operatedUser

operatedUser: ZIMGroupMemberSimpleInfo

Group entry type.

ZIMGroupMemberInfo

Group member information.

Details

Group member information.

Declared in ZIMDefines.ts

Properties

memberNickname

memberNickname: string

Group member nickname.

memberRole

memberRole: number

group role.

muteExpiredTime

muteExpiredTime: number

Group member's mute expiration time. When it's 0, it means no mute; when it's -1, it means permanent mute.

groupEnterInfo

groupEnterInfo: ZIMGroupEnterInfo

Information about group members when they join the group.

ZIMGroupOperatedInfo

The group causes the event to change the operator's information.

Details

The group causes the event to change the operator's information.

Declared in ZIMDefines.ts

Properties

userID

userID: string

The operator's user ID.

userName

userName: string

The operator's username.

memberNickname

memberNickname: string

The operator's group member nickname.

memberRole

memberRole: number

The operator's group member role.

ZIMGroupMemberQueryConfig

group member query configuration.

Details

group member query configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

nextFlag.

count

count: unsigned int

count. Quantity, upper limit is 100, over 100 will be treated as 100.

ZIMGroupAdvancedConfig

Group advanced configuration.

Details

Group advanced configuration.

Declared in ZIMDefines.ts

Properties

groupNotice

groupNotice: string

group notice.

groupAttributes

groupAttributes: Map<string, string>

Group properties, up to 10 can be configured..

maxMemberCount

maxMemberCount: unsigned int

The maximum number of group members.

joinMode

joinMode: ZIMGroupJoinMode

Verification mode for joining the group.

inviteMode

inviteMode: ZIMGroupInviteMode

Verification mode for invite to the group.

beInviteMode

beInviteMode: ZIMGroupBeInviteMode

Verification mode for being invited to the group.

ZIMGroupAttributesUpdateInfo

Group attribute update information.

Details

Group attribute update information.

Declared in ZIMDefines.ts

Properties

action

action: ZIMGroupAttributesUpdateAction

Group attribute update action.

groupAttributes

groupAttributes: Map<string, string>

group properties.

ZIMGroupMessageReceiptMemberQueryConfig

Group message receipt read/unread member query configuration.

Details

Group message receipt read/unread member query configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

The pagination cursor. Set to 0 for the first query, then use the nextFlag from the [ZIMGroupMessageReceiptMemberListQueriedCallback] callback for subsequent pages.

count

count: unsigned int

The number of group members to query.

ZIMGroupMessageReceiptMemberListQueryConfig

Group message receipt member query configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

The pagination cursor. Set to 0 for the first query, then use the nextFlag from the [ZIMGroupMessageReceiptMemberListQueriedCallback] callback for subsequent pages.

filterType

filterType: ZIMMessageReceiptFilterType

Filter type for the receipt member list to query.

ZIMGroupSearchConfig

Group search configuration.

Details

Group search configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

The flag used to search groups.

count

count: unsigned int

count.

keywords

keywords: string[]

Search keywords. For example: passing in '1' and '2' will make the search results only show groups whose group names contain both keywords '1' and '2'.

isAlsoMatchGroupMemberUserName

isAlsoMatchGroupMemberUserName: boolean

Whether the search scope includes group member user names. Default is false.

isAlsoMatchGroupMemberNickname

isAlsoMatchGroupMemberNickname: boolean

Whether the search scope includes group member user nicknames. Default is false.

ZIMGroupSearchInfo

Group search info.

Details

Group search info.

Declared in ZIMDefines.ts

Properties

groupInfo

groupInfo: ZIMGroupInfo

group info.

userList

userList: ZIMGroupMemberInfo[]

Group member information.

ZIMGroupMemberSearchConfig

group member search configuration.

Details

group member search configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

The flag for querying, fill in 0 when calling the interface for the first time. When calling the interface again later, fill in the nextFlag returned from the callback to retrieve the remaining data.

count

count: unsigned int

count.

keywords

keywords: string[]

Search keywords, up to 5 keywords are supported, otherwise an error will be reported. For example: passing in '1' and '2' will make the search results only show group members whose names contain both keywords '1' and '2'.

isAlsoMatchGroupMemberNickname

isAlsoMatchGroupMemberNickname: boolean

Whether the search scope includes group member user nickname. Default is false.

ZIMGroupMuteConfig

Group mute configuration.

Details

Group mute configuration.

Declared in ZIMDefines.ts

Properties

mode

mode: ZIMGroupMuteMode

Group mute mode.

duration

duration: number

Group mute duration, the unit is seconds. The value is -1, which means permanent mute. If you need to implement non-permanent mute, the upper limit is 604800 (7 days). If you need to increase it, please contact ZEGO technical support.

roles

roles: number[]

Group role list.

ZIMGroupMemberMuteConfig

Group members mute configuration.

Details

Group members mute configuration.

Declared in ZIMDefines.ts

Properties

duration

duration: number

Group members mute duration, the unit is seconds. The value is -1, which means permanent mute. If you need to implement non-permanent mute, the upper limit is 604800 (7 days). If you need to increase it, please contact ZEGO technical support.

ZIMGroupMemberMutedListQueryConfig

Group muted member list query configuration.

Details

Group muted member list query configuration.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned long long

nextFlag.

count

count: unsigned int

count.

ZIMGroupApplicationInfo

Group application information.

Details

Group application information class, containing details of join or invite applications.

Declared in ZIMDefines.ts

Properties

type

type: ZIMGroupApplicationType

Group application type.

state

state: ZIMGroupApplicationState

Group application state.

groupInfo

groupInfo: ZIMGroupInfo

Group information for applying to join the group.

applyUser

applyUser: ZIMUserInfo

Detail description: The applicant is the applicant when applying to join, the invitee when applying to invite, and the inviter when applying by invitation.

createTime

createTime: number

Group application create time.

updateTime

updateTime: number

Group application status update time.

wording

wording: string

The wording of group application information.

operatedUser

operatedUser: ZIMGroupMemberSimpleInfo

The operator who agrees to join the group application.

ZIMGroupJoinApplicationSendConfig

The behavior property of the send group join application setting.

Details

Configuration class for sending group join applications.

Declared in ZIMDefines.ts

Properties

wording

wording: string

Postscript to the application operation.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMGroupJoinApplicationAcceptConfig

The behavior property of the accept group join application setting.

Details

Configuration class for accepting group join applications.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMGroupJoinApplicationRejectConfig

The behavior property of the reject group join application setting.

Details

Configuration class for rejecting group join applications.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMGroupInviteApplicationSendConfig

The behavior property of the send group invite application setting.

Details

Configuration class for sending group invite applications.

Declared in ZIMDefines.ts

Properties

wording

wording: string

Postscript to the application operation.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMGroupInviteApplicationAcceptConfig

The behavior property of the accept group invite application setting.

Details

Configuration class for accepting group invite applications.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMGroupInviteApplicationRejectConfig

The behavior property of the reject group invite application setting.

Details

Configuration class for rejecting group invite applications.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMGroupApplicationListQueryConfig

Query the group application configuration.

Details

Through this configuration, you can set the total number of queries and the pagination query.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

nextFlag.

count

count: unsigned int

count. It is advised to be no more than 30.

ZIMGroupListQueryConfig

Group list query configuration.

Details

Configuration class for querying the group list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: number

nextFlag.

userIDs

userIDs: string[]

Specify the list of users.

ZIMCallUserInfo

Call invitation user information.

Details

Call invitation user information.

Declared in ZIMDefines.ts

Properties

userID

userID: string

state

state: ZIMCallUserState

user status.

extendedData

extendedData: string

Call the additional information in user information.

ZIMCallInviteConfig

The behavior property of the Send Call Invitation setting.

Details

The behavior property of the Send Call Invitation setting.

Declared in ZIMDefines.ts

Properties

timeout

timeout: unsigned int

The timeout setting of the call invitation, the unit is seconds. The range is [1, 600].

mode

mode: ZIMCallInvitationMode

Call invitation mode configuration.

extendedData

extendedData: string

Extended field, through which the inviter can carry information to the invitee.

enableNotReceivedCheck

enableNotReceivedCheck: boolean

If the pass value is true, the system checks whether the call invitation is delivered in this call and subsequent calls.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMCallingInviteConfig

Behavior property set by quit a call invitation.

Details

Behavior property set by quit a call invitation.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMCallJoinConfig

Add the behavior attribute of the call invitation setting.<br/>.

Details

Add the behavior attribute of the call invitation setting.

Declared in ZIMDefines.ts

Properties

extendedData

extendedData: string

Extended field, through which the inviter can carry information to the invitee.

ZIMCallQuitConfig

Behavior property set by quit a call invitation.

Details

Behavior property set by quit a call invitation.

Declared in ZIMDefines.ts

Properties

extendedData

extendedData: string

Extended field, through which the inviter can carry information to the invitee.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMCallEndConfig

End the behavior attribute of the call invitation setting.

Details

End the behavior attribute of the call invitation setting.

Declared in ZIMDefines.ts

Properties

extendedData

extendedData: string

Extended field, through which the inviter can carry information to the invitee.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMCallCancelConfig

Behavior property that cancels the call invitation setting.

Details

Behavior property that cancels the call invitation setting.

Declared in ZIMDefines.ts

Properties

extendedData

extendedData: string

Extended field, through which the inviter can carry information to the invitee.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMCallAcceptConfig

Behavior property set by accepting a call invitation.

Details

Behavior property set by accepting a call invitation.

Declared in ZIMDefines.ts

Properties

extendedData

extendedData: string

Extended field, through which the inviter can carry information to the invitee.

ZIMCallRejectConfig

This parameter is used to set the configuration item of call invitation rejection.

Details

This command is used to customize the call invitation when sending invitation rejection.

Declared in ZIMDefines.ts

Use cases：You need to pass the configuration item to the interface when invoking the call rejection invitation.

Properties

extendedData

extendedData: string

Additional fields for attaching custom content when sending a reject invitation.

ZIMCallInvitationQueryConfig

Inquiry the setting attribute of the call invitation list.

Details

Inquiry the setting attribute of the call invitation list

Declared in ZIMDefines.ts

Properties

count

count: unsigned int

The query number is limited to up to 100.

nextFlag

nextFlag: number

The flag of the query list.No padding is required for the first query. After the query, callback will return a nextFlag, which can be filled in the next query to continue the query based on the last query.

ZIMCallInfo

Call invitation information.

Details

Call invitation information.

Declared in ZIMDefines.ts

Properties

callID

callID: string

Call invite ID.

caller

caller: string

Call invitation initiator ID.

inviter

inviter: string

The inviter ID of the call invitation.

createTime

createTime: number

Call invites to create a timestamp.

endTime

endTime: number

Call invitation end time.

state

state: ZIMCallState

Call invitation status.

mode

mode: ZIMCallInvitationMode

Call invitation mode.

extendedData

extendedData: string

Create a call invitation additional information.

callUserList

callUserList: ZIMCallUserInfo[]

The list of call member.

ZIMCallUserStateChangeInfo

Call member status change information.

Details

Call member status change information.

Declared in ZIMDefines.ts

Properties

callUserList

callUserList: ZIMCallUserInfo[]

List of call members whose status changes.

ZIMBlacklistQueryConfig

Query the blacklist configuration.

Details

Through this configuration, you can set the total number of queries and the pagination query.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

nextFlag.

count

count: unsigned int

count.

ZIMFriendAddConfig

The behavior property of the Add Friend setting.

Details

The behavior property of the Add Friend setting.

Declared in ZIMDefines.ts

Properties

friendAlias

friendAlias: string

Alias of friend.

friendAttributes

friendAttributes: Map<string, string>

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

wording

wording: string

Add a friend postscript.

ZIMFriendDeleteConfig

The behavior property of the Delete Friend setting.

Details

The behavior property of the Delete Friend setting.

Declared in ZIMDefines.ts

Properties

type

type: ZIMFriendDeleteType

Delete type.

ZIMFriendListQueryConfig

Query the configuration of the friend list.

Details

Query the configuration of the friend list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

The index of the current query anchor point.

count

count: unsigned int

Total number of current queries.

ZIMFriendSearchConfig

Friend search configuration.

Details

Configuration class for searching friends.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

nextFlag.

count

count: unsigned int

count.

keywords

keywords: string[]

isAlsoMatchFriendAlias

isAlsoMatchFriendAlias: boolean

Whether to match friend aliases.

ZIMFriendRelationCheckConfig

Check the behavior properties of friend relationships.

Details

Check the behavior properties of friend relationships.

Declared in ZIMDefines.ts

Properties

type

type: ZIMFriendRelationCheckType

Check type.

ZIMFriendRelationInfo

Friend relationship information.

Details

Detailed description: Friend relationship information.

Declared in ZIMDefines.ts

Properties

type

type: ZIMUserRelationType

Friend relationship type.

userID

userID: string

user ID.

ZIMFriendInfo

Friend information.

Details

Detailed description: Friend information.

Declared in ZIMDefines.ts

Properties

friendAlias

friendAlias: string

The alias of friend.

friendAttributes

friendAttributes: Map<string, string>

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

createTime

createTime: number

Friend add time.

wording

wording: string

Add a friend postscript.

ZIMFriendApplicationSendConfig

The behavior property of the Send Friend Application setting.

Details

The behavior property of the Send Friend Application setting.

Declared in ZIMDefines.ts

Properties

wording

wording: string

Add a friend postscript.

friendAlias

friendAlias: string

Alias of friend.

friendAttributes

friendAttributes: Map<string, string>

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMFriendApplicationAcceptConfig

Behavior attributes for accepting friend requests.

Details

Behavior attributes for accepting friend requests.

Declared in ZIMDefines.ts

Properties

friendAlias

friendAlias: string

friend alias.

friendAttributes

friendAttributes: Map<string, string>

friend attributes.

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMFriendApplicationRejectConfig

Behavior attributes for rejecting friend application.

Details

Behavior attributes for rejecting friend application.

Declared in ZIMDefines.ts

Properties

pushConfig

pushConfig: ZIMPushConfig

Offline push configuration.

ZIMFriendApplicationListQueryConfig

Query the configuration of the friend application list.

Details

Query the configuration of the friend application list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: unsigned int

The index of the current query anchor point.

count

count: unsigned int

Total number of current queries.

ZIMFriendApplicationInfo

Friend application information.

Details

Detailed description: Friend application information.

Declared in ZIMDefines.ts

Properties

type

type: ZIMFriendApplicationType

Friend application type.

state

state: ZIMFriendApplicationState

Friend application state.

applyUser

applyUser: ZIMUserInfo

Detail description: If you are the applicant, here is the respondent information; if you are the respondent, here is the applicant information;.

wording

wording: string

The wording of friend application information.

createTime

createTime: number

Friend add time.

updateTime

updateTime: number

Friend application status update time.

ZIMCommunityInfo

Basic community information.

Details

Community basic information class.

Declared in ZIMDefines.ts

Properties

communityID

communityID: string

The community ID.

communityName

communityName: string

The community name.

communityAvatarUrl

communityAvatarUrl: string

The URL of the community avatar.

ZIMCommunity

Community object.

Details

Community information class, containing basic attributes of a community.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMCommunityInfo

The basic information of the community.

totalUnreadMessageCount

totalUnreadMessageCount: unsigned int

The total unread message count across all channels.

ZIMCommunityFullInfo

Full community information.

Details

Community full information class, containing all attributes of a community.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMCommunityInfo

The basic information of the community.

communityNotice

communityNotice: string

The community notice.

communityAttributes

communityAttributes: Map<string, string>

The community attributes.

createTime

createTime: number

The time when the community was created.

creatorUserID

creatorUserID: string

The user ID of the community creator.

currentMemberCount

currentMemberCount: unsigned int

The current number of community members.

notificationStatus

notificationStatus: ZIMCommunityMessageNotificationStatus

The notification status of the community.

ZIMCommunityCreateConfig

Configuration for creating a community.

Details

Configuration class for creating a community.

Declared in ZIMDefines.ts

Properties

communityNotice

communityNotice: string

The community notice to set when creating the community.

communityAttributes

communityAttributes: Map<string, string>

The community attributes to set when creating the community.

ZIMCommunityListQueryConfig

Configuration for querying the community list.

Details

Configuration class for querying the community list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: number

The pagination flag for querying the next page.

ZIMCommunityChangeInfo

Community change information

Details

Community change information class, describing changes to community attributes.

Declared in ZIMDefines.ts

Properties

action

action: ZIMCommunityListChangeAction

Conmmunity change event

community

community: ZIMCommunity

Changed community

ZIMCommunityMemberListQueryConfig

Community member list query configuration

Details

Configuration class for querying the community member list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: number

The pagination flag for querying the next page.

channelID

channelID: string

The channel ID to query members from.

isMutedMember

isMutedMember: boolean

Whether to query only muted members.

ZIMCommunityFullInfoUpdateInfo

Community full info update information

Details

Community full information update notification class.

Declared in ZIMDefines.ts

Properties

communityInfo

communityInfo: ZIMCommunityFullInfo

Changed community full info

ZIMCommunityMemberEnterInfo

Community member enter information

Details

Information class for a member entering a community.

Declared in ZIMDefines.ts

Properties

enterTime

enterTime: number

The time when the member entered the community.

enterType

enterType: ZIMCommunityMemberEnterType

The type of how the member entered the community.

operatedUserID

operatedUserID: string

The user ID of the operator (e.g., the inviter).

ZIMCommunityMemberMuteInfo

Community member mute info

Details

Community member mute status information class.

Declared in ZIMDefines.ts

Properties

muteType

muteType: ZIMCommunityMemberMuteType

The mute type indicating which level the member is muted at.

channelID

channelID: string

The channel ID of the mute. Empty means muted at the community level.

muteExpiredTime

muteExpiredTime: number

The expiration time of the member's mute.

ZIMCommunityMemberInfo

Community member information

Details

Community member information class.

Declared in ZIMDefines.ts

Properties

memberRole

memberRole: number

The role of the community member.

enterInfo

enterInfo: ZIMCommunityMemberEnterInfo

The information about how the member entered the community.

muteInfo

muteInfo: ZIMCommunityMemberMuteInfo

The mute information of the community member.

ZIMCommunityMemberSimpleInfo

Community member simple information

Details

Simple community member information class.

Declared in ZIMDefines.ts

Properties

memberRole

memberRole: number

The role of the community member.

ZIMCommunityMemberStateChangeInfo

Community member state info change information

Details

Community member state change information class.

Declared in ZIMDefines.ts

Properties

state

state: ZIMCommunityMemberChangeState

The current state of the community member.

action

action: ZIMCommunityMemberChangeAction

The action type of the member state change.

memberInfo

memberInfo: ZIMCommunityMemberSimpleInfo

Changed community member simple info

ZIMCommunityMemberInfoUpdateInfo

Community member full info update information

Details

Community member information update notification class.

Declared in ZIMDefines.ts

Properties

memberInfo

memberInfo: ZIMCommunityMemberInfo

Changed community member info

ZIMCommunityChannelInfo

Basic community channel information.

Details

Community channel basic information class.

Declared in ZIMDefines.ts

Properties

channelID

channelID: string

The channel ID.

channelType

channelType: ZIMCommunityChannelType

The type of the community channel.

channelName

channelName: string

The channel name.

channelAvatarUrl

channelAvatarUrl: string

The URL of the channel avatar.

communityID

communityID: string

The ID of the community that the channel belongs to.

ZIMCommunityChannelMuteInfo

Community channel mute info

Details

Community channel mute status information class.

Declared in ZIMDefines.ts

Properties

mode

mode: ZIMCommunityChannelMuteMode

The mute mode of the community channel.

expiredTime

expiredTime: number

The expiration time of the channel mute.

roles

roles: number[]

The muted roles in the community channel.

ZIMCommunityChannel

Community channel object.

Details

Community channel information class, containing basic attributes of a channel.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMCommunityChannelInfo

The basic information of the community channel.

conversationID

conversationID: string

The conversation ID of the community channel.

channelAttributes

channelAttributes: Map<string, string>

The community channel attributes.

notificationStatus

notificationStatus: ZIMConversationNotificationStatus

The notification status of the community channel.

unreadMessageCount

unreadMessageCount: number

The number of unread messages in the community channel.

lastMessage

lastMessage: ZIMMessage

The last message in the community channel.

mentionedInfoList

mentionedInfoList: ZIMMessageMentionedInfo[]

The list of mention information in the community channel.

selfMutedExpiredTime

selfMutedExpiredTime: number

The expiration time of the local user's mute in the channel.

draft

draft: string

The draft message of the community channel.

ZIMCommunityChannelFullInfo

Full community channel information.

Details

Community channel full information class, containing all attributes of a channel.

Declared in ZIMDefines.ts

Properties

baseInfo

baseInfo: ZIMCommunityChannelInfo

The basic information of the community channel.

createTime

createTime: number

The time when the channel was created.

creatorUserID

creatorUserID: string

The user ID of the channel creator.

channelNotice

channelNotice: string

The community channel notice.

channelAttributes

channelAttributes: Map<string, string>

The community channel attributes.

currentMemberCount

currentMemberCount: number

The current number of channel members.

muteInfo

muteInfo: ZIMCommunityChannelMuteInfo

The mute information of the community channel.

ZIMCommunityChannelCreateConfig

Configuration for creating a community channel.

Details

Configuration class for creating a community channel.

Declared in ZIMDefines.ts

Properties

channelNotice

channelNotice: string

The channel notice to set when creating the channel.

channelAttributes

channelAttributes: Map<string, string>

The channel attributes to set when creating the channel.

ZIMCommunityChannelListQueryConfig

Configuration for querying the community channel list.

Details

Configuration class for querying the community channel list.

Declared in ZIMDefines.ts

Properties

nextFlag

nextFlag: number

The pagination flag for querying the next page.

ZIMCommunityChannelChangeInfo

Community channel change information.

Details

Community channel change information class, describing changes to channel attributes.

Declared in ZIMDefines.ts

Properties

action

action: ZIMCommunityChannelListChangeAction

The action type of the channel list change.

channel

channel: ZIMCommunityChannel

The changed community channel information.

ZIMCommunityChannelFullInfoUpdateInfo

Community channel full info update information

Details

Community channel full information update notification class.

Declared in ZIMDefines.ts

Properties

channelInfo

channelInfo: ZIMCommunityChannelFullInfo

Changed community channel full info

ZIMCommunityChannelMuteConfig

Community channel mute configuration

Details

Configuration class for muting a community channel.

Declared in ZIMDefines.ts

Properties

mode

mode: ZIMCommunityChannelMuteMode

The mute mode for the community channel.

roles

roles: number[]

The roles to mute. Empty means muting all roles.

duration

duration: number

The mute duration in seconds. 0 means unmute.

ZIMCommunityMemberMuteConfig

Community channel mute configuration

Details

Configuration class for muting community members.

Declared in ZIMDefines.ts

Properties

duration

duration: number

The mute duration in seconds. 0 means unmute.

channelID

channelID: string

The channel ID. Leave empty to mute at the community level.

ZIMConnectionStateChangedEventResult

The event callback when the connection state changes.

Declared in ZIMEventHandler.ts

Properties

state

state: ZIMConnectionState

Connection state

event

event: ZIMConnectionEvent

Connection event

extendedData

extendedData: string

Extra information when the event occurs, a standard JSON string

ZIMTokenWillExpireEventResult

A reminder callback that the token is about to expire.

Declared in ZIMEventHandler.ts

Properties

second

second: unsigned int

The remaining seconds before the token expires.

ZIMUserInfoUpdatedEventResult

Callback for user information update.

Declared in ZIMEventHandler.ts

Properties

info

info: ZIMUserFullInfo

User info

ZIMUserStatusUpdatedEventResult

User status change notification.

Declared in ZIMEventHandler.ts

Properties

userStatusList

userStatusList: ZIMUserStatus[]

User status list

ZIMUserRuleUpdatedEventResult

Callback of user rule changes.

Declared in ZIMEventHandler.ts

Properties

userRule

userRule: ZIMUserRule

User rule

ZIMConversationChangedEventResult

Received notification callback for session update.

Declared in ZIMEventHandler.ts

Properties

infoList

infoList: ZIMConversationChangeInfo[]

Conversation change info list

ZIMConversationsAllDeletedEventResult

Triggered when all conversations are deleted.

Declared in ZIMEventHandler.ts

Properties

count

count: number

Conversation count

ZIMConversationSyncStateChangedEventResult

Received notification callback for synchronizing conv list from server.

Declared in ZIMEventHandler.ts

Properties

state

state: ZIMConversationSyncState

Conversation synchronization state

ZIMConversationTotalUnreadMessageCountUpdatedEventResult

Notification callback for session total unread updates.

Declared in ZIMEventHandler.ts

Properties

totalUnreadMessageCount

totalUnreadMessageCount: number

Total unread message count

ZIMConversationMessageReceiptChangedEventResult

Callback for notifications of read updates for sessions that receive receipts.

Declared in ZIMEventHandler.ts

Properties

infos

infos: ZIMMessageReceiptInfo[]

Conversation message receipt change info list

ZIMMessageReceiptChangedEventResult

The notification callback for the read update of the message that received the receipt.

Declared in ZIMEventHandler.ts

Properties

infos

infos: ZIMMessageReceiptInfo[]

Message receipt change info list

ZIMMessageRevokeReceivedEventResult

The callback for receiving revoke message.

Declared in ZIMEventHandler.ts

Properties

messageList

messageList: ZIMRevokeMessage[]

Message revoke list

ZIMMessageReactionsChangedEventResult

The callback of the reactions change.

Declared in ZIMEventHandler.ts

Properties

reactions

reactions: ZIMMessageReaction[]

Message reaction change info list

changeInfoList

changeInfoList: ZIMMessageReactionChangeInfo[]

Message reaction change info list

ZIMMessageRepliedCountChangedEventResult

Reply to the event that the number of message trees has changed.

Declared in ZIMEventHandler.ts

Properties

infos

infos: ZIMMessageRootRepliedCountInfo[]

Message root reply count change info list

ZIMMessageRepliedInfoChangedEventResult

The reply information of a reply message is changed.

Declared in ZIMEventHandler.ts

Properties

messageList

messageList: ZIMMessage[]

Message replied info change info list

ZIMMessageDeletedEventResult

Callback when the message is deleted.

Declared in ZIMEventHandler.ts

Properties

conversationID

conversationID: string

Conversation ID

conversationType

conversationType: ZIMConversationType

Conversation type

messageDeleteType

messageDeleteType: ZIMMessageDeleteType

Message delete type

messageList

messageList: ZIMMessage[]

Message delete list. This parameter is valid when isDeleteConversationAllMessage is false and ZIMMessageDeleteType is [ZIMMessageDeleteTypeMessageListDeleted].

ZIMMessageSentStatusChangedEventResult

The callback for received message send status change.

Declared in ZIMEventHandler.ts

Properties

infos

infos: ZIMMessageSentStatusChangeInfo[]

Message sent status change info list

ZIMBroadcastMessageReceivedEventResult

The callback of the broadcast message received by all employees.

Declared in ZIMEventHandler.ts

Properties

message

message: ZIMMessage

Broadcast message

ZIMConversationMessageReceivedEventResult

The callback for receiving group message.

Declared in ZIMEventHandler.ts

Properties

messageList

messageList: ZIMMessage[]

Conversation message list

fromConversationID

fromConversationID: string

Message source conversation ID

info

info: ZIMMessageReceivedInfo

Message received info

ZIMMessageReceivedEventResult

Triggered when messages are received.

Declared in ZIMEventHandler.ts

Properties

messageList

messageList: ZIMMessage[]

message list

receivedInfo

receivedInfo: ZIMMessageReceivedInfo

Message received info

ZIMMessageEditedEventResult

The message edited event callback result.

Declared in ZIMEventHandler.ts

Properties

messageList

messageList: ZIMMessage[]

The message list.

ZIMMessagePinStatusChangedEventResult

The message pinned event callback result.

Declared in ZIMEventHandler.ts

Properties

infos

infos: ZIMMessagePinStatusChangeInfo[]

The message pin status change info list.

ZIMRoomStateChangedEventResult

event callback when the room connection status changes.

Declared in ZIMEventHandler.ts

Properties

roomID

roomID: string

Room ID

state

state: ZIMRoomState

Room state

event

event: ZIMRoomEvent

Room state change event

extendedData

extendedData: string

Extended data

ZIMRoomMemberChangedEventResult

Triggered when room members join or leave.

Declared in ZIMEventHandler.ts

Properties

roomID

roomID: string

Room ID

memberList

memberList: ZIMUserInfo[]

Room member list

ZIMRoomAttributesUpdatedEventResult

Notification of room property changes.

Declared in ZIMEventHandler.ts

Properties

roomID

roomID: string

Room ID

infos

infos: ZIMRoomAttributesUpdateInfo[]

Room attribute change info list

ZIMRoomMemberAttributesUpdatedEventResult

Room user property update callback.

Declared in ZIMEventHandler.ts

Properties

roomID

roomID: string

Room ID

infos

infos: ZIMRoomMemberAttributesUpdateInfo[]

Room member attribute change info list

operatedInfo

operatedInfo: ZIMRoomOperatedInfo

Operated info

ZIMGroupStateChangedEventResult

Group state change notification callback.

Declared in ZIMEventHandler.ts

Properties

state

state: ZIMGroupState

Group state

event

event: ZIMGroupEvent

Group state change event

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

groupInfo

groupInfo: ZIMGroupFullInfo

Group info

ZIMGroupNameUpdatedEventResult

Group name update notification callback.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

groupName

groupName: string

Group name

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupAvatarUrlUpdatedEventResult

Group avatar URL update notification callback.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

groupAvatarUrl

groupAvatarUrl: string

Group avatar URL

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupNoticeUpdatedEventResult

Notification callback for group announcement updates.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

groupNotice

groupNotice: string

Group notice

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupAliasUpdatedEventResult

Group alias update notification callback.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

groupAlias

groupAlias: string

Group alias

operatedUserID

operatedUserID: string

Operated user ID

ZIMGroupAttributesUpdatedEventResult

Group property update attributes callback.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

infoList

infoList: ZIMGroupAttributesUpdateInfo[]

Group attribute change info list

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupMutedInfoUpdatedEventResult

Notification callback for group mute info updates.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

mutedInfo

mutedInfo: ZIMGroupMuteInfo

Group mute info

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupVerifyInfoUpdatedEventResult

Notification callback for group verification mode update.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

verifyInfo

verifyInfo: ZIMGroupVerifyInfo

Group verify info

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupApplicationListChangedEventResult

This method will be called back when the group application list changes.

Declared in ZIMEventHandler.ts

Properties

action

action: ZIMGroupApplicationListChangeAction

Group application list change action

applicationList

applicationList: ZIMGroupApplicationInfo[]

Group application list

ZIMGroupApplicationUpdatedEventResult

This method will be called back when the group application list changes.

Declared in ZIMEventHandler.ts

Properties

applicationList

applicationList: ZIMGroupApplicationInfo[]

Group application list

ZIMGroupMemberStateChangedEventResult

Group member state change notification callback.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

state

state: ZIMGroupMemberState

Group member state

event

event: ZIMGroupMemberEvent

Group member state change event

userList

userList: ZIMGroupMemberInfo[]

Group member list

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMGroupMemberInfoUpdatedEventResult

Group member basic information change notification.

Declared in ZIMEventHandler.ts

Properties

groupID

groupID: string

Group ID

userList

userList: ZIMGroupMemberInfo[]

Group member list

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

Operated info

ZIMCallInvitationCreatedEventResult

The notification callback for the call invitation created by the caller.

Declared in ZIMEventHandler.ts

Properties

callID

callID: string

Call ID

mode

mode: ZIMCallInvitationMode

Call mode

caller

caller: string

Caller user ID

extendedData

extendedData: string

Extended data

timeout

timeout: number

Call timeout

createTime

createTime: number

Call create time

callUserList

callUserList: ZIMCallUserInfo[]

Call user list

ZIMCallInvitationReceivedEventResult

The notification callback for the call invitation received by the invitee.

Declared in ZIMEventHandler.ts

Properties

callID

callID: string

Call ID

mode

mode: ZIMCallInvitationMode

Call mode

caller

caller: string

Caller user ID

inviter

inviter: string

Inviter user ID

extendedData

extendedData: string

Extended data

timeout

timeout: number

Call timeout

createTime

createTime: number

Call create time

callUserList

callUserList: ZIMCallUserInfo[]

Call user list

ZIMCallInvitationCancelledEventResult

The notification callback received by the invitee to cancel the invitation.

Declared in ZIMEventHandler.ts

Properties

callID

callID: string

Call ID

mode

mode: ZIMCallInvitationMode

Call invitation mode.

inviter

inviter: string

Inviter user ID

extendedData

extendedData: string

Extended data

ZIMCallInvitationTimeoutEventResult

Callback for notification of called call invitation timeout.

Declared in ZIMEventHandler.ts

Properties

callID

callID: string

Call ID

mode

mode: ZIMCallInvitationMode

Call mode

ZIMCallInvitationEndedEventResult

Callback for notification of caller call invitation ended.

Declared in ZIMEventHandler.ts

Properties

callID

callID: string

Call ID

mode

mode: ZIMCallInvitationMode

Call mode

caller

caller: string

Caller user ID

operatedUserID

operatedUserID: string

Operated user ID

extendedData

extendedData: string

Extended data

endTime

endTime: number

Call end time

ZIMCallUserStateChangedEventResult

Call the notification of the user status in the invitation invitation.

Declared in ZIMEventHandler.ts

Properties

callID

callID: string

Call ID

callUserList

callUserList: ZIMCallUserInfo[]

Call user list

ZIMBlacklistChangedEventResult

This method will be called back when the blacklist is updated or changes occur.

Declared in ZIMEventHandler.ts

Properties

userList

userList: ZIMUserInfo[]

Blacklist user list

action

action: ZIMBlacklistChangeAction

Action type

ZIMFriendListChangedEventResult

This method will be called back when the friend list is updated or changes occur.

Declared in ZIMEventHandler.ts

Properties

friendList

friendList: ZIMFriendInfo[]

Friend list

action

action: ZIMFriendListChangeAction

Action type

ZIMFriendInfoUpdatedEventResult

This callback will be triggered when there is an update in the friend information.

Declared in ZIMEventHandler.ts

Properties

friendList

friendList: ZIMFriendInfo[]

Friend info list

ZIMFriendApplicationListChangedEventResult

Friend application list change event callback.

Declared in ZIMEventHandler.ts

Properties

applicationList

applicationList: ZIMFriendApplicationInfo[]

Friend application list

action

action: ZIMFriendApplicationListChangeAction

Action type

ZIMFriendApplicationUpdatedEventResult

The current method will be called when there is an update in the friend request list.

Declared in ZIMEventHandler.ts

Properties

applicationList

applicationList: ZIMFriendApplicationInfo[]

Friend application list

ZIMCommunityListChangedEventResult

Triggered when the community list changes.

Declared in ZIMEventHandler.ts

Properties

changeInfoList

changeInfoList: ZIMCommunityChangeInfo[]

List of community change information.

ZIMCommunityInfoUpdatedEventResult

Triggered when community information is updated.

Declared in ZIMEventHandler.ts

Properties

updateInfoList

updateInfoList: ZIMCommunityFullInfoUpdateInfo[]

List of community information updates.

ZIMCommunityMemberStateChangedEventResult

Triggered when a community member's state changes.

Declared in ZIMEventHandler.ts

Properties

communityID

communityID: string

Community ID.

changeInfoList

changeInfoList: ZIMCommunityMemberStateChangeInfo[]

List of community member state changes.

ZIMCommunityMemberInfoUpdatedEventResult

Triggered when community member information is updated.

Declared in ZIMEventHandler.ts

Properties

communityID

communityID: string

Community ID.

updateInfoList

updateInfoList: ZIMCommunityMemberInfoUpdateInfo[]

List of community member information updates.

ZIMCommunityChannelListChangedEventResult

Triggered when the community channel list changes.

Declared in ZIMEventHandler.ts

Properties

communityID

communityID: string

Community ID.

changeInfoList

changeInfoList: ZIMCommunityChannelChangeInfo[]

List of community channel changes.

ZIMCommunityChannelInfoUpdatedEventResult

Triggered when community channel information is updated.

Declared in ZIMEventHandler.ts

Properties

communityID

communityID: string

Community ID.

updateInfoList

updateInfoList: ZIMCommunityChannelFullInfoUpdateInfo[]

List of community channel information updates.

ZIMLogUploadedResult

Methods

onLogUploaded

type ZIMLogUploadedResult = () => void

Callback of the log upload result.

ZIMLoggedInResult

Methods

onLoggedIn

type ZIMLoggedInResult = () => void

Callback of the login result.

After the developer login, execute the callback of the result.

Use cases：Developers can use the [errorCode] in the callback to determine whether the login is successful.
Triggered when：When the developer calls the [login] interface, the callback will be triggered.

Available since：1.2.0 and above.

ZIMTokenRenewedResult

Methods

onTokenRenewed

type ZIMTokenRenewedResult = (token: string) => void

Callback of the result of renewing the token.

Parameters

Name	Type	Description
token	string	The renewed token.

ZIMUserNameUpdatedResult

Methods

onUserNameUpdated

type ZIMUserNameUpdatedResult = (userName: string) => void

Update the user name callback.

Parameters

Name	Type	Description
userName	string	The updated user name.

ZIMUserAvatarUrlUpdatedResult

Methods

onUserAvatarUrlUpdated

type ZIMUserAvatarUrlUpdatedResult = (userAvatarUrl: string) => void

Callback for updating the user avatar URL.

Parameters

Name	Type	Description
userAvatarUrl	string	The updated user avatar URL.

ZIMUserExtendedDataUpdatedResult

Methods

onUserExtendedDataUpdated

type ZIMUserExtendedDataUpdatedResult = (extendedData: string) => void

Update the user extended data callback.

Parameters

Name	Type	Description
extendedData	string	The updated user extended data.

ZIMUserCustomStatusUpdatedResult

Methods

onUserCustomStatusUpdated

type ZIMUserCustomStatusUpdatedResult = (customStatus: string) => void

The callback of the custom status update.

Parameters

Name	Type	Description
customStatus	string	The updated user custom status.

ZIMUsersInfoQueriedResult

Methods

onUsersInfoQueried

type ZIMUsersInfoQueriedResult = (userList: ZIMUserFullInfo[], errorUserList: ZIMErrorUserInfo[]) => void

Query the userInfo callback.

Parameters

Name	Type	Description
userList	ZIMUserFullInfo[]	The queried user information list.
errorUserList	ZIMErrorUserInfo[]	The list of user IDs that failed to be queried.

ZIMUserOfflinePushRuleUpdatedResult

Methods

onUserOfflinePushRuleUpdated

type ZIMUserOfflinePushRuleUpdatedResult = (offlinePushRule: ZIMUserOfflinePushRule) => void

Update the result callback of the user offline push rule.

Parameters

Name	Type	Description
offlinePushRule	ZIMUserOfflinePushRule	The updated user offline push rule.

ZIMSelfUserInfoQueriedResult

Methods

onSelfUserInfoQueried

type ZIMSelfUserInfoQueriedResult = (selfUserInfo: ZIMSelfUserInfo) => void

Callback result of querying personal user information and rules.

Parameters

Name	Type	Description
selfUserInfo	ZIMSelfUserInfo	The current user information and rules.

ZIMUsersStatusQueriedResult

Methods

onUsersStatusQueried

type ZIMUsersStatusQueriedResult = (userStatusList: ZIMUserStatus[], errorUserList: ZIMErrorUserInfo[]) => void

Result callback of the queryUsersStatus interface for batch querying user online status.

Parameters

Name	Type	Description
userStatusList	ZIMUserStatus[]	The queried user status list.
errorUserList	ZIMErrorUserInfo[]	The list of user IDs that failed to be queried.

ZIMUsersStatusSubscribedResult

Methods

onUsersStatusSubscribed

type ZIMUsersStatusSubscribedResult = (errorUserList: ZIMErrorUserInfo[]) => void

Callback for the operation results of the batch subscription interface.

Parameters

Name	Type	Description
errorUserList	ZIMErrorUserInfo[]	The list of user IDs that failed to subscribe.

ZIMUsersStatusUnsubscribedResult

Methods

onUsersStatusUnsubscribed

type ZIMUsersStatusUnsubscribedResult = (errorUserList: ZIMErrorUserInfo[]) => void

Callback for canceling the operations of subscribing interfaces in a batch.

Parameters

Name	Type	Description
errorUserList	ZIMErrorUserInfo[]	The list of user IDs that failed to unsubscribe.

ZIMSubscribedUserStatusListQueriedResult

Methods

onSubscribedUserStatusListQueried

type ZIMSubscribedUserStatusListQueriedResult = (userStatusSubscriptionList: ZIMUserStatusSubscription[]) => void

Query for the current user subscription list operation results callback.

Parameters

Name	Type	Description
userStatusSubscriptionList	ZIMUserStatusSubscription[]	The user status subscription list.

ZIMConversationQueriedResult

Methods

onConversationQueried

type ZIMConversationQueriedResult = (conversation: ZIMConversation) => void

Conversation query callback.

Parameters

Name	Type	Description
conversation	ZIMConversation	The queried conversation object.

ZIMConversationListQueriedResult

Methods

onConversationListQueried

type ZIMConversationListQueriedResult = (conversationList: ZIMConversation[]) => void

Session list query callback.

Parameters

Name	Type	Description
conversationList	ZIMConversation[]	The queried conversation list.

ZIMConversationTotalUnreadMessageCountQueriedResult

Methods

onConversationTotalUnreadMessageCountQueried

type ZIMConversationTotalUnreadMessageCountQueriedResult = (unreadMessageCount: number) => void

Query conversation unread total count callback.

Parameters

Name	Type	Description
unreadMessageCount	number	The total count of unread messages across all conversations.

ZIMConversationDeletedResult

Methods

onConversationDeleted

type ZIMConversationDeletedResult = (conversationID: string, conversationType: ZIMConversationType) => void

Callback for conversation deletion.

Parameters

Name	Type	Description
conversationID	string	The ID of the deleted conversation.
conversationType	ZIMConversationType	The type of the deleted conversation.

ZIMConversationsAllDeletedResult

Methods

onConversationsAllDeleted

type ZIMConversationsAllDeletedResult = () => void

Callback for conversations deletion.

ZIMConversationUnreadMessageCountClearedResult

Methods

onConversationUnreadMessageCountCleared

type ZIMConversationUnreadMessageCountClearedResult = (conversationID: string, conversationType: ZIMConversationType) => void

Callback for session unread clearing.

Parameters

Name	Type	Description
conversationID	string	The conversation ID whose unread message count was cleared.
conversationType	ZIMConversationType	The conversation type whose unread message count was cleared.

ZIMConversationTotalUnreadMessageCountClearedResult

Methods

onConversationTotalUnreadMessageCountCleared

type ZIMConversationTotalUnreadMessageCountClearedResult = () => void

Callback for sessions unread clearing.

ZIMConversationNotificationStatusSetResult

Methods

onConversationNotificationStatusSet

type ZIMConversationNotificationStatusSetResult = (conversationID: string, conversationType: ZIMConversationType) => void

Callback for conversation notification state settings.

Parameters

Name	Type	Description
conversationID	string	The conversation ID for which the notification status was set.
conversationType	ZIMConversationType	The conversation type for which the notification status was set.

ZIMConversationMessageReceiptReadSentResult

Methods

onConversationMessageReceiptReadSent

type ZIMConversationMessageReceiptReadSentResult = (conversationID: string, conversationType: ZIMConversationType) => void

Callback interface for setting the read receipt conversation.

Parameters

Name	Type	Description
conversationID	string	The conversation ID for which the receipt was sent.
conversationType	ZIMConversationType	The conversation type for which the receipt was sent.

ZIMConversationPinnedStateUpdatedResult

Methods

onConversationPinnedStateUpdated

type ZIMConversationPinnedStateUpdatedResult = (conversationID: string, conversationType: ZIMConversationType) => void

Callback for conversation pinned state updated.

Parameters

Name	Type	Description
conversationID	string	The conversation ID whose pinned state was updated.
conversationType	ZIMConversationType	The conversation type whose pinned state was updated.

ZIMConversationPinnedListQueriedResult

Methods

onConversationPinnedListQueried

type ZIMConversationPinnedListQueriedResult = (conversationList: ZIMConversation[]) => void

Callback for querying the pinned conversation list.

Parameters

Name	Type	Description
conversationList	ZIMConversation[]	The queried pinned conversation list.

ZIMConversationDraftSetResult

Methods

onConversationDraftSet

type ZIMConversationDraftSetResult = (conversationID: string, conversationType: ZIMConversationType) => void

Sets the callback for the session draft.

Parameters

Name	Type	Description
conversationID	string	The conversation ID for which the draft was set.
conversationType	ZIMConversationType	The conversation type for which the draft was set.

ZIMConversationMarkSetResult

Methods

onConversationMarkSet

type ZIMConversationMarkSetResult = (failedConversationInfos: ZIMConversationBaseInfo[]) => void

Callback for conversation mark set.

Parameters

Name	Type	Description
failedConversationInfos	ZIMConversationBaseInfo[]	The list of conversation info objects that failed to have marks set.

ZIMConversationMessageDestructDurationSetResult

Methods

onConversationMessageDestructDurationSet

type ZIMConversationMessageDestructDurationSetResult = (conversationID: string, conversationType: ZIMConversationType) => void

Callback for the result of setting the message self-destruction duration in a conversation.

Parameters

Name	Type	Description
conversationID	string	The ID of the conversation for which the setting was applied.
conversationType	ZIMConversationType	The type of the conversation for which the setting was applied.

ZIMConversationsSearchedResult

Methods

onConversationsSearched

type ZIMConversationsSearchedResult = (conversationSearchInfoList: ZIMConversationSearchInfo[], nextFlag: number) => void

Search for the return of local conversations results based on local messages.

Parameters

Name	Type	Description
conversationSearchInfoList	ZIMConversationSearchInfo[]	The list of searched conversation results.
nextFlag	number	Anchor for the next page query.

ZIMMessageSentResult

Methods

onMessageSent

type ZIMMessageSentResult = (message: ZIMMessage) => void

Callback of the result of sending the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.

ZIMMessageAttachedResult

Methods

onMessageAttached

type ZIMMessageAttachedResult = (message: ZIMMessage) => void

The incoming message object is given a localMessgeID and returned.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.

ZIMMediaUploadingProgress

Methods

onMediaUploadingProgress

type ZIMMediaUploadingProgress = (message: ZIMMediaMessage, currentFileSize: unsigned long long, totalFileSize: unsigned long long) => void

Progress callback for sending media messages.

Parameters

Name	Type	Description
message	ZIMMediaMessage	Media message object.
currentFileSize	unsigned long long	Current file size.
totalFileSize	unsigned long long	Total file size.

ZIMMultipleMediaUploadingProgress

Methods

onMultipleMediaUploadingProgress

type ZIMMultipleMediaUploadingProgress = (message: ZIMMultipleMessage, currentFileSize: number, totalFileSize: number, messageInfoIndex: number, currentIndexFileSize: number, totalIndexFileSize: number) => void

Callback for multiple media file upload progress.

Parameters

Name	Type	Description
message	ZIMMultipleMessage	Multiple media message object.
currentFileSize	number	Current file size.
totalFileSize	number	Total file size.
messageInfoIndex	number	Current message index.
currentIndexFileSize	number	Current index file size.
totalIndexFileSize	number	Total index file size.

ZIMMessageQueriedResult

Methods

onMessageQueried

type ZIMMessageQueriedResult = (conversationID: string, conversationType: ZIMConversationType, messageList: ZIMMessage[]) => void

The developer uses this callback to get a list of queried messages, which can be used to display historical messages.

Parameters

Name	Type	Description
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
messageList	ZIMMessage[]	Message list.

ZIMMessageDeletedResult

Methods

onMessageDeleted

type ZIMMessageDeletedResult = (conversationID: string, conversationType: ZIMConversationType) => void

A callback to delete a message.

Parameters

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

ZIMConversationMessagesAllDeletedResult

Methods

onConversationMessagesAllDeleted

type ZIMConversationMessagesAllDeletedResult = () => void

Deletes callbacks of all messages for all sessions.

ZIMMessageRevokedResult

Methods

onMessageRevoked

type ZIMMessageRevokedResult = (message: ZIMMessage) => void

Retracted news consequential reconciliation.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.

ZIMMessageInsertedResult

Methods

onMessageInserted

type ZIMMessageInsertedResult = (message: ZIMMessage) => void

Callback of the result of inserting the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.

ZIMMessageLocalExtendedDataUpdatedResult

Methods

onMessageLocalExtendedDataUpdated

type ZIMMessageLocalExtendedDataUpdatedResult = (message: ZIMMessage) => void

Callback for updating message local extension fields.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.

ZIMMessageReceiptsReadSentResult

Methods

onMessageReceiptsReadSent

type ZIMMessageReceiptsReadSentResult = (conversationID: string, conversationType: ZIMConversationType, errorMessageIDs: string[]) => void

Callback interface for setting the read receipt message.

Parameters

Name	Type	Description
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorMessageIDs	string[]	Error message ID list.

ZIMMessageReceiptsInfoQueriedResult

Methods

onMessageReceiptsInfoQueried

type ZIMMessageReceiptsInfoQueriedResult = (infos: ZIMMessageReceiptInfo[], errorMessageIDs: string[]) => void

Callback interface for query receipt message read.

Parameters

Name	Type	Description
infos	ZIMMessageReceiptInfo[]	Message receipt information list.
errorMessageIDs	string[]	Error message ID list.

ZIMMessagesSearchedResult

Methods

onMessagesSearched

type ZIMMessagesSearchedResult = (conversationID: string, conversationType: ZIMConversationType, messageList: ZIMMessage[], nextMessage: ZIMMessage) => void

Return of local message search results.

Parameters

Name	Type	Description
conversationID	string	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
messageList	ZIMMessage[]	Message list.
nextMessage	ZIMMessage	Next message object.

ZIMMessagesGlobalSearchedResult

Methods

onMessagesGlobalSearched

type ZIMMessagesGlobalSearchedResult = (messageList: ZIMMessage[], nextMessage: ZIMMessage) => void

Return of local message search results.

Parameters

Name	Type	Description
messageList	ZIMMessage[]	Message list.
nextMessage	ZIMMessage	Next message object.

ZIMMessageReactionAddedResult

Methods

onMessageReactionAdded

type ZIMMessageReactionAddedResult = (reaction: ZIMMessageReaction) => void

The addition of return for message reactions.

Parameters

Name	Type	Description
reaction	ZIMMessageReaction	Message reaction object.

ZIMMessageReactionDeletedResult

Methods

onMessageReactionDeleted

type ZIMMessageReactionDeletedResult = (reaction: ZIMMessageReaction) => void

The delete of return for message reactions.

Parameters

Name	Type	Description
reaction	ZIMMessageReaction	Message reaction object.

ZIMMessageReactionUserListQueriedResult

Methods

onMessageReactionUserListQueried

type ZIMMessageReactionUserListQueriedResult = (message: ZIMMessage, userInfoList: ZIMMessageReactionUserFullInfo[], reactionType: string, nextFlag: number, totalCount: number) => void

The return of the query for the details of the reaction.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
userInfoList	ZIMMessageReactionUserFullInfo[]	List of user reaction information.
reactionType	string	Message reaction type.
nextFlag	number	List query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out.
totalCount	number	Total user count.

ZIMCombineMessageDetailQueriedResult

Methods

onCombineMessageDetailQueried

type ZIMCombineMessageDetailQueriedResult = (message: ZIMCombineMessage) => void

Result callback for querying merge message details.

Parameters

Name	Type	Description
message	ZIMCombineMessage	Combine message object. The messageList in this object already contains the sub-message list of the merged message.

ZIMMessageRepliedListQueriedResult

Methods

onMessageRepliedListQueried

type ZIMMessageRepliedListQueriedResult = (messageList: ZIMMessage[], nextFlag: number, rootRepliedInfo: ZIMMessageRootRepliedInfo) => void

The callback for querying the reply message list result.

Parameters

Name	Type	Description
messageList	ZIMMessage[]	Message list.
nextFlag	number	List query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out.
rootRepliedInfo	ZIMMessageRootRepliedInfo	Root message reply information.

ZIMMessageEditedResult

Methods

onMessageEdited

type ZIMMessageEditedResult = (message: ZIMMessage) => void

Callback of the result of editing the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.

ZIMSendingMessageCancelledResult

Methods

onSendingMessageCancelled

type ZIMSendingMessageCancelledResult = () => void

Callback of the result of cancel sending the message.

ZIMMessagePinnedResult

Methods

onMessagePinned

type ZIMMessagePinnedResult = () => void

Callback of the result of the message to be pinned or unpinned.

ZIMPinnedMessageListQueriedResult

Methods

onPinnedMessageListQueried

type ZIMPinnedMessageListQueriedResult = (messageList: ZIMMessage[]) => void

The developer uses this callback to get a list of queried pinned messages, which can be used to display pinned messages.

Parameters

Name	Type	Description
messageList	ZIMMessage[]	Message list.

ZIMRoomCreatedResult

Methods

onRoomCreated

type ZIMRoomCreatedResult = (roomInfo: ZIMRoomFullInfo) => void

Callback of the result of creating the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.

ZIMRoomJoinedResult

Methods

onRoomJoined

type ZIMRoomJoinedResult = (roomInfo: ZIMRoomFullInfo) => void

Callback of the result of joining the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.

ZIMRoomEnteredResult

Methods

onRoomEntered

type ZIMRoomEnteredResult = (roomInfo: ZIMRoomFullInfo) => void

Callback of the result of entering the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.

ZIMRoomSwitchedResult

Methods

onRoomSwitched

type ZIMRoomSwitchedResult = (roomInfo: ZIMRoomFullInfo) => void

Callback of the result of switched rooms.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.

ZIMRoomLeftResult

Methods

onRoomLeft

type ZIMRoomLeftResult = (roomID: string) => void

Callback of the result of leaving the room.

Parameters

Name	Type	Description
roomID	string	Room ID.

ZIMRoomAllLeftResult

Methods

onRoomAllLeft

type ZIMRoomAllLeftResult = (roomIDs: string[]) => void

Callback for the results of leaving all rooms.

Parameters

Name	Type	Description
roomIDs	string[]	Room ID list.

ZIMRoomMemberQueriedResult

Methods

onRoomMemberQueried

type ZIMRoomMemberQueriedResult = (roomID: string, memberList: ZIMUserInfo[], nextFlag: string) => void

Callback of the result of querying the room members list.

Parameters

Name	Type	Description
roomID	string	Room ID.
memberList	ZIMUserInfo[]	Room member list.
nextFlag	string	Used to query the next page. The current value returns an empty string, which means that the list has been pulled out.

ZIMRoomMembersQueriedResult

Methods

onRoomMembersQueried

type ZIMRoomMembersQueriedResult = (roomID: string, memberList: ZIMRoomMemberInfo[], errorUserList: ZIMErrorUserInfo[]) => void

Callback for the result of querying the specified member of the room.

Parameters

Name	Type	Description
roomID	string	Room ID.
memberList	ZIMRoomMemberInfo[]	Room member list.
errorUserList	ZIMErrorUserInfo[]	Error member list.

ZIMRoomOnlineMemberCountQueriedResult

Methods

onRoomOnlineMemberCountQueried

type ZIMRoomOnlineMemberCountQueriedResult = (roomID: string, count: unsigned int) => void

Callback of the result of querying the online members count in the room.

Parameters

Name	Type	Description
roomID	string	Room ID.
count	unsigned int	Online member count.

ZIMRoomAttributesOperatedResult

Methods

onRoomAttributesOperated

type ZIMRoomAttributesOperatedResult = (roomID: string, errorKeys: string[]) => void

The return of the operation result of the room attribute.

Parameters

Name	Type	Description
roomID	string	Room ID.
errorKeys	string[]	Error key list.

ZIMRoomAttributesBatchOperatedResult

Methods

onRoomAttributesBatchOperated

type ZIMRoomAttributesBatchOperatedResult = (roomID: string) => void

The return of the result of the room attribute combination operation.

Parameters

Name	Type	Description
roomID	string	Room ID.

ZIMRoomAttributesQueriedResult

Methods

onRoomAttributesQueried

type ZIMRoomAttributesQueriedResult = (roomID: string, roomAttributes: Map<string, string>) => void

Return of room attribute query results.

Parameters

Name	Type	Description
roomID	string	Room ID.
roomAttributes	Map<string, string>	Room attributes.

ZIMRoomMembersAttributesOperatedResult

Methods

onRoomMembersAttributesOperated

type ZIMRoomMembersAttributesOperatedResult = (roomID: string, infos: ZIMRoomMemberAttributesOperatedInfo[], errorUserList: string[]) => void

Callback of the result of setting room member attributes.

Parameters

Name	Type	Description
roomID	string	Room ID.
infos	ZIMRoomMemberAttributesOperatedInfo[]	Room member attribute operation information list.
errorUserList	string[]	Error member list.

ZIMRoomMembersAttributesQueriedResult

Methods

onRoomMembersAttributesQueried

type ZIMRoomMembersAttributesQueriedResult = (roomID: string, infos: ZIMRoomMemberAttributesInfo[]) => void

Returns the results of batch query of room user attributes.

Parameters

Name	Type	Description
roomID	string	Room ID.
infos	ZIMRoomMemberAttributesInfo[]	Room member attribute information list.

ZIMRoomMemberAttributesListQueriedResult

Methods

onRoomMemberAttributesListQueried

type ZIMRoomMemberAttributesListQueriedResult = (roomID: string, infos: ZIMRoomMemberAttributesInfo[], nextFlag: string) => void

Returns the query result of the user attribute list in the room.

Parameters

Name	Type	Description
roomID	string	Room ID.
infos	ZIMRoomMemberAttributesInfo[]	Room member attribute information list.
nextFlag	string	Used to query the next page. The current value returns 0, which means that the list has been pulled out.

ZIMGroupCreatedResult

Methods

onGroupCreated

type ZIMGroupCreatedResult = (groupInfo: ZIMGroupFullInfo, userList: ZIMGroupMemberInfo[], errorUserList: ZIMErrorUserInfo[]) => void

Returns the result of creating a group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.
userList	ZIMGroupMemberInfo[]	Group member information list.
errorUserList	ZIMErrorUserInfo[]	Error member list.

ZIMGroupDismissedResult

Methods

onGroupDismissed

type ZIMGroupDismissedResult = (groupID: string) => void

Returns the result of dismissing the group.

Parameters

Name	Type	Description
groupID	string	Group ID.

ZIMGroupJoinedResult

Methods

onGroupJoined

type ZIMGroupJoinedResult = (groupInfo: ZIMGroupFullInfo) => void

Returns the result of joining the group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.

ZIMGroupLeftResult

Methods

onGroupLeft

type ZIMGroupLeftResult = (groupID: string) => void

Return of the result of leaving the group.

Parameters

Name	Type	Description
groupID	string	Group ID.

ZIMGroupUsersInvitedResult

Methods

onGroupUsersInvited

type ZIMGroupUsersInvitedResult = (groupID: string, userList: ZIMGroupMemberInfo[], errorUserList: ZIMErrorUserInfo[]) => void

The result of the user being invited to the group is returned.

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	ZIMGroupMemberInfo[]	Group member information list.
errorUserList	ZIMErrorUserInfo[]	Error member list.

ZIMGroupMemberKickedResult

Methods

onGroupMemberKicked

type ZIMGroupMemberKickedResult = (groupID: string, kickedUserIDList: string[], errorUserList: ZIMErrorUserInfo[]) => void

Returns the result of kicking out a group member.

Parameters

Name	Type	Description
groupID	string	Group ID.
kickedUserIDList	string[]	List of user IDs kicked out.
errorUserList	ZIMErrorUserInfo[]	Error member list.

ZIMGroupOwnerTransferredResult

Methods

onGroupOwnerTransferred

type ZIMGroupOwnerTransferredResult = (groupID: string, toUserID: string) => void

Returns the result of the group owner assignment.

Parameters

Name	Type	Description
groupID	string	Group ID.
toUserID	string	New group owner user ID.

ZIMGroupNameUpdatedResult

Methods

onGroupNameUpdated

type ZIMGroupNameUpdatedResult = (groupID: string, groupName: string) => void

Returns the result of the group name update.

Parameters

Name	Type	Description
groupID	string	Group ID.
groupName	string	Group name.

ZIMGroupAvatarUrlUpdatedResult

Methods

onGroupAvatarUrlUpdated

type ZIMGroupAvatarUrlUpdatedResult = (groupID: string, groupAvatarUrl: string) => void

Returns the result of the group avatar URL update.

Parameters

Name	Type	Description
groupID	string	Group ID.
groupAvatarUrl	string	Group avatar URL.

ZIMGroupNoticeUpdatedResult

Methods

onGroupNoticeUpdated

type ZIMGroupNoticeUpdatedResult = (groupID: string, groupNotice: string) => void

The return of the results of the group announcement update.

Parameters

Name	Type	Description
groupID	string	Group ID.
groupNotice	string	Group notice.

ZIMGroupAliasUpdatedResult

Methods

onGroupAliasUpdated

type ZIMGroupAliasUpdatedResult = (groupID: string, groupAlias: string) => void

Returns the result of the group alias update.

Parameters

Name	Type	Description
groupID	string	Group ID.
groupAlias	string	Group alias.

ZIMGroupInfoQueriedResult

Methods

onGroupInfoQueried

type ZIMGroupInfoQueriedResult = (groupInfo: ZIMGroupFullInfo) => void

Returns the result of querying group information.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.

ZIMGroupAttributesOperatedResult

Methods

onGroupAttributesOperated

type ZIMGroupAttributesOperatedResult = (groupID: string, errorKeys: string[]) => void

Returns the result of a group attribute operation.

Parameters

Name	Type	Description
groupID	string	Group ID.
errorKeys	string[]	Error keys.

ZIMGroupAttributesQueriedResult

Methods

onGroupAttributesQueried

type ZIMGroupAttributesQueriedResult = (groupID: string, groupAttributes: Map<string, string>) => void

The return of query group attribute results.

Parameters

Name	Type	Description
groupID	string	Group ID.
groupAttributes	Map<string, string>	Group attributes.

ZIMGroupMemberRoleUpdatedResult

Methods

onGroupMemberRoleUpdated

type ZIMGroupMemberRoleUpdatedResult = (groupID: string, forUserID: string, role: number) => void

Returns the result of the member role update.

Parameters

Name	Type	Description
groupID	string	Group ID.
forUserID	string	User ID.
role	number	User role.

ZIMGroupMemberNicknameUpdatedResult

Methods

onGroupMemberNicknameUpdated

type ZIMGroupMemberNicknameUpdatedResult = (groupID: string, forUserID: string, nickname: string) => void

Returns the result of the group member's nickname update.

Parameters

Name	Type	Description
groupID	string	Group ID.
forUserID	string	User ID.
nickname	string	User nickname.

ZIMGroupMemberInfoQueriedResult

Methods

onGroupMemberInfoQueried

type ZIMGroupMemberInfoQueriedResult = (groupID: string, userInfo: ZIMGroupMemberInfo) => void

Returns the result of the group member query.

Parameters

Name	Type	Description
groupID	string	Group ID.
userInfo	ZIMGroupMemberInfo	Group member user information.

ZIMGroupListQueriedResult

Methods

onGroupListQueried

type ZIMGroupListQueriedResult = (groupList: ZIMGroup[], nextFlag: number) => void

Returns the results of the query group list.

Parameters

Name	Type	Description
groupList	ZIMGroup[]	Group list.
nextFlag	number	The pagination anchor returned by the SDK is 0 if it means the list has been completely queried, and non-0 if it means there is still data to be queried.

ZIMGroupMemberListQueriedResult

Methods

onGroupMemberListQueried

type ZIMGroupMemberListQueriedResult = (groupID: string, userList: ZIMGroupMemberInfo[], nextFlag: unsigned int) => void

Returns the result of querying the group member list.

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	ZIMGroupMemberInfo[]	Group member list.
nextFlag	unsigned int	Used to query the next page. The current value returns 0, which means that the list has been pulled out.

ZIMGroupMemberCountQueriedResult

Methods

onGroupMemberCountQueried

type ZIMGroupMemberCountQueriedResult = (groupID: string, count: unsigned int) => void

Returns the result of querying the group member count.

Parameters

Name	Type	Description
groupID	string	Group ID.
count	unsigned int	Group member count.

ZIMGroupMessageReceiptMemberListQueriedResult

Methods

onGroupMessageReceiptMemberListQueried

type ZIMGroupMessageReceiptMemberListQueriedResult = (groupID: string, userList: ZIMGroupMemberInfo[], nextFlag: unsigned int) => void

Callback interface for querying the specific read/unread member list of group receipt messages.

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	ZIMGroupMemberInfo[]	Group member list.
nextFlag	unsigned int	Used to query the next page. The current value returns 0, which means that the list has been pulled out.

ZIMGroupMutedResult

Methods

onGroupMuted

type ZIMGroupMutedResult = (groupID: string, isMute: boolean, mutedInfo: ZIMGroupMuteInfo) => void

Returns the result of the group mute info update.

Parameters

Name	Type	Description
groupID	string	Group ID.
isMute	boolean	Whether to mute.
mutedInfo	ZIMGroupMuteInfo	Group mute information.

ZIMGroupMembersMutedResult

Methods

onGroupMembersMuted

type ZIMGroupMembersMutedResult = (groupID: string, isMute: boolean, duration: number, mutedUserIDs: string[], errorUserList: ZIMErrorUserInfo[]) => void

Returns the result of the group members mute info update.

Parameters

Name	Type	Description
groupID	string	Group ID.
isMute	boolean	Whether to mute.
duration	number	Mute duration.
mutedUserIDs	string[]	List of muted member userIDs.
errorUserList	ZIMErrorUserInfo[]	List of user information that failed to be muted.

ZIMGroupMemberMutedListQueriedResult

Methods

onGroupMemberMutedListQueried

type ZIMGroupMemberMutedListQueriedResult = (groupID: string, nextFlag: number, userList: ZIMGroupMemberInfo[]) => void

Returns the result of querying the group muted member list.

Parameters

Name	Type	Description
groupID	string	Group ID.
nextFlag	number	Used to query the next page. The current value returns 0, which means that the list has been pulled out.
userList	ZIMGroupMemberInfo[]	Group member list.

ZIMGroupsSearchedResult

Methods

onGroupsSearched

type ZIMGroupsSearchedResult = (groupSearchInfoList: ZIMGroupSearchInfo[], nextFlag: unsigned int) => void

Returns the result of search a group.

Parameters

Name	Type	Description
groupSearchInfoList	ZIMGroupSearchInfo[]	Group search information list.
nextFlag	unsigned int	Used to query the next page. The current value returns 0, which means that the list has been pulled out.

ZIMGroupMembersSearchedResult

Methods

onGroupMembersSearched

type ZIMGroupMembersSearchedResult = (groupID: string, userList: ZIMGroupMemberInfo[], nextFlag: unsigned int) => void

Returns the result of search a group members.

Parameters

Name	Type	Description
groupID	string	Group ID.
userList	ZIMGroupMemberInfo[]	Group member list.
nextFlag	unsigned int	Used to query the next page. The current value returns 0, which means that the list has been pulled out.

ZIMGroupJoinModeUpdatedResult

Methods

onGroupJoinModeUpdated

type ZIMGroupJoinModeUpdatedResult = (groupID: string, mode: ZIMGroupJoinMode) => void

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	string	Group ID.
mode	ZIMGroupJoinMode	Group join mode.

ZIMGroupInviteModeUpdatedResult

Methods

onGroupInviteModeUpdated

type ZIMGroupInviteModeUpdatedResult = (groupID: string, mode: ZIMGroupInviteMode) => void

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	string	Group ID.
mode	ZIMGroupInviteMode	Group invite mode.

ZIMGroupBeInviteModeUpdatedResult

Methods

onGroupBeInviteModeUpdated

type ZIMGroupBeInviteModeUpdatedResult = (groupID: string, mode: ZIMGroupBeInviteMode) => void

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	string	Group ID.
mode	ZIMGroupBeInviteMode	Group be invite mode.

ZIMGroupJoinApplicationSentResult

Methods

onGroupJoinApplicationSent

type ZIMGroupJoinApplicationSentResult = (groupID: string) => void

The return of the results of the group join application sent.

Parameters

Name	Type	Description
groupID	string	Group ID.

ZIMGroupJoinApplicationAcceptedResult

Methods

onGroupJoinApplicationAccepted

type ZIMGroupJoinApplicationAcceptedResult = (groupID: string, userID: string) => void

The return of the results of the group join application accept.

Parameters

Name	Type	Description
groupID	string	Group ID.
userID	string	User ID.

ZIMGroupJoinApplicationRejectedResult

Methods

onGroupJoinApplicationRejected

type ZIMGroupJoinApplicationRejectedResult = (groupID: string, userID: string) => void

The return of the results of the group join application reject.

Parameters

Name	Type	Description
groupID	string	Group ID.
userID	string	User ID.

ZIMGroupInviteApplicationsSentResult

Methods

onGroupInviteApplicationsSent

type ZIMGroupInviteApplicationsSentResult = (groupID: string, errorUserList: ZIMErrorUserInfo[]) => void

The return of the results of the group invite application sent.

Parameters

Name	Type	Description
groupID	string	Group ID.
errorUserList	ZIMErrorUserInfo[]	Invite failed user information list.

ZIMGroupInviteApplicationAcceptedResult

Methods

onGroupInviteApplicationAccepted

type ZIMGroupInviteApplicationAcceptedResult = (groupInfo: ZIMGroupFullInfo, inviterUserID: string) => void

The return of the results of the group invite application accept.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.
inviterUserID	string	Inviter user ID.

ZIMGroupInviteApplicationRejectedResult

Methods

onGroupInviteApplicationRejected

type ZIMGroupInviteApplicationRejectedResult = (groupID: string, inviterUserID: string) => void

The return of the results of the group invite application accept.

Parameters

Name	Type	Description
groupID	string	Group information.
inviterUserID	string	Inviter user ID.

ZIMGroupApplicationListQueriedResult

Methods

onGroupApplicationListQueried

type ZIMGroupApplicationListQueriedResult = (applicationList: ZIMGroupApplicationInfo[], nextFlag: number) => void

Query the callback of group application list.

Parameters

Name	Type	Description
applicationList	ZIMGroupApplicationInfo[]	Group application information list.
nextFlag	number	Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.

ZIMCallInvitationSentResult

Methods

onCallInvitationSent

type ZIMCallInvitationSentResult = (callID: string, timeout: number, errorUserList: ZIMErrorUserInfo[]) => void

Action callback for sending a call invitation.

Parameters

Name	Type	Description
callID	string	Call ID.
timeout	number
errorUserList	ZIMErrorUserInfo[]	List of users who failed to receive the invitation.

ZIMCallingInvitationSentResult

Methods

onCallingInvitationSent

type ZIMCallingInvitationSentResult = (callID: string, errorUserList: ZIMErrorUserInfo[]) => void

Callback result of inviting the current call.

Parameters

Name	Type	Description
callID	string	Call ID.
errorUserList	ZIMErrorUserInfo[]	List of users who failed to receive the invitation.

ZIMCallCancelSentResult

Methods

onCallCancelSent

type ZIMCallCancelSentResult = (callID: string, errorInvitees: string[]) => void

Callback for the action to cancel the call invitation.

Parameters

Name	Type	Description
callID	string	Call ID.
errorInvitees	string[]	Call invitation failed user ID list.

ZIMCallAcceptanceSentResult

Methods

onCallAcceptanceSent

type ZIMCallAcceptanceSentResult = (callID: string) => void

Action callback for accepting call invitations.

Parameters

Name	Type	Description
callID	string	Call ID.

ZIMCallRejectionSentResult

Methods

onCallRejectionSent

type ZIMCallRejectionSentResult = (callID: string) => void

Action callback for rejecting a call invitation.

Parameters

Name	Type	Description
callID	string	Call ID.

ZIMCallJoinSentResult

Methods

onCallJoinSent

type ZIMCallJoinSentResult = (callID: string, createTime: number, joinTime: number, extendedData: string, callUserList: ZIMCallUserInfo[]) => void

Result callback of joining the call invitation.

Parameters

Name	Type	Description
callID	string	Call ID.
createTime	number	Timestamp when the call was created, in milliseconds.
joinTime	number	Timestamp when the user joined the call, in milliseconds.
extendedData	string	Extended data.
callUserList	ZIMCallUserInfo[]	List of call user information.

ZIMCallQuitSentResult

Methods

onCallQuitSent

type ZIMCallQuitSentResult = (callID: string, createTime: number, acceptTime: number, quitTime: number) => void

Quit the callback closure of the call invitation operation.

Parameters

Name	Type	Description
callID	string	Call ID.
createTime	number	Timestamp when the call was created, in milliseconds.
acceptTime	number	Timestamp when the call was accepted, in milliseconds.
quitTime	number	Timestamp when the user quit the call, in milliseconds.

ZIMCallEndSentResult

Methods

onCallEndSent

type ZIMCallEndSentResult = (callID: string, createTime: number, acceptTime: number, endTime: number) => void

Result callback of ending the call invitation.

Parameters

Name	Type	Description
callID	string	Call ID.
createTime	number	Timestamp when the call was created, in milliseconds.
acceptTime	number	Timestamp when the call was accepted, in milliseconds.
endTime	number	Timestamp when the call ended, in milliseconds.

ZIMCallInvitationListQueriedResult

Methods

onCallInvitationListQueried

type ZIMCallInvitationListQueriedResult = (callList: ZIMCallInfo[], nextFlag: number) => void

Result Callback of querying the call list.

Parameters

Name	Type	Description
callList	ZIMCallInfo[]	Call information list.
nextFlag	number	Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.

ZIMFriendAddedResult

Methods

onFriendAdded

type ZIMFriendAddedResult = (friendInfo: ZIMFriendInfo) => void

Add a friend result callback.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.

ZIMFriendsDeletedResult

Methods

onFriendsDeleted

type ZIMFriendsDeletedResult = (errorUserList: ZIMErrorUserInfo[]) => void

Return results of deleting friends.

Parameters

Name	Type	Description
errorUserList	ZIMErrorUserInfo[]	Friend information.

ZIMFriendListQueriedResult

Methods

onFriendListQueried

type ZIMFriendListQueriedResult = (friendList: ZIMFriendInfo[], nextFlag: number) => void

The returned result of querying the friends list.

Parameters

Name	Type	Description
friendList	ZIMFriendInfo[]	Friend information list.
nextFlag	number	Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.

ZIMFriendsInfoQueriedResult

Methods

onFriendsInfoQueried

type ZIMFriendsInfoQueriedResult = (friendInfos: ZIMFriendInfo[], errorUserList: ZIMErrorUserInfo[]) => void

Return results of querying friend information in batches.

Parameters

Name	Type	Description
friendInfos	ZIMFriendInfo[]	Friend information list.
errorUserList	ZIMErrorUserInfo[]	Friend information.

ZIMFriendsRelationCheckedResult

Methods

onFriendsRelationChecked

type ZIMFriendsRelationCheckedResult = (relationInfos: ZIMFriendRelationInfo[], errorUserList: ZIMErrorUserInfo[]) => void

Check the friend relationship result.

Parameters

Name	Type	Description
relationInfos	ZIMFriendRelationInfo[]	Friend relationship information list.
errorUserList	ZIMErrorUserInfo[]	Friend information.

ZIMFriendApplicationSentResult

Methods

onFriendApplicationSent

type ZIMFriendApplicationSentResult = (applicationInfo: ZIMFriendApplicationInfo) => void

The result of sending a friend application.

Parameters

Name	Type	Description
applicationInfo	ZIMFriendApplicationInfo	Friend application information.

ZIMFriendApplicationAcceptedResult

Methods

onFriendApplicationAccepted

type ZIMFriendApplicationAcceptedResult = (friendInfo: ZIMFriendInfo) => void

Accept the returned result of friend application.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.

ZIMFriendApplicationRejectedResult

Methods

onFriendApplicationRejected

type ZIMFriendApplicationRejectedResult = (userInfo: ZIMUserInfo) => void

Accept the returned result of friend application.

Parameters

Name	Type	Description
userInfo	ZIMUserInfo	User information.

ZIMFriendApplicationListQueriedResult

Methods

onFriendApplicationListQueried

type ZIMFriendApplicationListQueriedResult = (applicationList: ZIMFriendApplicationInfo[], nextFlag: number) => void

The result of sending a friend application.

Parameters

Name	Type	Description
applicationList	ZIMFriendApplicationInfo[]	Friend application information list.
nextFlag	number	Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.

ZIMFriendAliasUpdatedResult

Methods

onFriendAliasUpdated

type ZIMFriendAliasUpdatedResult = (friendInfo: ZIMFriendInfo) => void

Return results of updating friend alias.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.

ZIMFriendAttributesUpdatedResult

Methods

onFriendAttributesUpdated

type ZIMFriendAttributesUpdatedResult = (friendInfo: ZIMFriendInfo) => void

Return results of updating friend attributes.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.

ZIMFriendsSearchedResult

Methods

onFriendsSearched

type ZIMFriendsSearchedResult = (friendInfos: ZIMFriendInfo[], nextFlag: number) => void

Search results returned by local friends.

Parameters

Name	Type	Description
friendInfos	ZIMFriendInfo[]	Friend information list.
nextFlag	number	Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.

ZIMBlacklistUsersAddedResult

Methods

onBlacklistUsersAdded

type ZIMBlacklistUsersAddedResult = (errorUserList: ZIMErrorUserInfo[]) => void

Callback for operation results of adding users to the blacklist.

Parameters

Name	Type	Description
errorUserList	ZIMErrorUserInfo[]	User information.

ZIMBlacklistUsersRemovedResult

Methods

onBlacklistUsersRemoved

type ZIMBlacklistUsersRemovedResult = (errorUserList: ZIMErrorUserInfo[]) => void

The callback result of the operation to remove the user from the blacklist.

Parameters

Name	Type	Description
errorUserList	ZIMErrorUserInfo[]	User information.

ZIMBlacklistQueriedResult

Methods

onBlacklistQueried

type ZIMBlacklistQueriedResult = (blacklist: ZIMUserInfo[], nextFlag: number) => void

Query the blacklist result callback.

Parameters

Name	Type	Description
blacklist	ZIMUserInfo[]	Blacklist user information list.
nextFlag	number	Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.

ZIMBlacklistCheckedResult

Methods

onBlacklistChecked

type ZIMBlacklistCheckedResult = (isUserInBlacklist: boolean) => void

Blacklist check result callback.

Parameters

Name	Type	Description
isUserInBlacklist	boolean	Whether in blacklist.

ZIMCommunityCreatedResult

Methods

onCommunityCreated

type ZIMCommunityCreatedResult = (communityInfo: ZIMCommunityFullInfo) => void

Callback of the result of creating a community.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityFullInfo	Community information.

ZIMCommunityDismissedResult

Methods

onCommunityDismissed

type ZIMCommunityDismissedResult = (communityID: string) => void

Callback of the result of dismissing a community.

Parameters

Name	Type	Description
communityID	string	Community ID.

ZIMCommunityJoinedResult

Methods

onCommunityJoined

type ZIMCommunityJoinedResult = (communityInfo: ZIMCommunityFullInfo) => void

Callback of the result of joining a community.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityFullInfo	Community information.

ZIMCommunityLeftResult

Methods

onCommunityLeft

type ZIMCommunityLeftResult = (communityID: string) => void

Callback of the result of leaving a community.

Parameters

Name	Type	Description
communityID	string	Community ID.

ZIMCommunityListQueriedResult

Methods

onCommunityListQueried

type ZIMCommunityListQueriedResult = (communityList: ZIMCommunity[], nextFlag: number) => void

Callback of the result of querying the community list.

Parameters

Name	Type	Description
communityList	ZIMCommunity[]	Community list.
nextFlag	number	Next query community list flag.

ZIMCommunityNameUpdatedResult

Methods

onCommunityNameUpdated

type ZIMCommunityNameUpdatedResult = (communityID: string, communityName: string) => void

Callback of the result of updating the community name.

Parameters

Name	Type	Description
communityID	string	Community ID.
communityName	string	Community name.

ZIMCommunityAvatarUrlUpdatedResult

Methods

onCommunityAvatarUrlUpdated

type ZIMCommunityAvatarUrlUpdatedResult = (communityID: string, communityAvatarUrl: string) => void

Callback of the result of updating the community avatar URL.

Parameters

Name	Type	Description
communityID	string	Community ID.
communityAvatarUrl	string	Community avatar URL.

ZIMCommunityNoticeUpdatedResult

Methods

onCommunityNoticeUpdated

type ZIMCommunityNoticeUpdatedResult = (communityID: string, communityNotice: string) => void

Callback of the result of updating the community notice.

Parameters

Name	Type	Description
communityID	string	Community ID.
communityNotice	string	Community notice.

ZIMCommunityAttributesOperatedResult

Methods

onCommunityAttributesOperated

type ZIMCommunityAttributesOperatedResult = (communityID: string, errorKeys: string[]) => void

Callback of the result of operating community attributes.

Parameters

Name	Type	Description
communityID	string	Community ID.
errorKeys	string[]	Error keys.

ZIMCommunityNotificationStatusSetResult

Methods

onCommunityNotificationStatusSet

type ZIMCommunityNotificationStatusSetResult = (communityID: string) => void

Callback of the result of setting the community notification status.

Parameters

Name	Type	Description
communityID	string	Community ID.

ZIMCommunityInfoQueriedResult

Methods

onCommunityInfoQueried

type ZIMCommunityInfoQueriedResult = (communityInfo: ZIMCommunityFullInfo) => void

Callback of the result of querying community information.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityFullInfo	Community information.

ZIMCommunityUsersInvitedResult

Methods

onCommunityUsersInvited

type ZIMCommunityUsersInvitedResult = (communityID: string, errorUserList: ZIMErrorUserInfo[]) => void

Callback of the result of inviting users into the community.

Parameters

Name	Type	Description
communityID	string	Community ID.
errorUserList	ZIMErrorUserInfo[]	The error userID list

ZIMCommunityMembersKickedResult

Methods

onCommunityMembersKicked

type ZIMCommunityMembersKickedResult = (communityID: string, errorUserList: ZIMErrorUserInfo[]) => void

Callback of the result of kicking members from the community.

Parameters

Name	Type	Description
communityID	string	Community ID.
errorUserList	ZIMErrorUserInfo[]	The error userID list

ZIMCommunityMemberRoleUpdatedResult

Methods

onCommunityMemberRoleUpdated

type ZIMCommunityMemberRoleUpdatedResult = (communityID: string, forUserID: string, memberRole: number) => void

Callback of the result of updating a community member's role.

Parameters

Name	Type	Description
communityID	string	Community ID.
forUserID	string	The user ID of the target user.
memberRole	number	member role value

ZIMCommunityOwnerTransferredResult

Methods

onCommunityOwnerTransferred

type ZIMCommunityOwnerTransferredResult = (communityID: string, toUserID: string) => void

Callback of the result of transferring the community owner.

Parameters

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

ZIMCommunityMemberListQueriedResult

Methods

onCommunityMemberListQueried

type ZIMCommunityMemberListQueriedResult = (communityID: string, memberList: ZIMCommunityMemberInfo[], nextFlag: number) => void

Callback of the result of querying the community member list.

Parameters

Name	Type	Description
communityID	string	Community ID.
memberList	ZIMCommunityMemberInfo[]	Community member list.
nextFlag	number	Anchor for the next community member list query.

ZIMCommunityMembersQueriedResult

Methods

onCommunityMembersQueried

type ZIMCommunityMembersQueriedResult = (communityID: string, memberList: ZIMCommunityMemberInfo[], errorUserList: ZIMErrorUserInfo[]) => void

Callback of the result of querying specific community members.

Parameters

Name	Type	Description
communityID	string	Community ID.
memberList	ZIMCommunityMemberInfo[]	List of queried community members.
errorUserList	ZIMErrorUserInfo[]	List of users that failed to be queried.

ZIMCommunityChannelCreatedResult

Methods

onCommunityChannelCreated

type ZIMCommunityChannelCreatedResult = (channelInfo: ZIMCommunityChannelFullInfo) => void

Callback of the result of creating a community channel.

Parameters

Name	Type	Description
channelInfo	ZIMCommunityChannelFullInfo	Community channel information.

ZIMCommunityChannelDismissedResult

Methods

onCommunityChannelDismissed

type ZIMCommunityChannelDismissedResult = (communityID: string, channelID: string) => void

Callback of the result of dismissing a community channel.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelID	string	Community channel ID

ZIMCommunityChannelNameUpdatedResult

Methods

onCommunityChannelNameUpdated

type ZIMCommunityChannelNameUpdatedResult = (communityID: string, channelID: string, channelName: string) => void

Callback of the result of updating the community channel name.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelID	string	Community channel ID
channelName	string	Community channel name.

ZIMCommunityChannelAvatarUrlUpdatedResult

Methods

onCommunityChannelAvatarUrlUpdated

type ZIMCommunityChannelAvatarUrlUpdatedResult = (communityID: string, channelID: string, channelAvatarUrl: string) => void

Callback of the result of updating the community channel avatar URL.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelID	string	Community channel ID
channelAvatarUrl	string	Community avatar URL.

ZIMCommunityChannelNoticeUpdatedResult

Methods

onCommunityChannelNoticeUpdated

type ZIMCommunityChannelNoticeUpdatedResult = (communityID: string, channelID: string, channelNotice: string) => void

Callback of the result of updating the community channel notice.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelID	string	Community channel ID
channelNotice	string	Community channel notice.

ZIMCommunityChannelAttributesOperatedResult

Methods

onCommunityChannelAttributesOperated

type ZIMCommunityChannelAttributesOperatedResult = (communityID: string, channelID: string, errorKeys: string[]) => void

Callback of the result of operating community channel attributes.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelID	string	Community channel ID.
errorKeys	string[]	Error keys.

ZIMCommunityChannelsInfoQueriedResult

Methods

onCommunityChannelsInfoQueried

type ZIMCommunityChannelsInfoQueriedResult = (communityID: string, channelInfos: ZIMCommunityChannelFullInfo[], errorChannelIDs: string[]) => void

Callback of the result of querying community channel information.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelInfos	ZIMCommunityChannelFullInfo[]	List of queried community channels.
errorChannelIDs	string[]	List of channel IDs that failed to be queried.

ZIMCommunityChannelListQueriedResult

Methods

onCommunityChannelListQueried

type ZIMCommunityChannelListQueriedResult = (communityID: string, channelList: ZIMCommunityChannel[], nextFlag: number) => void

Callback of the result of querying the community channel list.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelList	ZIMCommunityChannel[]	Community channel list.
nextFlag	number	Anchor for the next channel list query.

ZIMCommunityMembersMutedResult

Methods

onCommunityMembersMuted

type ZIMCommunityMembersMutedResult = (communityID: string, channelID: string, isMute: boolean, errorUserList: ZIMErrorUserInfo[]) => void

Callback of the result of muting community members.

Parameters

Name	Type	Description
communityID	string	Community ID.
channelID	string	The channel ID. Empty means muted at the community level.
isMute	boolean	Whether to mute the members.
errorUserList	ZIMErrorUserInfo[]	List of users that failed to be muted.