即时通讯

常用类

全部分类

Interface

2026-07-06


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

错误信息。

详情

错误信息。

Declared in ZIMDefines.ts

属性

code

code: ZIMErrorCode

详情描述：错误码枚举值。

message

message: string

详情描述：错误信息描述。

ZIMAppConfig

ZIM 应用配置，包含 AppID 和 AppSign。

Declared in ZIMDefines.ts

属性

appID

appID: unsigned int

详情描述：AppID，请到 ZEGO 官网控制台申请获取。是否必填：必填。

ZIMLogConfig

日志配置。

详情

配置日志文件保存路径和日志文件大小上限。

Declared in ZIMDefines.ts

属性

logLevel

ZIMUserInfo

用户资料对象。

详情

标识一个唯一用户。

Declared in ZIMDefines.ts

属性

userID

userID: string

用户 ID，由开发者自定义生成。取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userName

userName: string

用户 name，由开发者自定义生成。是否必填：非必填。取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

userAvatarUrl: string

用户头像。

userExtendedData

userExtendedData: string

用户额外信息。该字段目前仅在房间相关接口中可用。

type

type: ZIMUserInfoType

用户类型。该字段用于标识当前属于何种子类。

ZIMUserFullInfo

用户详细资料对象。

详情

标识一个唯一用户。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMUserInfo

详情描述：用户基本信息。是否必填：必填。

ZIMUserOfflinePushRule

用户离线推送规则的数据类。

详情

用户离线推送规则的数据类。

Declared in ZIMDefines.ts

属性

onlinePlatforms

onlinePlatforms: ZIMPlatformType[]

与该数据类中的 notToReceiveOfflinePushPlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。

notToReceiveOfflinePushPlatforms

notToReceiveOfflinePushPlatforms: ZIMPlatformType[]

与该数据类中的 onlinePlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。

ZIMUserRule

用户规则配置。

Declared in ZIMDefines.ts

属性

offlinePushRule

offlinePushRule: ZIMUserOfflinePushRule

用户当前的离线推送规则信息。

ZIMUserStatus

用户状态相关数据。

详情

包含用户在线状态的相关数据。

Declared in ZIMDefines.ts

属性

userID

userID: string

单个用户的唯一标识符。

onlineStatus

onlineStatus: ZIMUserOnlineStatus

表示用户当前在线状态的枚举。

onlinePlatforms

onlinePlatforms: ZIMPlatformType[]

当前用户的在线平台列表，可以用于展示这名用户在哪些平台在线，如 iPhone 在线、电脑端在线。平台取值含义请参考 ZIMPlatform。

customStatus

customStatus: string

用户自定义状态，默认最大值为 64 字节，默认过期时间为 1 天，过期后重置为空字符串。登录时，如果该字段为空字符串（默认为空字符串），那么不会修改当前用户的自定义状态。

customStatusExpiredTime

customStatusExpiredTime: number

自定义状态的过期时间。

lastUpdateTime

lastUpdateTime: number

用户 onlineStatus 或 customStatus 最后一次变更时的时间戳,取两者较大值。

lastOnlineStatusUpdateTime

lastOnlineStatusUpdateTime: number

用户 onlineStatus 最后一次变更时的时间戳，可以用于展示 xxx 分钟前离线/登录。

lastCustomStatusUpdateTime

lastCustomStatusUpdateTime: number

用户 customStatus 最后一次变更时的时间戳，可以用于展示自定义状态的最后变更时间。

ZIMUserStatusSubscription

用户态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。

详情

用户状态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。

Declared in ZIMDefines.ts

属性

userStatus

userStatus: ZIMUserStatus

这名用户的在线状态有关的数据。

subscribeExpiredTime

subscribeExpiredTime: number

这名用户订阅过期的时间戳。

ZIMSelfUserInfo

携带当前用户的用户信息、规则。

详情

携带当前用户的用户信息、规则。

Declared in ZIMDefines.ts

属性

userFullInfo

userFullInfo: ZIMUserFullInfo

当前用户的个人信息。

userRule

userRule: ZIMUserRule

当前用户的规则，设置信息。

userStatus

userStatus: ZIMUserStatus

用户的在线状态。

ZIMUserStatusSubscribeConfig

subscribeUsersStatus 批量订阅用户在线状态接口的配置项。

详情

批量订阅用户在线状态接口的配置项。

Declared in ZIMDefines.ts

属性

subscriptionDuration

subscriptionDuration: number

订阅时长，单位为分钟。

ZIMSubscribedUserStatusQueryConfig

querySubscribedUserStatusList 查询订阅列表接口的配置项。

详情

querySubscribedUserStatusList 查询订阅列表接口的配置项。

Declared in ZIMDefines.ts

属性

userIDs

userIDs: string[]

需要查询的用户 ID 列表。

ZIMUserCustomStatusUpdateConfig

用户自定义状态更新配置。

详情

更新用户自定义状态相关参数。

Declared in ZIMDefines.ts

属性

duration

duration: number

用户自定义状态持续时间。

ZIMErrorUserInfo

失败用户信息类。

详情

用于展示失败的用户以及失败的原因。

Declared in ZIMDefines.ts

属性

userID

userID: string

userID。

reason

reason: unsigned int

描述查询失败原因的 reason。

ZIMLoginConfig

登录相关参数配置。

详情

登录相关参数。

Declared in ZIMDefines.ts

业务场景：用于登录时设置不同的参数。

属性

userName

userName: string

详情描述：用户昵称。业务场景：用于登录同时修改用户昵称的场景，无需变更时传空。是否必填：否。

token

token: string

详情描述：登录时携带的 token。业务场景：仅在使用 token 鉴权的场景中传入。是否必填：否。

isOfflineLogin

isOfflineLogin: boolean

详情描述：是否是离线登录。业务场景：在离线登录时需要传入 true。是否必填：否。默认值：false。

customStatus

customStatus: string

详情描述：自定义状态。业务场景：仅在需要在登录时自定义用户状态时传入。是否必填：否。默认值：空字符串

customStatusDuration

customStatusDuration: number

详情描述：自定义状态的过期时长。

ZIMLogoutConfig

登出相关参数配置。

详情

登出相关参数。

Declared in ZIMDefines.ts

业务场景：用于登出时设置特定行为的参数。

属性

isClearDB

isClearDB: boolean

是否在登出时同时清除当前用户下的本地 DB 数据。默认值：[false]。

ZIMUsersInfoQueryConfig

用户信息查询配置。

详情

用户信息查询配置，可以选择从本地查询或者从服务端查询。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。

Declared in ZIMDefines.ts

属性

isQueryFromServer

isQueryFromServer: boolean

详情描述: 是否从服务端查询用户详细信息。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。是否必填：非必填。默认值：false。

ZIMOfflinePushPrivateMessageTemplate

私信模版,目前仅适用于 OPPO 厂商。

详情

根据 OPUSH私信模版校验能力接入说明,OPPO 在新消息分类的基础上新增了推送私信模版，当您在 OPPO 控制台配置好私信模版后，如需在推送时应用对应模版，可在 ZIMPushConfig 为 privateMessageTemplate 赋值。

Declared in ZIMDefines.ts

属性

templateID

templateID: string

详情描述：私信模版 ID,目前仅适用于 OPPO 厂商，请填写在 OPPO 开放平台控制台预设好的模版 ID。

titleParameters

titleParameters: string

详情描述：用于替换模版中标题预设字段的内容，需要填写一个 json 字符串，如 "{"user_name":"李华"}"。

contentParameters

contentParameters: string

详情描述：用于替换模版中内容预设字段的内容，需要填写一个 json 字符串，如 "{"city":"深圳"}"。

ZIMVoIPConfig

提供发起 iOS VoIP 离线推送类型的信息。

详情

提供发起 iOS VoIP 离线推送类型的信息。

Declared in ZIMDefines.ts

属性

iOSVoIPHandleType

iOSVoIPHandleType: ZIMCXHandleType

详情描述：VoIP 发起方联系信息类型，默认为不指定类型。

iOSVoIPHandleValue

iOSVoIPHandleValue: string

详情描述：VoIP 发起方联系信息内容，与 iOSVoIPHandleType 相关。当 iOSVoIPHandleType 为 PhoneNumber 时，Value 为一串数字；当 iOSVoIPHandleType 为 EmailAddress 时，Value 为电子邮箱地址；当联系信息为其他类型时，Value 通常遵循某种特定格式，如用户名、数字 ID 或 URL。

iOSVoIPHasVideo

iOSVoIPHasVideo: boolean

详情描述：是否为视频通话，默认为音频。

ZIMPushConfig

详情描述:离线推送配置。

详情

发送离线推送前的配置。

Declared in ZIMDefines.ts

属性

title

title: string

详情描述：用于设置推送标题。是否必填：非必填。

content

content: string

详情描述：用于设置离线推送的内容。是否必填：非必填。

payload

payload: string

详情描述：用于设置离线推送的透传字段。是否必填：非必填。

resourcesID

resourcesID: string

详情描述：由开发者自定义，长度不超过 32 个字符的字符串，用于映射多个厂商进阶配置的离线推送字段，将多个厂商的推送配置抽象为一种您自定的推送策略。自定义完成后，请联系 ZEGO 技术支持进行配置，配置完成并填入该 resourceID 字段后，ZPNs 服务端会根据接收端设备厂商的不同，选取合适的厂商配置来完成推送。默认值：在未设置 resourceID 的情况下，推送类型为普通弹窗推送（APNs 为 Alert，FCM 为 Notification Message）。业务场景：1. 配置小米、华为、OPPO、vivo 离线推送证书的项目实现无限制推送，配置此项时，开发者需要先在各厂商完成私信通道创建后，提供以下内容：小米：channel_id（渠道 ID，必需）、channel_name（渠道名称，可选）、channel_description（渠道描述，可选）；华为：category（推送类别）、target_user_type（用户类型，0 表示正式推送，1 表示测试推送）；OPPO：channel_id（渠道 ID）；vivo：category（推送类别）、classification（分类）、push_mode（推送模式，0 表示正式推送，1 表示测试推送）。2. 配置 APNs（Apple）、FCM（Google）证书的项目实现静默推送。请向 ZEGO 技术支持提供 resourceID，配置静默推送策略。是否必填：非必填。

threadID

threadID: string

详情描述：用于设置离线推送的线程 ID。是否必填：非必填。

enableBadge

enableBadge: boolean

详情描述：推送是否携带角标信息开关。

badgeIncrement

badgeIncrement: number

详情描述：推送携带的增量角标数。

voIPConfig

voIPConfig: ZIMVoIPConfig

详情描述：如果您使用 Flutter、RN ZPNs, 离线推送接收端设备有 iOS 且使用了 VoIP 推送类型，可以通过该参数来自定义一些 VoIP 的选项。

privateMessageTemplate

privateMessageTemplate: ZIMOfflinePushPrivateMessageTemplate

详情描述：如果您使用 OPPO 推送，可以通过该字段来携带推送模版。

ZIMMessageReactionAddConfig

添加消息表态的配置。

详情

添加消息表态的配置类。

Declared in ZIMDefines.ts

属性

increaseCount

increaseCount: number

详情描述：当该值传入大于 0 的值时，表示允许同一个用户对同一个表态类型进行多次表态，并会把多次表态时的计数值进行相加。

ZIMMessageReactionUserInfo

表态用户信息。

详情

描述表态用户的类。

Declared in ZIMDefines.ts

属性

userID

userID: string

详情描述：用户 ID

ZIMMessageReaction

消息表态具体内容。

详情

表态具体内容。

Declared in ZIMDefines.ts

属性

reactionType

reactionType: string

详情描述：表态类型，由您定义，长度上限为 32 字节。

conversationID

conversationID: string

详情描述：会话 ID。

conversationType

conversationType: ZIMConversationType

详情描述：会话类型。

messageID

messageID: string

详情描述：表态的消息 ID。

messageSeq

messageSeq: number

详情描述：消息序列号

totalCount

totalCount: unsigned int

详情描述：表态的用户总数。

isSelfIncluded

isSelfIncluded: boolean

详情描述：已表态用户中是否包含自己。

userList

userList: ZIMMessageReactionUserInfo[]

详情描述：表态的用户列表。

sumCount

sumCount: number

详情描述：表态的合计计数

ZIMMessageReactionSimpleInfo

消息表态的简要信息。

详情

表态具体内容。

Declared in ZIMDefines.ts

属性

reactionType

reactionType: string

详情描述：表态类型，由您定义，长度上限为 32 字节。

sumCount

sumCount: number

详情描述：表态的合计计数

ZIMMessageReactionUserFullInfo

消息表态的用户详细信息。

详情

描述表态用户的类。

Declared in ZIMDefines.ts

属性

userID

userID: string

详情描述：用户 ID

reactions

reactions: ZIMMessageReactionSimpleInfo[]

详情描述：当前用户在此条消息下的表态简要信息列表

ZIMMessageReactionUserChangeInfo

消息表态的用户操作变更信息。

详情

描述表态变更信息的类。

Declared in ZIMDefines.ts

属性

userID

userID: string

详情描述：当前执行表态操作的用户 ID。

reactionType

reactionType: string

详情描述：当前变更的表态类型。

action

action: ZIMMessageReactionUserChangeAction

详情描述：当前用户的表态操作行为

sumCount

sumCount: number

详情描述：当前表态类型的合计数值。

ZIMMessageLiteInfo

消息简要信息对象的基类。

详情

标识一条消息的基本参数。

Declared in ZIMDefines.ts

属性

type

type: ZIMMessageType

详情描述：消息类型。

ZIMTextMessageLiteInfo

普通文本消息简要信息对象。

Declared in ZIMDefines.ts

属性

message

message: string

详情描述：文本消息内容。

type

type: ZIMMessageType.Text

ZIMCustomMessageLiteInfo

自定义消息的简要对象。

Declared in ZIMDefines.ts

属性

message

message: string

详情描述：自定义消息内容。

searchedContent

searchedContent: string

详情描述：自定义消息搜索内容。

subType

subType: number

详情描述：自定义消息子类型。

type

type: ZIMMessageType.Custom

ZIMCombineMessageLiteInfo

合并消息的简要信息对象。

Declared in ZIMDefines.ts

属性

title

title: string

详情描述：合并消息标题。

summary

summary: string

详情描述：合并消息概要。

type

type: ZIMMessageType.Combine

ZIMRevokeMessageLiteInfo

撤回消息的简要信息对象。

Declared in ZIMDefines.ts

属性

type

type: ZIMMessageType.Revoke

ZIMMediaMessageLiteInfo

媒体消息简要信息对象基类。

Declared in ZIMDefines.ts

属性

fileSize

fileSize: number

详情描述：媒体文件大小。

fileName

fileName: string

详情描述：媒体文件名称。

fileLocalPath

fileLocalPath: File | string

详情描述：媒体文件本地路径。

fileDownloadUrl

fileDownloadUrl: string

详情描述：媒体文件下载地址。

ZIMImageMessageLiteInfo

图片消息的简要信息对象。

Declared in ZIMDefines.ts

属性

originalImageWidth

originalImageWidth: number

详情描述：原图宽度。

originalImageHeight

originalImageHeight: number

详情描述：原图高度。

largeImageWidth

largeImageWidth: number

详情描述：大图宽度。

largeImageHeight

largeImageHeight: number

详情描述：大图高度。

largeImageDownloadUrl

largeImageDownloadUrl: string

详情描述：大图下载地址。

thumbnailWidth

thumbnailWidth: number

详情描述：缩略图宽度。

thumbnailHeight

thumbnailHeight: number

详情描述：缩略图高度。

thumbnailDownloadUrl

thumbnailDownloadUrl: string

详情描述：缩略图下载地址。

type

type: ZIMMessageType.Image

ZIMFileMessageLiteInfo

文件消息的简要信息对象。

Declared in ZIMDefines.ts

属性

type

type: ZIMMessageType.File

ZIMAudioMessageLiteInfo

音频消息的简要信息对象。

Declared in ZIMDefines.ts

属性

audioDuration

audioDuration: number

详情描述：音频时长。

type

type: ZIMMessageType.Audio

ZIMVideoMessageLiteInfo

视频消息的简要信息对象。

Declared in ZIMDefines.ts

属性

videoDuration

videoDuration: number

详情描述：视频时长。

videoFirstFrameWidth

videoFirstFrameWidth: number

详情描述：视频首帧宽度。

videoFirstFrameHeight

videoFirstFrameHeight: number

详情描述：视频首帧高度。

videoFirstFrameDownloadUrl

videoFirstFrameDownloadUrl: string

详情描述：视频首帧下载地址。

type

type: ZIMMessageType.Video

ZIMMultipleMessageLiteInfo

组合消息的简要信息对象。

Declared in ZIMDefines.ts

属性

messageInfoList

messageInfoList: ZIMMessageLiteInfo[]

详情描述：消息列表。

type

type: ZIMMessageType.Multiple

ZIMMessageRepliedInfo

回复消息引用的源消息的描述信息。

Declared in ZIMDefines.ts

属性

state

state: ZIMMessageRepliedInfoState

详情描述：消息回复状态。

messageInfo

messageInfo: ZIMMessageLiteInfo

详情描述：被回复的消息轻量信息。

senderUserID

senderUserID: string

详情描述：回复消息的发送者用户ID。

sentTime

sentTime: number

详情描述：回复消息的发送时间。

messageID

messageID: string

详情描述：被回复消息的ID。

messageSeq

messageSeq: number

详情描述：被回复消息的序列号。

ZIMMessage

消息对象的基类。

详情

标识一条消息的基本参数。

Declared in ZIMDefines.ts

属性

type

type: ZIMMessageType

详情描述：消息类型。

messageID

messageID: string

详情描述：标识这条消息的唯一 ID。业务场景：可用于索引其他消息。注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

localMessageID

localMessageID: string

详情描述：SDK 本地生成的 MessageID,开发者无需关注。

messageSeq

messageSeq: number

详情描述：消息的序列号。

senderUserID

senderUserID: string

详情描述：展示本条消息发送者的 userID。

conversationID

conversationID: string

详情描述：会话的 ID，相同会话类型下的 ID 是唯一的。

conversationType

conversationType: ZIMConversationType

详情描述：该消息所属会话的类型。

direction

direction: ZIMMessageDirection

详情描述：用于描述消息的方向是发送还是接收。

sentStatus

sentStatus: ZIMMessageSentStatus

详情描述：描述消息的发送状态。

timestamp

timestamp: unsigned long long

详情描述：标识一条消息的发送时间。业务场景：用于呈现一条消息的发送时间，并可用于消息排序。注意事项：此为标准 UNIX 时间戳，单位为毫秒。

orderKey

orderKey: number

详情描述：orderKey 越大消息越新，可用于消息排序。

isUserInserted

isUserInserted: boolean

详情描述：该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。默认值：false。

receiptStatus

receiptStatus: ZIMMessageReceiptStatus

详情描述：描述该消息的回执状态。业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

extendedData: string

详情描述：消息拓展字段。业务场景：可为消息附加拓展字段，然后发送给对端。是否必填：否。注意事项：长度为1k，可联系技术支持进行配置。支持版本: 2.6.0 及以上。

localExtendedData

localExtendedData: string

详情描述：仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。

reactions

reactions: ZIMMessageReaction[]

详情描述：消息表态列表，可通过该字段携带如 emoji 表情，投票信息等与用户强相关的数据。

isBroadcastMessage

isBroadcastMessage: boolean

详情描述：该消息是否是全员推送消息。是否必填：SDK内部赋值。

mentionedUserIDs

mentionedUserIDs: string[]

详情描述：提醒一批相关的用户。业务表现可为“@某用户”。业务场景：发消息时可以带上是否必填：否。注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。支持版本 : 2.14.0 及以上。

isMentionAll

isMentionAll: boolean

详情描述：是否需要提醒所有人。业务表现可为“@所有人”。业务场景：例如在群或者房间可使用。是否必填：否。默认值：false。建议值：如果需要提醒所有人，可以设置为 true。注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。支持版本 : 2.14.0 及以上。

repliedInfo

repliedInfo: ZIMMessageRepliedInfo

详情描述：消息回复信息。

rootRepliedCount

rootRepliedCount: number

详情描述：消息根回复数量。

isServerMessage

isServerMessage: boolean

是否为通过服务端 API 所发送的消息

editorUserID

editorUserID: string

详情描述：消息编辑者的 userID。

editedTime

editedTime: number

详情描述：消息编辑时间。

isGroupTargetedMessage

isGroupTargetedMessage: boolean

标识该消息是否为群定向消息

pinnedUserID

pinnedUserID: string

详情描述：消息置顶者的 userID。

pinnedTime

pinnedTime: number

详情描述：消息编辑时间。

ZIMMediaMessage

媒体消息对象基类。

详情

标识一条媒体消息。

Declared in ZIMDefines.ts

属性

fileLocalPath

fileLocalPath: File | string

详情描述：媒体消息的文件的本地绝对路径。是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

fileDownloadUrl: string

详情描述：媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。是否必填：如果发送的是外部 URL，发送端必填。

fileUID

fileUID: string

详情描述：媒体文件的唯一 ID。是否必填：发送端不需要填，该值由 SDK 生成。

fileName

fileName: string

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

fileSize

fileSize: number

详情描述：媒体文件的大小。是否必填：发送端不需要填，该值由 SDK 生成。

ZIMTextMessage

普通文本消息对象。

详情

标识一条普通文本消息。

Declared in ZIMDefines.ts

属性

message

message: string

详情描述：消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。是否必填：发送端必填，否则消息会发送失败。

type

type: ZIMMessageType.Text

ZIMCustomMessage

自定义消息对象。

详情

标识一条自定义消息。

Declared in ZIMDefines.ts

属性

message

message: string

searchedContent

searchedContent: string

详情描述：消息的搜索内容。

subType

subType: unsigned int

详情描述：消息的子类型，用于客户自定义不同自定义消息的用法。取值范围为 [0, 200]。是否必填：发送端必填，否则消息会发送失败。

type

type: ZIMMessageType.Custom

ZIMCommandMessage

自定义二进制消息对象。

详情

标识一条二进制消息。

Declared in ZIMDefines.ts

属性

message

message: bytes

详情描述：消息的内容，支持任意数据。是否必填：发送端必填，否则消息会发送失败。

type

type: ZIMMessageType.Command

ZIMBarrageMessage

弹幕消息类。

详情

弹幕消息类，不会出现在会话中，也不会存入历史消息。

Declared in ZIMDefines.ts

属性

message

message: string

详情描述：弹幕消息内容。

type

type: ZIMMessageType.Barrage

ZIMImageMessage

图片消息对象。

详情

标识一条图片消息。

Declared in ZIMDefines.ts

属性

thumbnailDownloadUrl

thumbnailDownloadUrl: string

详情描述：图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

largeImageDownloadUrl

largeImageDownloadUrl: string

详情描述：图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

originalImageWidth

originalImageWidth: number

详情描述：原图宽度。

originalImageHeight

originalImageHeight: number

详情描述：原图高度。

largeImageWidth

largeImageWidth: number

详情描述：大图宽度。

largeImageHeight

largeImageHeight: number

详情描述：大图高度。

thumbnailWidth

thumbnailWidth: number

详情描述：缩略图宽度。

thumbnailHeight

thumbnailHeight: number

详情描述：缩略图高度。

type

type: ZIMMessageType.Image

ZIMFileMessage

文件消息对象。

详情

标识一条文件消息。

Declared in ZIMDefines.ts

属性

type

type: ZIMMessageType.File

ZIMAudioMessage

音频消息对象。

详情

标识一条音频消息。

Declared in ZIMDefines.ts

属性

audioDuration

audioDuration: unsigned int

详情描述：音频文件的时长。是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。

type

type: ZIMMessageType.Audio

ZIMVideoMessage

视频消息对象。

详情

标识一条视频消息。

Declared in ZIMDefines.ts

属性

videoDuration

videoDuration: unsigned int

详情描述：视频文件的时长。是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。

videoFirstFrameDownloadUrl

videoFirstFrameDownloadUrl: string

详情描述：视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

videoFirstFrameWidth

videoFirstFrameWidth: number

详情描述：视频首帧宽度。

videoFirstFrameHeight

videoFirstFrameHeight: number

详情描述：视频首帧高度。

type

type: ZIMMessageType.Video

ZIMRevokeMessage

撤回消息对象基类。

详情

标识一条撤回消息。

Declared in ZIMDefines.ts

属性

revokeType

revokeType: ZIMRevokeType

详情描述：撤回类型。

revokeTimestamp

revokeTimestamp: number

详情描述：撤回时间戳。

operatedUserID

operatedUserID: string

详情描述：撤回操作者的用户 ID。

originalMessageType

originalMessageType: ZIMMessageType

详情描述：原始消息类型。

originalTextMessageContent

originalTextMessageContent: string

详情描述：原始文本消息内容，若撤回的是非文本消息，则该字段为空。

revokeExtendedData

revokeExtendedData: string

详情描述：撤回附带的消息。

revokeStatus

revokeStatus: ZIMMessageRevokeStatus

详情描述：撤回状态。

type

type: ZIMMessageType.Revoke

ZIMCombineMessage

合并消息对象基类。

详情

标识一条合并消息。

Declared in ZIMDefines.ts

属性

title

title: string

详情描述：合并消息标题。

summary

summary: string

详情描述：合并消息的概要。

combineID

combineID: string

详情描述：合并消息 ID，SDK 内部使用。

messageList

messageList: ZIMMessage[]

合并消息的子消息列表

type

type: ZIMMessageType.Combine

ZIMTipsMessage

Tips 消息对象。

详情

标识一条 Tips 消息。

Declared in ZIMDefines.ts

属性

event

event: ZIMTipsMessageEvent

详情描述：Tips 事件类型。

operatedUser

operatedUser: ZIMUserInfo

详情描述：操作者信息。

targetUserList

targetUserList: ZIMUserInfo[]

详情描述：目标用户列表。

changeInfo

changeInfo: ZIMTipsMessageChangeInfo

详情描述：变更信息。

type

type: ZIMMessageType.Tips

ZIMMultipleMessage

组合消息对象。

Declared in ZIMDefines.ts

属性

messageInfoList

messageInfoList: ZIMMessageLiteInfo[]

详情描述：组合消息的内容列表。

failedIndexList

failedIndexList: number[]

详情描述：组合消息中失败的索引列表。

type

type: ZIMMessageType.Multiple

ZIMMessageRootRepliedInfo

回复消息树的根消息的描述信息。

Declared in ZIMDefines.ts

属性

state

state: ZIMMessageRepliedInfoState

详情描述：消息回复状态。

message

message: ZIMMessage

详情描述：根消息。

senderUserID

senderUserID: string

详情描述：根消息的发送者用户ID。

sentTime

sentTime: number

详情描述：根消息的发送时间。

repliedCount

repliedCount: number

详情描述：根消息的回复数量。

ZIMMessageRootRepliedCountInfo

回复消息树的回复数量的信息。

Declared in ZIMDefines.ts

属性

messageID

messageID: string

详情描述：消息ID。

conversationID

conversationID: string

详情描述：会话ID。

conversationType

conversationType: ZIMConversationType

详情描述：会话类型。

count

count: number

详情描述：根回复数量。

ZIMMessageMentionedInfo

消息提醒信息。

详情

消息提醒信息。

Declared in ZIMDefines.ts

属性

messageID

messageID: string

详情描述：消息ID，用于匹配该提醒信息是属于哪一条消息。是否必填：不需要开发者填写

messageSeq

messageSeq: number

详情描述：消息序列号，用于匹配该提醒信息是属于哪一条消息。是否必填：不需要开发者填写

fromUserID

fromUserID: string

详情描述：来自哪个用户。是否必填：不需要开发者填写。

type

type: ZIMMessageMentionedType

详情描述：消息提醒的类型，用于区分是提醒自己的还是提醒全部人的。是否必填：不需要开发者填写

ZIMMessageReceivedInfo

消息接收事件携带相关信息的结构体。

Declared in ZIMDefines.ts

属性

conversationID

conversationID: string

详情描述：会话 ID

conversationType

conversationType: ZIMConversationType

详情描述：会话类型

isOfflineMessage

isOfflineMessage: boolean

详情描述：是否是离线消息。

ZIMMessageSendConfig

发送消息的相关配置。

详情

发送消息的相关配置。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

详情描述：发送离线推送的相关配置，如果集成了 Android 或 iOS 平台，强烈建议配置该项。是否必填：非必填。

priority

priority: ZIMMessagePriority

详情描述：用于设置消息优先级的枚举值。是否必填：必填。

hasReceipt

hasReceipt: boolean

详情描述：发送消息时候，该消息是否带回执。业务场景：需要为一条消息带上回执时使用。是否必填：非必填。默认值：false。

isNotifyMentionedUsers

isNotifyMentionedUsers: boolean

发送消息时候，是否离线推送通知该消息提及到的用户。

isRetrySend

isRetrySend: boolean

是否重发发送失败的消息。

disableUnreadMessageCount

disableUnreadMessageCount: boolean

详情描述：发送原本会影响对方未读数消息的时候，是否不再计入对方未读。是否必填：非必填。默认值：false。

isAllowMultipleMessagePartialFailed

isAllowMultipleMessagePartialFailed: boolean

详情描述：是否允许发送组合消息时允许部分子消息发送失败。是否必填：非必填。默认值：false。

ZIMMessageQueryConfig

查询消息配置。

详情

查询消息的相关配置。

Declared in ZIMDefines.ts

属性

nextMessage

nextMessage: ZIMMessage

详情描述：查询消息的锚点。是否必填：首次查询时不必填，后续分页查询时，需要填此参数。

count

count: unsigned int

详情描述：查询消息的条数。是否必填：必填。

reverse

reverse: boolean

详情描述：是否反序查询的标志。是否必填：非必填。默认值：false。

mode

mode: ZIMMessageQueryMode

详情描述：设置查询历史消息的模式。由于 SDK 本身具备判断本地数据是否完整从而可以更快速给出历史消息的逻辑，因此建议一般情况下都使用默认值即可。是否必填：非必填。

ZIMMessageRevokeConfig

撤回消息的相关配置。

详情

撤回消息的相关配置。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

详情描述：发送离线推送的相关配置，如果集成了 Android 或 iOS 平台，强烈建议配置该项。是否必填：非必填。

revokeExtendedData

revokeExtendedData: string

详情描述:撤回附加消息。是否必填：非必填。

ZIMMessageDeleteConfig

删除消息配置。

详情

删除消息的相关配置。

Declared in ZIMDefines.ts

属性

isAlsoDeleteServerMessage

isAlsoDeleteServerMessage: boolean

详情描述:是否删除服务器消息的标志。是否必填：非必填。默认值：false。

ZIMMessageSendNotification

消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息

详情

通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。

Declared in ZIMDefines.ts

业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。

属性

onMessageAttached

onMessageAttached: ZIMMessageAttachedResult

详情描述：消息在落入本地 DB 后，将要向服务端发送消息之前，会回调该通知。业务场景：用于开发者需要在发送消息之前，提前获取消息里的相关信息时，可以使用此接口。是否必填：非必填。若无需监听的情况下，可传空。默认值：空。

onMediaUploadingProgress

onMediaUploadingProgress: ZIMMediaUploadingProgress

详情描述：媒体文件上传进度。

onMultipleMediaUploadingProgress

onMultipleMediaUploadingProgress: ZIMMultipleMediaUploadingProgress

详情描述：组合消息中的媒体文件上传进度。

ZIMMediaMessageSendNotification

媒体消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息

详情

通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。

Declared in ZIMDefines.ts

业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。

属性

onMessageAttached

onMessageAttached: ZIMMessageAttachedResult

详情描述：消息在落入本地 DB 后，将要向服务端发送消息之前，会回调该通知。业务场景：用于开发者需要在发送消息之前，提前获取消息里的相关信息时，可以使用此接口。是否必填：非必填。若无需监听的情况下，可传 [null]。默认值：[null]。

onMediaUploadingProgress

onMediaUploadingProgress: ZIMMediaUploadingProgress

媒体上传进度的回调。

ZIMMessageReceiptInfo

回执信息。

详情

回执信息。

Declared in ZIMDefines.ts

属性

status

status: ZIMMessageReceiptStatus

详情描述：回执的状态。

messageID

messageID: string

详情描述：消息ID。业务场景：开发者可根据这个ID 匹配已经加载过的消息列表。是否必填：否，SDK填充。

conversationID

conversationID: string

会话ID。

conversationType

conversationType: ZIMConversationType

会话类型。

readMemberCount

readMemberCount: unsigned int

详情描述：已读成员数。

unreadMemberCount

unreadMemberCount: unsigned int

详情描述：未读成员数。

isSelfOperated

isSelfOperated: boolean

详情描述：是否为自己多端的操作。

readTime

readTime: number

详情描述：接收方全部已读那一刻的时间戳。

ZIMMessageReactionUserQueryConfig

用于查询表态详情成员的配置。

详情

查询表态成员时，需要配置此对象。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned long long

详情描述：分页查询的标识位，首次查询时，将此字段设为空字符串。若 [ZIMMessageReactionUserListQueriedCallback] 回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。是否必填：非必填。默认值：空。

count

count: unsigned int

详情描述：一次获取多少表态的成员。上限为 100。注意事项：分页获取表态成员以降低开销，建议单次获取 20 人以内。若该处填写值为 0，SDK 会默认查询 100 人。业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。是否必填：必填。

reactionType

reactionType: string

详情描述：表态类型，由您自行定义。

ZIMMessageSentStatusChangeInfo

消息状态变更通知。

详情

消息状态变更通知。

Declared in ZIMDefines.ts

属性

status

status: ZIMMessageSentStatus

消息发送的状态。

message

message: ZIMMessage

消息详情。

reason

reason: string

此字段记录服务端发送前回调拦截消息导致 ZIM 拒绝发送的原因。若您开通了 ZIM 内容审核服务，并需在此字段中获取审核未通过导致的失败原因，请联系 ZEGO 技术支持进行配置。

ZIMMessageSearchConfig

消息搜索配置。

详情

消息搜索配置。

Declared in ZIMDefines.ts

属性

nextMessage

nextMessage: ZIMMessage

分页拉取标志，即指拉取 nextMessage 之后或之前的消息，“之后”或“之前”由 order 值决定。第一次搜索时，nextMessage 为 null。之后搜索时，nextMessage 需传入上次查询到的消息列表的最后一条消息。

count

count: unsigned int

数量。建议小于 20 条，以降低性能开销。

order

order: ZIMMessageOrder

搜索消息时 'order' 为 'DESCENDING' 时，表示对发送时间比 nextMessage 早的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的最后一条消息向前查询。'order' 为 'ASCENDING' 时，表示对发送时间比 nextMessage 晚的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的第一条消息向后查询。默认为 'DESCENDING'。

keywords

keywords: string[]

搜索关键字，最多支持 5 个，否则会报错。例如：传入 '1' 和 '2'，则搜索结果只会展示同时包含 '1' 和 '2' 这两个关键字的消息。

messageTypes

messageTypes: ZIMMessageType[]

消息类型，可用于指定消息类型。支持传入多个类型。

subMessageTypes

subMessageTypes: unsigned int[]

自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。

senderUserIDs

senderUserIDs: string[]

消息发送用户 ID，最多支持 5 个。例如，传入 'zego2023'，则搜索结果只会展示 'zego2023' 用户在该会话中发送的所有消息。

startTime

startTime: number

搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。

endTime

endTime: number

搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。

ZIMMessageRepliedListQueryConfig

用于查询回复消息列表的配置。

详情

查询消息回复列表的配置类。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: number

分页查询的标识位，首次查询时，将此字段设为0。若 [queryMessageRepliedList] 回调的 nextFlag 字段不为0，说明还没结束，需要将其设置到此处以继续下一页的查询。

count

count: number

单次查询的数量。上限为 100，超出 100 会导致错误。

ZIMMessageEditConfig

（空类）编辑消息的相关配置。

详情

（空类）编辑消息的相关配置。

Declared in ZIMDefines.ts

ZIMSendingMessageCancelConfig

（空类）取消发送消息的相关配置。

详情

（空类）取消发送消息的相关配置。

Declared in ZIMDefines.ts

ZIMMessagePinConfig

置顶消息配置。

详情

置顶消息的相关配置。

Declared in ZIMDefines.ts

属性

disableAutoReplace

disableAutoReplace: boolean

当置顶消息条数超过限制时，不允许下一次置顶消息时把置顶列表的旧消息进行替换。默认值为 [false]。

ZIMTipsMessageChangeInfo

Tips 消息额外信息。

详情

Tips 消息额外信息。

Declared in ZIMDefines.ts

属性

type

type: ZIMTipsMessageChangeInfoType

Tips 消息额外信息类型。

ZIMTipsMessageGroupChangeInfo

Tips 消息群相关变化事件附加信息。

详情

Tips 消息群相关变化事件附加信息。

Declared in ZIMDefines.ts

属性

groupDataFlag

groupDataFlag: number

如果群名，群头像，群公告存在复数变更，则需要由该字段的值知道哪些存在变更。其中 0b0001 是群名，0b0010 是群公告，0b0100 是群头像。

groupName

groupName: string

如果群名发生变更，则此处会展示变更后的值。

groupNotice

groupNotice: string

如果群名发生变更，则此处会展示变更后的值。

groupAvatarUrl

groupAvatarUrl: string

如果群头像发生变更，则此处会展示变更后的值。

groupMutedInfo

groupMutedInfo: ZIMGroupMuteInfo

如果群禁言状态发生变更，则此处会展示变更后的值。

ZIMTipsMessageGroupMemberChangeInfo

Tips 消息群成员相关变化事件附加信息。

详情

Tips 消息群成员相关变化事件附加信息。

Declared in ZIMDefines.ts

属性

memberRole

memberRole: number

如果群成员角色发生了变化，这里会展示变更后的角色。

muteExpiredTime

muteExpiredTime: number

如果群成员禁言时间发生了变化，这里会展示新的禁言时间。

groupNewOwner

groupNewOwner: ZIMGroupMemberSimpleInfo

详情描述：当原群主离开群并导致群主发生变更时产生的 tips 消息，该字段为 true 并且表示新产生的群主。

ZIMTipsMessagePinStatusChangeInfo

Tips 消息群消息置顶状态变化事件附加信息。

详情

Tips 消息群消息置顶状态变化事件附加信息。

Declared in ZIMDefines.ts

属性

isPinned

isPinned: boolean

描述本次操作是置顶操作还是取消置顶操作。

ZIMMessagePinStatusChangeInfo

消息置顶状态变更通知。

详情

当会话内一条消息被成功置顶或取消置顶并触发通知时，可以通过该结构获取被操作的消息与当前置顶状态。

Declared in ZIMDefines.ts

属性

pinStatus

pinStatus: ZIMMessagePinStatus

消息置顶状态

message

message: ZIMMessage

消息置顶状态变更的消息对象

ZIMMessageReactionChangeInfo

消息表态的变更信息。

详情

描述表态变更信息的类。

Declared in ZIMDefines.ts

属性

message

message: ZIMMessage

详情描述：消息表态信息变更的消息对象，可用于直接替换开发者持有的旧数据。

userChangeInfoList

userChangeInfoList: ZIMMessageReactionUserChangeInfo[]

详情描述：当前消息下的用户表态操作变更的信息列表

ZIMConversation

会话具体内容。

详情

会话的具体内容。

Declared in ZIMDefines.ts

属性

conversationID

conversationID: string

会话ID。

type

type: ZIMConversationType

会话类型。

conversationName

conversationName: string

conversationName,与会话对应的 groupName/userName 值相同。

conversationAvatarUrl

conversationAvatarUrl: string

会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。

conversationAlias

conversationAlias: string

会话别名，通过 [updateFriendAlias] 设置好友备注后，对应的单聊会话该参数会同步修改。通过 [updateGroupAlias] 设置群备注后，对应的群聊会话该参数会同步修改。

notificationStatus

notificationStatus: ZIMConversationNotificationStatus

会话通知状态。

unreadMessageCount

unreadMessageCount: number

会话未读数。

lastMessage

lastMessage: ZIMMessage

最后一条消息。

orderKey

orderKey: number

用于描述消息在会话中的顺序，orderKey 越大越新。

isPinned

isPinned: boolean

会话是否置顶。

pinnedTime

pinnedTime: number

详情描述：会话置顶时间戳。

mentionedInfoList

mentionedInfoList: ZIMMessageMentionedInfo[]

当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。

draft

draft: string

会话草稿，当设置会话草稿后，会话中会带有该字段。

marks

marks: number[]

描述了该会话现有的所有标记。

readMessageSeq

readMessageSeq: number

详情描述：会话已读到的消息序号。

isConversationDisabled

isConversationDisabled: boolean

这个会话是否为不可用的状态。

selfMutedExpiredTime

selfMutedExpiredTime: number

会话禁言的过期时间。

ZIMConversationBaseInfo

会话简要内容。

详情

会话的简要内容。

Declared in ZIMDefines.ts

属性

conversationID

conversationID: string

会话 ID。单聊会话 ID 为对方用户 ID，群聊会话 ID 为群组 ID

conversationType

conversationType: ZIMConversationType

会话类型

ZIMGroupConversation

群会话对象，继承自ZIMGroupConversation。

详情

群会话对象，继承自ZIMGroupConversation。

Declared in ZIMDefines.ts

属性

isDisabled

isDisabled: boolean

这个群会话是否为不可用的状态。

mutedExpiredTime

mutedExpiredTime: number

群禁言的过期时间。

ZIMConversationQueryConfig

查询会话的相关配置。

详情

查询会话时可配置的信息。

Declared in ZIMDefines.ts

属性

nextConversation

nextConversation: ZIMConversation

需要查询的会话。

count

count: unsigned int

需要查询的会话数量。

ZIMConversationFilterOption

查询会话的相关过滤项。

详情

查询会话时可配置的过滤项。

Declared in ZIMDefines.ts

属性

conversationTypes

conversationTypes: ZIMConversationType[]

会话类型列表

marks

marks: number[]

会话标记列表

isOnlyUnreadConversation

isOnlyUnreadConversation: boolean

是否只查询未读会话

pinnedFilter

pinnedFilter: ZIMConversationPinnedFilter

会话置顶过滤

ZIMConversationTotalUnreadMessageCountQueryConfig

查询会话未读消息总数的相关配置项。

详情

查询会话未读消息总数时可配置的过滤项。

Declared in ZIMDefines.ts

属性

conversationTypes

conversationTypes: ZIMConversationType[]

会话类型列表

marks

marks: number[]

会话标记列表

ZIMConversationDeleteConfig

删除会话配置。

详情

删除会话的相关配置。

Declared in ZIMDefines.ts

属性

isAlsoDeleteServerConversation

isAlsoDeleteServerConversation: boolean

是否同时删除服务器会话

ZIMConversationChangeInfo

会话变更信息。

详情

包含会话变更后的信息。

Declared in ZIMDefines.ts

属性

event

event: ZIMConversationEvent

action

action: ZIMConversationListChangeAction

会话变更行为

conversation

conversation: ZIMConversation

变更的会话

ZIMConversationSearchConfig

会话搜索配置。

详情

会话搜索配置。

Declared in ZIMDefines.ts

属性

mode

mode: ZIMConversationSearchMode

会话搜索模式。

nextFlag

nextFlag: unsigned int

分页拉取表示，初始时填 0，后续填从 callback 里返回的 nextFlag，以获取下一分页的数据。

totalConversationCount

totalConversationCount: unsigned int

搜索一次可获取的消息数量。建议小于 20，以降低性能开销。

keywords

keywords: string[]

搜索关键字，最多支持 5 个，否则会报错。例如：传入 1 和 2，则搜索结果只会展示消息同时包含 1 和 2 这两个关键字的会话。

conversationMessageCount

conversationMessageCount: unsigned int

搜索一次，可获取单个会话的本地消息数量，建议小于 10，以降低性能开销。

messageTypes

messageTypes: ZIMMessageType[]

消息类型，可用于指定消息类型。支持传入多个类型。

subMessageTypes

subMessageTypes: unsigned int[]

自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。

senderUserIDs

senderUserIDs: string[]

发送用户 ID，最多支持 5 个。例如，传入 zego2023，则搜索结果只会展示 zego2023 用户发过消息的会话。

startTime

startTime: number

搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。

endTime

endTime: number

搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。

ZIMConversationSearchInfo

会话搜索信息。

详情

会话搜索结果信息类。

Declared in ZIMDefines.ts

属性

conversationID

conversationID: string

要搜索的本地消息的会话 ID。

conversationType

conversationType: ZIMConversationType

会话类型。

conversation

conversation: ZIMConversation

会话对象。

totalMessageCount

totalMessageCount: unsigned int

总消息条数。

messageList

messageList: ZIMMessage[]

搜索到的消息列表

ZIMRoomInfo

房间资料基础对象。

详情

标识一个唯一房间。

Declared in ZIMDefines.ts

属性

roomID

roomID: string

房间 ID，最大 128 字节的字符串，由开发者自定义生成。

roomName

roomName: string

房间名，由开发者自定义生成，最大长度不超过 64 字节的字符串。

ZIMRoomFullInfo

房间详细资料对象。

详情

标识一个房间的详细资料。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMRoomInfo

房间基础信息

ZIMRoomMemberInfo

房间用户信息。

详情

描述房间用户的类。

Declared in ZIMDefines.ts

ZIMRoomMemberQueryConfig

用于查询房间成员的配置。

详情

查找成员时，需要配置此对象。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: string

分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 'nextFlag' 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。

count

count: unsigned int

一次获取多少房间成员。

ZIMRoomAdvancedConfig

房间高级属性配置。

详情

房间的高级属性配置。

Declared in ZIMDefines.ts

属性

roomAttributes

roomAttributes: Map<string, string>

房间中的房间属性，用户可以自定义

roomDestroyDelayTime

roomDestroyDelayTime: unsigned int

房间延迟销毁时间，单位为秒。最长房间延迟销毁时间是3小时。

ZIMRoomAttributesSetConfig

房间属性设置的行为属性。

详情

房间属性设置的行为属性。

Declared in ZIMDefines.ts

属性

isForce

isForce: boolean

是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。

isDeleteAfterOwnerLeft

isDeleteAfterOwnerLeft: boolean

房间属性在拥有者离开房间后自动删除。

isUpdateOwner

isUpdateOwner: boolean

是否更新涉及到的房间属性的拥有者。

ZIMRoomAttributesBatchOperationConfig

房间属性设置的行为属性。

详情

房间属性设置的行为属性。

Declared in ZIMDefines.ts

属性

isForce

isForce: boolean

是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。

isDeleteAfterOwnerLeft

isDeleteAfterOwnerLeft: boolean

房间属性是否在房主离开后自动删除。

isUpdateOwner

isUpdateOwner: boolean

是否更新涉及到的房间属性的拥有者。

ZIMRoomAttributesDeleteConfig

房间属性删除的行为属性。

详情

房间属性删除的行为属性。

Declared in ZIMDefines.ts

属性

isForce

isForce: boolean

是否可以强制删除其他用户的房间属性。如果为true，则可以删除其他用户的房间属性，如果为false，则不允许删除其他用户的房间属性。

ZIMRoomAttributesUpdateInfo

房间属性变更通知。

详情

房间属性变更通知。

Declared in ZIMDefines.ts

属性

action

action: ZIMRoomAttributesUpdateAction

房间属性变更通知的行为信息。

roomAttributes

roomAttributes: Map<string, string>

房间属性。

ZIMRoomMemberAttributesInfo

房间用户属性信息。

详情

描述房间用户属性的类，包含 UserID 以及其对应的属性。

Declared in ZIMDefines.ts

属性

userID

userID: string

用户 ID。

attributes

attributes: Map<string, string>

房间用户属性。

ZIMRoomMemberAttributesOperatedInfo

房间用户属性操作信息。

详情

房间用户属性操作信息，包含成功操作的属性与失败的 Key。

Declared in ZIMDefines.ts

属性

attributesInfo

attributesInfo: ZIMRoomMemberAttributesInfo

房间用户属性信息。

errorKeys

errorKeys: string[]

房间用户属性操作失败的 Key。

ZIMRoomMemberAttributesUpdateInfo

房间用户属性更新信息。

详情

房间用户属性更新信息。

Declared in ZIMDefines.ts

属性

attributesInfo

attributesInfo: ZIMRoomMemberAttributesInfo

房间用户属性。

ZIMRoomMemberAttributesSetConfig

房间用户属性设置配置。

详情

房间用户属性设置配置，包含可配置用户离开后是否保留用户属性等。

Declared in ZIMDefines.ts

业务场景：开发者可以在设置房间用户属性时，根据自身的实际应用场景选择使用。

属性

isDeleteAfterOwnerLeft

isDeleteAfterOwnerLeft: boolean

配置房间用户属性在用户离开房间后，是否保存下来。

ZIMRoomMemberAttributesQueryConfig

房间用户属性查询配置。

详情

房间用户属性查询配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: string

房间用户属性的查询锚点。

count

count: unsigned int

分页查询的数量。

ZIMRoomOperatedInfo

房间操作信息。

详情

房间操作信息。

Declared in ZIMDefines.ts

属性

userID

userID: string

操作者的 UserID。

ZIMGroupInfo

群组信息。

详情

群组信息。

Declared in ZIMDefines.ts

属性

groupID

groupID: string

群组ID。

groupName

groupName: string

群名称。

groupAvatarUrl

groupAvatarUrl: string

群头像 URL。

ZIMGroupMuteInfo

群组禁言信息。

详情

群组禁言信息。

Declared in ZIMDefines.ts

属性

mode

mode: ZIMGroupMuteMode

群组禁言模式。

expiredTime

expiredTime: number

群组禁言过期时间，单位为秒。为 0 时为不禁言，为 -1 时为永久禁言。

roles

roles: number[]

群被禁言角色列表。

ZIMGroupVerifyInfo

入群的验证模式。

详情

群组验证信息类，用于描述群组的进群验证方式。

Declared in ZIMDefines.ts

属性

joinMode

joinMode: ZIMGroupJoinMode

加入群的验证模式。

inviteMode

inviteMode: ZIMGroupInviteMode

邀请入群的验证模式。

beInviteMode

beInviteMode: ZIMGroupBeInviteMode

被邀请入群的验证模式。

ZIMGroupFullInfo

群组完整的信息。

详情

群组完整的信息。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMGroupInfo

基本群组信息。

groupNotice

groupNotice: string

群公告。

groupAttributes

groupAttributes: Map<string, string>

群组属性。

groupAlias

groupAlias: string

群备注

notificationStatus

notificationStatus: ZIMGroupMessageNotificationStatus

群组消息通知状态。

mutedInfo

mutedInfo: ZIMGroupMuteInfo

群禁言信息。

createTime

createTime: number

群创建时的服务端的时间戳。

maxMemberCount

maxMemberCount: unsigned int

群成员最大数量。

verifyInfo

verifyInfo: ZIMGroupVerifyInfo

入群的验证模式。

ZIMGroup

群组列表的完整的信息。

详情

群组列表的完整的信息。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMGroupInfo

基本群组信息。

groupAlias

groupAlias: string

用户自定的仅该用户可见的群备注。

notificationStatus

notificationStatus: ZIMGroupMessageNotificationStatus

群组消息通知状态。

ZIMGroupMemberSimpleInfo

群成员简要信息。

详情

群组成员的简要信息类。

Declared in ZIMDefines.ts

属性

memberNickname

memberNickname: string

群组成员昵称。

memberRole

memberRole: number

群角色，1：群主，2：管理员，3：群成员。

ZIMGroupEnterInfo

群成员入群时的信息。

详情

用户进入群组的信息类。

Declared in ZIMDefines.ts

属性

enterTime

enterTime: number

入群时服务端的时间戳。

enterType

enterType: ZIMGroupEnterType

入群类型。

operatedUser

operatedUser: ZIMGroupMemberSimpleInfo

入群类型。

ZIMGroupMemberInfo

群组成员信息。

详情

群组成员信息。

Declared in ZIMDefines.ts

属性

memberNickname

memberNickname: string

群组成员昵称。

memberRole

memberRole: number

群角色，1：群主，2：管理员，3：群成员。

muteExpiredTime

muteExpiredTime: number

群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。

groupEnterInfo

groupEnterInfo: ZIMGroupEnterInfo

群成员入群时的信息。

ZIMGroupOperatedInfo

群组引发事件变化操作者的信息。

详情

群组引发事件变化操作者的信息。

Declared in ZIMDefines.ts

属性

userID

userID: string

操作者的用户 ID。

userName

userName: string

操作者的用户名。

memberNickname

memberNickname: string

操作者的群成员昵称。

memberRole

memberRole: number

操作者的群成员角色。

ZIMGroupMemberQueryConfig

群成员查询配置。

详情

群成员查询配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

下一个标志。

count

count: unsigned int

数量，上限为 100，超过 100 则按照 100 处理。

ZIMGroupAdvancedConfig

群组高级配置。

详情

群组高级配置。

Declared in ZIMDefines.ts

属性

groupNotice

groupNotice: string

群公告。

groupAttributes

groupAttributes: Map<string, string>

群组属性，最多可配置 10 个。

maxMemberCount

maxMemberCount: unsigned int

群成员最大数量。

joinMode

joinMode: ZIMGroupJoinMode

入群模式。

inviteMode

inviteMode: ZIMGroupInviteMode

邀请模式。

beInviteMode

beInviteMode: ZIMGroupBeInviteMode

邀请目标验证模式。

ZIMGroupAttributesUpdateInfo

群属性更新信息。

详情

群属性更新信息。

Declared in ZIMDefines.ts

属性

action

action: ZIMGroupAttributesUpdateAction

群属性更新行为。

groupAttributes

groupAttributes: Map<string, string>

群属性。

ZIMGroupMessageReceiptMemberQueryConfig

群消息回执已读/未读成员查询配置。

详情

群消息回执已读/未读成员查询配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

下一个标志。初始填 0，后续从 [ZIMGroupMessageReceiptMemberListQueriedCallback] 回调拿到下一个的 nextFlag。

count

count: unsigned int

需要查询的群成员数量。

ZIMGroupSearchConfig

群搜索配置。

详情

群搜索配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

查询的 flag 。

count

count: unsigned int

搜索一次，可获取的群组数量。建议小于 20，以降低性能开销。

keywords

keywords: string[]

搜索关键字。例如：传入 '1' 和 '2'，则搜索结果只会展示群名称同时包含 '1' 和 '2' 这两个关键字的群组。

isAlsoMatchGroupMemberUserName

isAlsoMatchGroupMemberUserName: boolean

搜索范围是否包括群成员用户名称，默认为 false。

isAlsoMatchGroupMemberNickname

isAlsoMatchGroupMemberNickname: boolean

搜索范围是否包括群成员用户昵称，默认为 false。

ZIMGroupSearchInfo

群搜索信息。

详情

群组搜索信息。

Declared in ZIMDefines.ts

属性

groupInfo

groupInfo: ZIMGroupInfo

群信息

userList

userList: ZIMGroupMemberInfo[]

群成员信息。

ZIMGroupMemberSearchConfig

群成员搜索配置。

详情

群成员搜索配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

查询的 flag ，第一次调用接口时填 0。后续再次调用接口时填从 callback 里返回的 nextFlag，以便获取剩余数据。

count

count: unsigned int

结果的数量。

keywords

keywords: string[]

搜索关键字，最多支持 5 个，否则会报错。例如：传入 '1' 和 '2'，则搜索结果只会展示名称同时包含 '1' 和 '2' 这两个关键字的群成员。

isAlsoMatchGroupMemberNickname

isAlsoMatchGroupMemberNickname: boolean

搜索范围是否包括群成员用户昵称，默认为 false。

ZIMGroupMuteConfig

群组禁言配置。

详情

群组禁言配置。

Declared in ZIMDefines.ts

属性

mode

mode: ZIMGroupMuteMode

群组禁言模式。

duration

duration: number

群组禁言时长，单位是秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。

roles

roles: number[]

群角色列表。

ZIMGroupMemberMuteConfig

群组成员禁言配置。

详情

群组成员禁言配置。

Declared in ZIMDefines.ts

属性

duration

duration: number

群组成员禁言时长，单位是秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。

ZIMGroupMemberMutedListQueryConfig

群禁言成员列表查询配置。

详情

群禁言成员列表查询配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned long long

下一个标志。

count

count: unsigned int

数量。

ZIMGroupApplicationInfo

入群申请信息。

详情

群组申请信息类，包含进群或邀请申请的详细信息。

Declared in ZIMDefines.ts

属性

type

type: ZIMGroupApplicationType

入群申请类型。

state

state: ZIMGroupApplicationState

入群申请状态。

groupInfo

groupInfo: ZIMGroupInfo

申请入群的群信息。

applyUser

applyUser: ZIMUserInfo

类型为加入申请时是申请人，类型为邀请申请时是被邀请人，类型为被邀请申请时是邀请人。

createTime

createTime: number

入群申请创建时间戳，单位为毫秒。

updateTime

updateTime: number

入群申请状态更新时间，单位为毫秒。

wording

wording: string

入群申请附言。

operatedUser

operatedUser: ZIMGroupMemberSimpleInfo

同意外部用户加群申请的操作人。

ZIMGroupJoinApplicationSendConfig

发送加群申请的配置。

详情

发送进群申请的配置类。

Declared in ZIMDefines.ts

属性

wording

wording: string

申请的附言。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMGroupJoinApplicationAcceptConfig

接受加群申请的配置。

详情

接受进群申请的配置类。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMGroupJoinApplicationRejectConfig

拒绝加群申请的配置。

详情

拒绝进群申请的配置类。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMGroupInviteApplicationSendConfig

发送邀请入群申请的配置。

详情

发送邀请入群申请的配置类。

Declared in ZIMDefines.ts

属性

wording

wording: string

申请的附言。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMGroupInviteApplicationAcceptConfig

接受邀请入群申请的配置。

详情

接受邀请入群申请的配置类。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMGroupInviteApplicationRejectConfig

拒绝邀请入群申请的配置。

详情

拒绝邀请入群申请的配置类。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMGroupApplicationListQueryConfig

入群申请查询配置。

详情

通过该配置可以设置查询总条数以及分页查询

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

下一个标志。

count

count: unsigned int

数量，建议不超过 30。

ZIMGroupListQueryConfig

群组列表查询配置。

详情

查询群组列表的配置类。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: number

下一个标志。

userIDs

userIDs: string[]

指定用户列表。

ZIMCallUserInfo

呼叫邀请用户信息。

详情

呼叫邀请用户信息。

Declared in ZIMDefines.ts

属性

userID

userID: string

用户ID。

state

state: ZIMCallUserState

用户状态。

extendedData

extendedData: string

呼叫邀请用户信息中的附加信息。

ZIMCallInviteConfig

发送呼叫邀请设置的行为属性。

详情

发送呼叫邀请设置的行为属性。

Declared in ZIMDefines.ts

属性

timeout

timeout: unsigned int

呼叫邀请的超时时长，单位为秒，范围为 [1, 600]。

mode

mode: ZIMCallInvitationMode

呼叫邀请模式配置。

extendedData

extendedData: string

扩展字段，邀请者可通过该字段携带信息给被邀请者。

enableNotReceivedCheck

enableNotReceivedCheck: boolean

通过值为 true 的情况下，本次呼叫邀请以及后续呼叫中邀请将会检测邀请是否送达。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMCallingInviteConfig

邀请用户进入当前呼叫设置的行为属性。

详情

邀请用户进入当前呼叫设置的行为属性。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMCallJoinConfig

加入呼叫邀请设置的行为属性。

详情

加入呼叫邀请设置的行为属性。

Declared in ZIMDefines.ts

属性

extendedData

extendedData: string

扩展字段，邀请者可通过该字段携带信息给被邀请者。

ZIMCallQuitConfig

退出呼叫邀请设置的行为属性。

详情

退出呼叫邀请设置的行为属性。

Declared in ZIMDefines.ts

属性

extendedData

extendedData: string

扩展字段，邀请者可通过该字段携带信息给被邀请者。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMCallEndConfig

结束呼叫邀请设置的行为属性。

详情

结束呼叫邀请设置的行为属性。

Declared in ZIMDefines.ts

属性

extendedData

extendedData: string

扩展字段，邀请者可通过该字段携带信息给被邀请者。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMCallCancelConfig

取消呼叫邀请设置的行为属性。

详情

取消呼叫邀请设置的行为属性。

Declared in ZIMDefines.ts

属性

extendedData

extendedData: string

扩展字段，邀请者可通过该字段携带信息给被邀请者。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMCallAcceptConfig

接受呼叫邀请设置的行为属性。

详情

接受呼叫邀请设置的行为属性。

Declared in ZIMDefines.ts

属性

extendedData

extendedData: string

扩展字段，邀请者可通过该字段携带信息给被邀请者。

ZIMCallRejectConfig

用于设置拒绝呼叫邀请的配置项。

详情

用于发送拒绝邀请时自定义呼叫邀请的配置。

Declared in ZIMDefines.ts

业务场景：用户需要在调用拒绝呼叫邀请时将配置项传入接口。

属性

extendedData

extendedData: string

用于发送拒绝邀请时附加自定义内容的额外字段。

ZIMCallInvitationQueryConfig

查询呼叫邀请列表的设置属性。

详情

查询呼叫邀请列表的设置属性。

Declared in ZIMDefines.ts

属性

count

count: unsigned int

查询条数，最多限制 100 条。传入数值超过 100，按照 100 处理。

nextFlag

nextFlag: number

查询列表的标志位。首次查询时无需填充，查询后 callback 会返回一个 nextFlag,下次查询时填入可以在上一次的基础上继续往后查询。

ZIMCallInfo

呼叫邀请信息。

详情

呼叫邀请信息。

Declared in ZIMDefines.ts

属性

callID

callID: string

呼叫邀请 ID。

caller

caller: string

呼叫邀请发起者 ID。

inviter

inviter: string

呼叫邀请的发起者 ID。

createTime

createTime: number

呼叫邀请创建时间戳。

endTime

endTime: number

呼叫邀请结束时间。

state

state: ZIMCallState

呼叫邀请状态。

mode

mode: ZIMCallInvitationMode

呼叫邀请模式。

extendedData

extendedData: string

创建呼叫邀请附加信息。

callUserList

callUserList: ZIMCallUserInfo[]

呼叫邀请成员列表。

ZIMCallUserStateChangeInfo

呼叫成员状态变化信息。

详情

呼叫成员状态变化信息。

Declared in ZIMDefines.ts

属性

callUserList

callUserList: ZIMCallUserInfo[]

发生状态变化的呼叫成员列表。

ZIMBlacklistQueryConfig

黑名单查询配置。

详情

通过该配置可以设置查询总条数以及分页查询

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

下一个标志。

count

count: unsigned int

数量。

ZIMFriendAddConfig

添加好友设置的行为属性。

详情

添加好友设置的行为属性。

Declared in ZIMDefines.ts

属性

friendAlias

friendAlias: string

好友备注。

friendAttributes

friendAttributes: Map<string, string>

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

wording

wording: string

添加好友附言。

ZIMFriendDeleteConfig

删除好友设置的行为属性。

详情

添加好友设置的行为属性。

Declared in ZIMDefines.ts

属性

type

type: ZIMFriendDeleteType

删除类型。

ZIMFriendListQueryConfig

查询好友列表配置。

详情

查询好友列表配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

当前查询锚点下标。

count

count: unsigned int

当前查询总数。

ZIMFriendSearchConfig

好友搜索配置。

详情

好友搜索的配置类。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

查询下一页的分页标志。

count

count: unsigned int

每页查询的好友数量。

keywords

keywords: string[]

搜索关键词，最多支持 5 个。

isAlsoMatchFriendAlias

isAlsoMatchFriendAlias: boolean

是否同时匹配好友备注名称。

ZIMFriendRelationCheckConfig

检查好友关系的行为属性。

详情

检查好友关系的行为属性。

Declared in ZIMDefines.ts

属性

type

type: ZIMFriendRelationCheckType

检查类型。

ZIMFriendRelationInfo

好友关系信息。

详情

好友关系信息。

Declared in ZIMDefines.ts

属性

type

type: ZIMUserRelationType

好友关系类型。

userID

userID: string

用户ID。

ZIMFriendInfo

好友信息。

详情

好友信息。

Declared in ZIMDefines.ts

属性

friendAlias

friendAlias: string

好友备注。

friendAttributes

friendAttributes: Map<string, string>

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

createTime

createTime: number

好友添加时间。

wording

wording: string

添加好友时的附言。

ZIMFriendApplicationSendConfig

发起好友申请的行为属性。

详情

发起好友申请的行为属性。

Declared in ZIMDefines.ts

属性

wording

wording: string

添加好友附言。

friendAlias

friendAlias: string

好友备注。

friendAttributes

friendAttributes: Map<string, string>

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

pushConfig

pushConfig: ZIMPushConfig

离线推送配置。

ZIMFriendApplicationAcceptConfig

接受好友申请的行为属性。

详情

接受好友申请的行为属性。

Declared in ZIMDefines.ts

属性

friendAlias

friendAlias: string

好友别名。

friendAttributes

friendAttributes: Map<string, string>

好友属信

pushConfig

pushConfig: ZIMPushConfig

离线推送配置

ZIMFriendApplicationRejectConfig

拒绝好友申请的行为属性。

详情

拒绝好友申请的行为属性。

Declared in ZIMDefines.ts

属性

pushConfig

pushConfig: ZIMPushConfig

离线推送配置

ZIMFriendApplicationListQueryConfig

查询好友申请列表配置。

详情

查询好友申请列表配置。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: unsigned int

当前查询锚点下标。

count

count: unsigned int

当前查询总数。

ZIMFriendApplicationInfo

好友申请信息。

详情

好友申请信息。

Declared in ZIMDefines.ts

属性

type

type: ZIMFriendApplicationType

好友申请类型。

state

state: ZIMFriendApplicationState

好友申请状态。

applyUser

applyUser: ZIMUserInfo

如果自己是申请人，则这里是被申请人信息；如果自己是被申请人，则这里是申请人信息；

wording

wording: string

好友申请附言。

createTime

createTime: number

好友添加时间。

updateTime

updateTime: number

好友申请状态更新时间。

ZIMCommunityInfo

社群基本信息。

详情

社群基本信息类。

Declared in ZIMDefines.ts

属性

communityID

communityID: string

社群 ID。

communityName

communityName: string

社群名称。

communityAvatarUrl

communityAvatarUrl: string

社群头像 URL。

ZIMCommunity

社群对象。

详情

社群信息类，包含社群的基本属性。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMCommunityInfo

社群基础信息。

totalUnreadMessageCount

totalUnreadMessageCount: unsigned int

所有频道的总未读消息数。

ZIMCommunityFullInfo

社群完整信息。

详情

社群完整信息类，包含社群的所有属性。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMCommunityInfo

社群基础信息。

communityNotice

communityNotice: string

社群公告。

communityAttributes

communityAttributes: Map<string, string>

社群属性。

createTime

createTime: number

社群创建时间。

creatorUserID

creatorUserID: string

社群创建者的用户 ID。

currentMemberCount

currentMemberCount: unsigned int

当前社群成员数量。

notificationStatus

notificationStatus: ZIMCommunityMessageNotificationStatus

社群消息通知状态。

ZIMCommunityCreateConfig

创建社群的配置。

详情

创建社群的配置类。

Declared in ZIMDefines.ts

属性

communityNotice

communityNotice: string

创建社群时设置的社群公告。

communityAttributes

communityAttributes: Map<string, string>

创建社群时设置的社群属性。

ZIMCommunityListQueryConfig

查询社群列表的配置。

详情

查询社群列表的配置类。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: number

查询下一页的分页标志。

ZIMCommunityChangeInfo

社群变更信息

详情

社群变更信息类，描述社群属性的变化。

Declared in ZIMDefines.ts

属性

action

action: ZIMCommunityListChangeAction

社群列表变更事件

community

community: ZIMCommunity

变更的社群

ZIMCommunityMemberListQueryConfig

社群成员列表查询配置

详情

查询社群成员列表的配置类。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: number

分页标记，用于获取下一页列表数据。

channelID

channelID: string

是否指定频道 ID 进行查询

isMutedMember

isMutedMember: boolean

是否指定查询被禁言的成员

ZIMCommunityFullInfoUpdateInfo

社群详细信息的变更信息

详情

社群完整信息更新通知类。

Declared in ZIMDefines.ts

属性

communityInfo

communityInfo: ZIMCommunityFullInfo

变更后的社群详细信息

ZIMCommunityMemberEnterInfo

社群成员进入信息

详情

社群成员进入社群的信息类。

Declared in ZIMDefines.ts

属性

enterTime

enterTime: number

社群进入时间

enterType

enterType: ZIMCommunityMemberEnterType

社群进入事件类型

operatedUserID

operatedUserID: string

社群进入操作者 userID

ZIMCommunityMemberMuteInfo

社群成员禁言信息

详情

社群成员禁言状态信息类。

Declared in ZIMDefines.ts

属性

muteType

muteType: ZIMCommunityMemberMuteType

社群成员禁言类型

channelID

channelID: string

禁言所在的频道 ID，为空则为社群层面禁言。

muteExpiredTime

muteExpiredTime: number

成员禁言的到期时间。

ZIMCommunityMemberInfo

社群成员信息

详情

社群成员信息类。

Declared in ZIMDefines.ts

属性

memberRole

memberRole: number

社群成员角色，1 为社群主，2 为管理员，3 为普通成员

enterInfo

enterInfo: ZIMCommunityMemberEnterInfo

社群成员进入信息

muteInfo

muteInfo: ZIMCommunityMemberMuteInfo

社群成员被禁言信息

ZIMCommunityMemberSimpleInfo

社群成员简要信息

详情

社群成员简要信息类。

Declared in ZIMDefines.ts

属性

memberRole

memberRole: number

社群成员角色，1 为社群主，2 为管理员，3 为普通成员

ZIMCommunityMemberStateChangeInfo

社群成员的状态变更信息

详情

社群成员状态变更信息类。

Declared in ZIMDefines.ts

属性

state

state: ZIMCommunityMemberChangeState

社群成员状态

action

action: ZIMCommunityMemberChangeAction

社群成员状态变更事件

memberInfo

memberInfo: ZIMCommunityMemberSimpleInfo

状态变更的社群成员简要信息

ZIMCommunityMemberInfoUpdateInfo

社群成员详细信息的变更信息

详情

社群成员信息更新通知类。

Declared in ZIMDefines.ts

属性

memberInfo

memberInfo: ZIMCommunityMemberInfo

社群成员变更信息

ZIMCommunityChannelInfo

社群频道基本信息。

详情

社群频道基本信息类。

Declared in ZIMDefines.ts

属性

channelID

channelID: string

频道 ID。

channelType

channelType: ZIMCommunityChannelType

社群频道类型。

channelName

channelName: string

频道名称。

channelAvatarUrl

channelAvatarUrl: string

频道头像 URL。

communityID

communityID: string

频道所属的社群 ID。

ZIMCommunityChannelMuteInfo

社群频道禁言信息

详情

社群频道禁言状态信息类。

Declared in ZIMDefines.ts

属性

mode

mode: ZIMCommunityChannelMuteMode

社群频道禁言模式

expiredTime

expiredTime: number

频道禁言的到期时间。

roles

roles: number[]

社群频道中被禁言的角色列表。

ZIMCommunityChannel

社群频道对象。

详情

社群频道信息类，包含频道的基本属性。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMCommunityChannelInfo

社群频道基础信息。

conversationID

conversationID: string

社群频道的会话 ID。

channelAttributes

channelAttributes: Map<string, string>

社群频道属性。

notificationStatus

notificationStatus: ZIMConversationNotificationStatus

社群频道的消息通知状态。

unreadMessageCount

unreadMessageCount: number

社群频道的未读消息数量。

lastMessage

lastMessage: ZIMMessage

社群频道中的最后一条消息。

mentionedInfoList

mentionedInfoList: ZIMMessageMentionedInfo[]

社群频道中的 @ 信息列表。

selfMutedExpiredTime

selfMutedExpiredTime: number

本端用户在该频道的禁言到期时间。

draft

draft: string

社群频道的草稿消息。

ZIMCommunityChannelFullInfo

社群频道完整信息。

详情

社群频道完整信息类，包含频道的所有属性。

Declared in ZIMDefines.ts

属性

baseInfo

baseInfo: ZIMCommunityChannelInfo

频道基础信息。

createTime

createTime: number

频道创建时间。

creatorUserID

creatorUserID: string

频道创建者的用户 ID。

channelNotice

channelNotice: string

频道公告。

channelAttributes

channelAttributes: Map<string, string>

频道属性。

currentMemberCount

currentMemberCount: number

当前频道成员数量。

muteInfo

muteInfo: ZIMCommunityChannelMuteInfo

社群频道的禁言信息。

ZIMCommunityChannelCreateConfig

创建社群频道的配置。

详情

创建社群频道的配置类。

Declared in ZIMDefines.ts

属性

channelNotice

channelNotice: string

创建频道时设置的频道公告。

channelAttributes

channelAttributes: Map<string, string>

创建频道时设置的频道属性。

ZIMCommunityChannelListQueryConfig

查询社群频道列表的配置。

详情

查询社群频道列表的配置类。

Declared in ZIMDefines.ts

属性

nextFlag

nextFlag: number

查询下一页的分页标志。

ZIMCommunityChannelChangeInfo

社群频道变更信息。

详情

社群频道变更信息类，描述频道属性的变化。

Declared in ZIMDefines.ts

属性

action

action: ZIMCommunityChannelListChangeAction

频道列表变更的动作类型。

channel

channel: ZIMCommunityChannel

发生变更的社群频道信息。

ZIMCommunityChannelFullInfoUpdateInfo

社群频道详细信息的变更信息

详情

社群频道完整信息更新通知类。

Declared in ZIMDefines.ts

属性

channelInfo

channelInfo: ZIMCommunityChannelFullInfo

变更后的社群频道详细信息

ZIMCommunityChannelMuteConfig

社群频道禁言配置

详情

社群频道禁言的配置类。

Declared in ZIMDefines.ts

属性

mode

mode: ZIMCommunityChannelMuteMode

社群频道禁言模式

roles

roles: number[]

要禁言的角色列表，为空则禁言所有角色。

duration

duration: number

禁言时长（秒），0 表示解除禁言。

ZIMCommunityMemberMuteConfig

社群成员禁言配置

详情

社群成员禁言的配置类。

Declared in ZIMDefines.ts

属性

duration

duration: number

禁言时长（秒），0 表示解除禁言。

channelID

channelID: string

频道 ID，为空则在社群层面禁言。

ZIMConnectionStateChangedEventResult

连接状态发生改变的事件回调。

Declared in ZIMEventHandler.ts

属性

state

state: ZIMConnectionState

连接状态

event

event: ZIMConnectionEvent

连接事件

extendedData

extendedData: string

事件发生时额外信息，标准 JSON 字符串

ZIMTokenWillExpireEventResult

Token 将要过期的提醒回调。

Declared in ZIMEventHandler.ts

属性

second

second: unsigned int

剩余秒数

ZIMUserInfoUpdatedEventResult

用户信息更新的回调。

Declared in ZIMEventHandler.ts

属性

info

info: ZIMUserFullInfo

用户信息

ZIMUserStatusUpdatedEventResult

用户在线状态变更通知。

Declared in ZIMEventHandler.ts

属性

userStatusList

userStatusList: ZIMUserStatus[]

用户状态列表

ZIMUserRuleUpdatedEventResult

用户规则变更的回调。

Declared in ZIMEventHandler.ts

属性

userRule

userRule: ZIMUserRule

用户规则

ZIMConversationChangedEventResult

收到会话更新的通知回调。

Declared in ZIMEventHandler.ts

属性

infoList

infoList: ZIMConversationChangeInfo[]

会话变更信息列表

ZIMConversationsAllDeletedEventResult

所有会话被删除时触发此事件。

Declared in ZIMEventHandler.ts

属性

count

count: number

会话数量

ZIMConversationSyncStateChangedEventResult

收到会话列表同步进度的通知回调。

Declared in ZIMEventHandler.ts

属性

state

state: ZIMConversationSyncState

会话同步状态。

ZIMConversationTotalUnreadMessageCountUpdatedEventResult

会话总未读数更新的通知回调。

Declared in ZIMEventHandler.ts

属性

totalUnreadMessageCount

totalUnreadMessageCount: number

会话未读消息总数

ZIMConversationMessageReceiptChangedEventResult

收到回执的会话已读更新的通知回调。

Declared in ZIMEventHandler.ts

属性

infos

infos: ZIMMessageReceiptInfo[]

会话消息回执变更信息列表

ZIMMessageReceiptChangedEventResult

收到回执的消息已读更新的通知回调。

Declared in ZIMEventHandler.ts

属性

infos

infos: ZIMMessageReceiptInfo[]

消息回执变更信息列表

ZIMMessageRevokeReceivedEventResult

收到撤回消息的回调。

Declared in ZIMEventHandler.ts

属性

messageList

messageList: ZIMRevokeMessage[]

消息撤回列表

ZIMMessageReactionsChangedEventResult

收到表态变更的回调。

Declared in ZIMEventHandler.ts

属性

reactions

reactions: ZIMMessageReaction[]

消息表态变更信息列表

changeInfoList

changeInfoList: ZIMMessageReactionChangeInfo[]

消息表态变更信息列表

ZIMMessageRepliedCountChangedEventResult

回复消息树的数量发生变更的事件。

Declared in ZIMEventHandler.ts

属性

infos

infos: ZIMMessageRootRepliedCountInfo[]

消息根回复数量变更信息列表

ZIMMessageRepliedInfoChangedEventResult

回复消息的回复信息的变更事件。

Declared in ZIMEventHandler.ts

属性

messageList

messageList: ZIMMessage[]

消息回复信息变更信息列表

ZIMMessageDeletedEventResult

消息被删除的回调。

Declared in ZIMEventHandler.ts

属性

conversationID

conversationID: string

会话 ID

conversationType

conversationType: ZIMConversationType

会话类型

messageDeleteType

messageDeleteType: ZIMMessageDeleteType

消息删除类型

messageList

messageList: ZIMMessage[]

消息删除列表。当 isDeleteConversationAllMessage 为 false，以及 ZIMMessageDeleteType 为 [ZIMMessageDeleteTypeMessageListDeleted] 时，此参数有效

ZIMMessageSentStatusChangedEventResult

收到消息发送状态变化的回调。

Declared in ZIMEventHandler.ts

属性

infos

infos: ZIMMessageSentStatusChangeInfo[]

消息发送状态变更信息列表

ZIMBroadcastMessageReceivedEventResult

收到全员推送消息的回调。

Declared in ZIMEventHandler.ts

属性

message

message: ZIMMessage

广播消息

ZIMConversationMessageReceivedEventResult

收到群消息的回调。

Declared in ZIMEventHandler.ts

属性

messageList

messageList: ZIMMessage[]

会话消息列表

fromConversationID

fromConversationID: string

消息来源会话 ID

info

info: ZIMMessageReceivedInfo

消息接收信息

ZIMMessageReceivedEventResult

收到消息时触发此事件。

Declared in ZIMEventHandler.ts

属性

messageList

messageList: ZIMMessage[]

消息列表

receivedInfo

receivedInfo: ZIMMessageReceivedInfo

消息接收信息

ZIMMessageEditedEventResult

消息编辑事件回调结果

Declared in ZIMEventHandler.ts

属性

messageList

messageList: ZIMMessage[]

消息列表

ZIMMessagePinStatusChangedEventResult

消息置顶事件回调结果

Declared in ZIMEventHandler.ts

属性

infos

infos: ZIMMessagePinStatusChangeInfo[]

消息置顶状态变更信息列表

ZIMRoomStateChangedEventResult

房间连接状态发生改变的事件回调。

Declared in ZIMEventHandler.ts

属性

roomID

roomID: string

房间 ID

state

state: ZIMRoomState

房间状态

event

event: ZIMRoomEvent

房间状态变更事件

extendedData

extendedData: string

扩展数据

ZIMRoomMemberChangedEventResult

房间成员加入或离开时触发此事件。

Declared in ZIMEventHandler.ts

属性

roomID

roomID: string

房间 ID

memberList

memberList: ZIMUserInfo[]

房间成员列表

ZIMRoomAttributesUpdatedEventResult

房间属性变更通知。

Declared in ZIMEventHandler.ts

属性

roomID

roomID: string

房间 ID

infos

infos: ZIMRoomAttributesUpdateInfo[]

房间属性变更信息列表

ZIMRoomMemberAttributesUpdatedEventResult

房间用户属性更新回调。

Declared in ZIMEventHandler.ts

属性

roomID

roomID: string

房间 ID

infos

infos: ZIMRoomMemberAttributesUpdateInfo[]

房间成员属性变更信息列表

operatedInfo

operatedInfo: ZIMRoomOperatedInfo

操作信息

ZIMGroupStateChangedEventResult

群状态变更通知回调。

Declared in ZIMEventHandler.ts

属性

state

state: ZIMGroupState

群组状态

event

event: ZIMGroupEvent

群组状态变更事件

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

groupInfo

groupInfo: ZIMGroupFullInfo

群组信息

ZIMGroupNameUpdatedEventResult

群名称更新通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

groupName

groupName: string

群组名称

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupAvatarUrlUpdatedEventResult

群头像 URL 更新通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

groupAvatarUrl

groupAvatarUrl: string

群组头像 URL

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupNoticeUpdatedEventResult

群公告更新的通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

groupNotice

groupNotice: string

群组公告

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupAliasUpdatedEventResult

群备注更新通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

groupAlias

groupAlias: string

群组别名

operatedUserID

operatedUserID: string

操作人用户 ID

ZIMGroupAttributesUpdatedEventResult

群属性更新通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

infoList

infoList: ZIMGroupAttributesUpdateInfo[]

群组属性变更信息列表

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupMutedInfoUpdatedEventResult

群禁言更新的通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

mutedInfo

mutedInfo: ZIMGroupMuteInfo

群组禁言信息

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupVerifyInfoUpdatedEventResult

入群验证模式更新的通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

verifyInfo

verifyInfo: ZIMGroupVerifyInfo

群组验证信息

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupApplicationListChangedEventResult

当入群申请列表发生变化时会回调当前方法

Declared in ZIMEventHandler.ts

属性

action

action: ZIMGroupApplicationListChangeAction

群组申请列表变更操作

applicationList

applicationList: ZIMGroupApplicationInfo[]

群组申请列表

ZIMGroupApplicationUpdatedEventResult

当入群申请列表发生变化时会回调当前方法

Declared in ZIMEventHandler.ts

属性

applicationList

applicationList: ZIMGroupApplicationInfo[]

群组申请列表

ZIMGroupMemberStateChangedEventResult

群成员状态变更通知回调。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

state

state: ZIMGroupMemberState

群成员状态

event

event: ZIMGroupMemberEvent

群成员状态变更事件

userList

userList: ZIMGroupMemberInfo[]

群成员列表

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMGroupMemberInfoUpdatedEventResult

群成员基本信息变更通知。

Declared in ZIMEventHandler.ts

属性

groupID

groupID: string

群组 ID

userList

userList: ZIMGroupMemberInfo[]

群成员列表

operatedInfo

operatedInfo: ZIMGroupOperatedInfo

操作信息

ZIMCallInvitationCreatedEventResult

邀请者创建的呼叫邀请回调。

Declared in ZIMEventHandler.ts

属性

callID

callID: string

呼叫 ID

mode

mode: ZIMCallInvitationMode

呼叫模式

caller

caller: string

呼叫者用户 ID

extendedData

extendedData: string

扩展数据

timeout

timeout: number

呼叫超时时间

createTime

createTime: number

呼叫创建时间

callUserList

callUserList: ZIMCallUserInfo[]

呼叫用户列表

ZIMCallInvitationReceivedEventResult

被邀请者收到的呼叫邀请的通知回调。

Declared in ZIMEventHandler.ts

属性

callID

callID: string

呼叫 ID

mode

mode: ZIMCallInvitationMode

呼叫模式

caller

caller: string

呼叫者用户 ID

inviter

inviter: string

邀请者用户 ID

extendedData

extendedData: string

扩展数据

timeout

timeout: number

呼叫超时时间

createTime

createTime: number

呼叫创建时间

callUserList

callUserList: ZIMCallUserInfo[]

呼叫用户列表

ZIMCallInvitationCancelledEventResult

被邀请者收到的取消邀请的通知回调。

Declared in ZIMEventHandler.ts

属性

callID

callID: string

呼叫 ID

mode

mode: ZIMCallInvitationMode

呼叫邀请模式。

inviter

inviter: string

邀请者用户 ID

extendedData

extendedData: string

扩展数据

ZIMCallInvitationTimeoutEventResult

被邀请者的呼叫邀请超时的通知回调。

Declared in ZIMEventHandler.ts

属性

callID

callID: string

呼叫 ID

mode

mode: ZIMCallInvitationMode

呼叫模式

ZIMCallInvitationEndedEventResult

呼叫结束的通知回调。

Declared in ZIMEventHandler.ts

属性

callID

callID: string

呼叫 ID

mode

mode: ZIMCallInvitationMode

呼叫模式

caller

caller: string

呼叫者用户 ID

operatedUserID

operatedUserID: string

操作用户 ID

extendedData

extendedData: string

扩展数据

endTime

endTime: number

呼叫结束时间

ZIMCallUserStateChangedEventResult

呼叫邀请内的用户状态的通知回调。

Declared in ZIMEventHandler.ts

属性

callID

callID: string

呼叫 ID

callUserList

callUserList: ZIMCallUserInfo[]

呼叫用户列表

ZIMBlacklistChangedEventResult

当黑名单列表发生变化时会回调当前方法

Declared in ZIMEventHandler.ts

属性

userList

userList: ZIMUserInfo[]

黑名单用户列表

action

action: ZIMBlacklistChangeAction

操作类型

ZIMFriendListChangedEventResult

当好友列表发生变化时会回调当前方法

Declared in ZIMEventHandler.ts

属性

friendList

friendList: ZIMFriendInfo[]

好友列表

action

action: ZIMFriendListChangeAction

操作类型

ZIMFriendInfoUpdatedEventResult

当好友信息更新时候会触发该回调。

Declared in ZIMEventHandler.ts

属性

friendList

friendList: ZIMFriendInfo[]

好友信息列表

ZIMFriendApplicationListChangedEventResult

好友申请列表变更事件回调

Declared in ZIMEventHandler.ts

属性

applicationList

applicationList: ZIMFriendApplicationInfo[]

好友申请列表

action

action: ZIMFriendApplicationListChangeAction

操作类型

ZIMFriendApplicationUpdatedEventResult

当好友申请列表发生更新时会回调当前方法

Declared in ZIMEventHandler.ts

属性

applicationList

applicationList: ZIMFriendApplicationInfo[]

好友申请列表

ZIMCommunityListChangedEventResult

社群列表变更事件

Declared in ZIMEventHandler.ts

属性

changeInfoList

changeInfoList: ZIMCommunityChangeInfo[]

社群变更信息列表

ZIMCommunityInfoUpdatedEventResult

社群详情信息变更事件

Declared in ZIMEventHandler.ts

属性

updateInfoList

updateInfoList: ZIMCommunityFullInfoUpdateInfo[]

社群详情信息变更列表

ZIMCommunityMemberStateChangedEventResult

社群成员状态变更事件

Declared in ZIMEventHandler.ts

属性

communityID

communityID: string

社群 ID。

changeInfoList

changeInfoList: ZIMCommunityMemberStateChangeInfo[]

社群成员状态变更列表

ZIMCommunityMemberInfoUpdatedEventResult

社群成员详细信息变更事件

Declared in ZIMEventHandler.ts

属性

communityID

communityID: string

社群 ID。

updateInfoList

updateInfoList: ZIMCommunityMemberInfoUpdateInfo[]

社群成员信息变更列表

ZIMCommunityChannelListChangedEventResult

社群频道列表变更事件

Declared in ZIMEventHandler.ts

属性

communityID

communityID: string

社群 ID。

changeInfoList

changeInfoList: ZIMCommunityChannelChangeInfo[]

社群频道变更信息列表

ZIMCommunityChannelInfoUpdatedEventResult

社群频道详情信息变更事件

Declared in ZIMEventHandler.ts

属性

communityID

communityID: string

社群 ID。

updateInfoList

updateInfoList: ZIMCommunityChannelFullInfoUpdateInfo[]

社群频道详情信息变更列表

ZIMLogUploadedResult

方法

onLogUploaded

type ZIMLogUploadedResult = () => void

上传日志结果的回调。

ZIMLoggedInResult

方法

onLoggedIn

type ZIMLoggedInResult = () => void

登录结果的回调。

开发者登录结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
触发时机：当开发者调用 [login] 接口时，会触发该回调。

支持版本：1.2.0 及以上。

ZIMTokenRenewedResult

方法

onTokenRenewed

type ZIMTokenRenewedResult = (token: string) => void

更新 Token 的结果的回调。

参数

名称	类型	描述
token	string	更新后的 Token。

ZIMUserNameUpdatedResult

方法

onUserNameUpdated

type ZIMUserNameUpdatedResult = (userName: string) => void

更新 user name 的回调。

参数

名称	类型	描述
userName	string	更新后的用户名称。

ZIMUserAvatarUrlUpdatedResult

方法

onUserAvatarUrlUpdated

type ZIMUserAvatarUrlUpdatedResult = (userAvatarUrl: string) => void

更新 user avatar URL 的回调。

参数

名称	类型	描述
userAvatarUrl	string	更新后的用户头像 URL。

ZIMUserExtendedDataUpdatedResult

方法

onUserExtendedDataUpdated

type ZIMUserExtendedDataUpdatedResult = (extendedData: string) => void

更新 user extended data 的回调。

参数

名称	类型	描述
extendedData	string	更新后的用户扩展信息。

ZIMUserCustomStatusUpdatedResult

方法

onUserCustomStatusUpdated

type ZIMUserCustomStatusUpdatedResult = (customStatus: string) => void

更新用户自定义状态结果的回调。

参数

名称	类型	描述
customStatus	string	更新后的用户自定义状态。

ZIMUsersInfoQueriedResult

方法

onUsersInfoQueried

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

查询 userInfo 的回调。

参数

名称	类型	描述
userList	ZIMUserFullInfo[]	查询到的用户信息列表。
errorUserList	ZIMErrorUserInfo[]	查询失败的用户 ID 列表。

ZIMUserOfflinePushRuleUpdatedResult

方法

onUserOfflinePushRuleUpdated

type ZIMUserOfflinePushRuleUpdatedResult = (offlinePushRule: ZIMUserOfflinePushRule) => void

更新用户离线推送规则结果的回调。

参数

名称	类型	描述
offlinePushRule	ZIMUserOfflinePushRule	更新后的用户离线推送规则。

ZIMSelfUserInfoQueriedResult

方法

onSelfUserInfoQueried

type ZIMSelfUserInfoQueriedResult = (selfUserInfo: ZIMSelfUserInfo) => void

查询当前用户信息和规则结果的回调。

参数

名称	类型	描述
selfUserInfo	ZIMSelfUserInfo	当前用户信息和规则。

ZIMUsersStatusQueriedResult

方法

onUsersStatusQueried

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

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

参数

名称	类型	描述
userStatusList	ZIMUserStatus[]	查询到的用户状态列表。
errorUserList	ZIMErrorUserInfo[]	查询失败的用户 ID 列表。

ZIMUsersStatusSubscribedResult

方法

onUsersStatusSubscribed

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

批量订阅接口的操作结果回调。

参数

名称	类型	描述
errorUserList	ZIMErrorUserInfo[]	订阅失败的用户 ID 列表。

ZIMUsersStatusUnsubscribedResult

方法

onUsersStatusUnsubscribed

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

批量取消订阅接口的操作回调。

参数

名称	类型	描述
errorUserList	ZIMErrorUserInfo[]	取消订阅失败的用户 ID 列表。

ZIMSubscribedUserStatusListQueriedResult

方法

onSubscribedUserStatusListQueried

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

查询当前用户订阅列表操作的结果回调。

参数

名称	类型	描述
userStatusSubscriptionList	ZIMUserStatusSubscription[]	当前用户的状态订阅列表。

ZIMConversationQueriedResult

方法

onConversationQueried

type ZIMConversationQueriedResult = (conversation: ZIMConversation) => void

查询指定会话结果的回调。

参数

名称	类型	描述
conversation	ZIMConversation	查询到的会话对象。

ZIMConversationListQueriedResult

方法

onConversationListQueried

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

查询会话列表结果的回调。

参数

名称	类型	描述
conversationList	ZIMConversation[]	查询到的会话列表。

ZIMConversationTotalUnreadMessageCountQueriedResult

方法

onConversationTotalUnreadMessageCountQueried

type ZIMConversationTotalUnreadMessageCountQueriedResult = (unreadMessageCount: number) => void

查询会话未读消息总数结果的回调。

参数

名称	类型	描述
unreadMessageCount	number	当前会话未读消息总数。

ZIMConversationDeletedResult

方法

onConversationDeleted

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

删除会话结果的回调。

参数

名称	类型	描述
conversationID	string	被删除的会话 ID。
conversationType	ZIMConversationType	被删除的会话类型。

ZIMConversationsAllDeletedResult

方法

onConversationsAllDeleted

type ZIMConversationsAllDeletedResult = () => void

删除所有会话结果的回调。

ZIMConversationUnreadMessageCountClearedResult

方法

onConversationUnreadMessageCountCleared

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

清除会话未读消息数结果的回调。

参数

名称	类型	描述
conversationID	string	已清除未读消息数的会话 ID。
conversationType	ZIMConversationType	已清除未读消息数的会话类型。

ZIMConversationTotalUnreadMessageCountClearedResult

方法

onConversationTotalUnreadMessageCountCleared

type ZIMConversationTotalUnreadMessageCountClearedResult = () => void

清除全部会话未读消息数结果的回调。

ZIMConversationNotificationStatusSetResult

方法

onConversationNotificationStatusSet

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

设置会话消息通知状态结果的回调。

参数

名称	类型	描述
conversationID	string	设置通知状态的会话 ID。
conversationType	ZIMConversationType	设置通知状态的会话类型。

ZIMConversationMessageReceiptReadSentResult

方法

onConversationMessageReceiptReadSent

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

发送会话消息已读回执结果的回调。

参数

名称	类型	描述
conversationID	string	发送已读回执的会话 ID。
conversationType	ZIMConversationType	发送已读回执的会话类型。

ZIMConversationPinnedStateUpdatedResult

方法

onConversationPinnedStateUpdated

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

更新会话置顶状态结果的回调。

参数

名称	类型	描述
conversationID	string	更新置顶状态的会话 ID。
conversationType	ZIMConversationType	更新置顶状态的会话类型。

ZIMConversationPinnedListQueriedResult

方法

onConversationPinnedListQueried

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

查询置顶会话列表结果的回调。

参数

名称	类型	描述
conversationList	ZIMConversation[]	查询到的置顶会话列表。

ZIMConversationDraftSetResult

方法

onConversationDraftSet

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

设置会话草稿结果的回调。

参数

名称	类型	描述
conversationID	string	设置草稿的会话 ID。
conversationType	ZIMConversationType	设置草稿的会话类型。

ZIMConversationMarkSetResult

方法

onConversationMarkSet

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

设置会话标记结果的回调。

参数

名称	类型	描述
failedConversationInfos	ZIMConversationBaseInfo[]	设置标记失败的会话信息列表。

ZIMConversationsSearchedResult

方法

onConversationsSearched

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

基于本地消息搜索本地会话结果的返回。

参数

名称	类型	描述
conversationSearchInfoList	ZIMConversationSearchInfo[]	搜索到的会话列表。
nextFlag	number	查询下一页的分页标志。

ZIMMessageSentResult

方法

onMessageSent

type ZIMMessageSentResult = (message: ZIMMessage) => void

发送消息结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。

ZIMMessageAttachedResult

方法

onMessageAttached

type ZIMMessageAttachedResult = (message: ZIMMessage) => void

为传入的消息对象赋予 localMessgeID 并返回。

参数

名称	类型	描述
message	ZIMMessage	消息对象。

ZIMMediaUploadingProgress

方法

onMediaUploadingProgress

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

媒体文件上传进度的回调。

参数

名称	类型	描述
message	ZIMMediaMessage	媒体消息对象。
currentFileSize	unsigned long long	当前文件大小。
totalFileSize	unsigned long long	总文件大小。

ZIMMultipleMediaUploadingProgress

方法

onMultipleMediaUploadingProgress

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

多个媒体文件上传进度的回调。

参数

名称	类型	描述
message	ZIMMultipleMessage	组合消息对象。
currentFileSize	number	当前文件大小。
totalFileSize	number	总文件大小。
messageInfoIndex	number	当前组合消息的内容索引。
currentIndexFileSize	number	组合消息索引下的文件当前大小。
totalIndexFileSize	number	组合消息索引下的文件总大小。

ZIMMessageQueriedResult

方法

onMessageQueried

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

开发者通过该回调获取查询到的消息列表，可以做历史消息显示。

参数

名称	类型	描述
conversationID	string	会话 ID。
conversationType	ZIMConversationType	会话类型。
messageList	ZIMMessage[]	消息列表。

ZIMMessageDeletedResult

方法

onMessageDeleted

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

删除消息结果的回调。

参数

名称	类型	描述
conversationID	string	会话 ID。
conversationType	ZIMConversationType	会话类型。

ZIMConversationMessagesAllDeletedResult

方法

onConversationMessagesAllDeleted

type ZIMConversationMessagesAllDeletedResult = () => void

删除指定会话全部消息结果的回调。

ZIMMessageRevokedResult

方法

onMessageRevoked

type ZIMMessageRevokedResult = (message: ZIMMessage) => void

撤回消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。

ZIMMessageInsertedResult

方法

onMessageInserted

type ZIMMessageInsertedResult = (message: ZIMMessage) => void

插入本地消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。

ZIMMessageLocalExtendedDataUpdatedResult

方法

onMessageLocalExtendedDataUpdated

type ZIMMessageLocalExtendedDataUpdatedResult = (message: ZIMMessage) => void

更新消息本地扩展字段结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。

ZIMMessageReceiptsReadSentResult

方法

onMessageReceiptsReadSent

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

发送消息已读回执结果的回调。

参数

名称	类型	描述
conversationID	string	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorMessageIDs	string[]	错误消息 ID 列表。

ZIMMessageReceiptsInfoQueriedResult

方法

onMessageReceiptsInfoQueried

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

查询消息已读回执信息结果的回调。

参数

名称	类型	描述
infos	ZIMMessageReceiptInfo[]	消息回执信息列表。
errorMessageIDs	string[]	错误消息 ID 列表。

ZIMMessagesSearchedResult

方法

onMessagesSearched

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

搜索本地消息结果的回调。

参数

名称	类型	描述
conversationID	string	会话 ID。
conversationType	ZIMConversationType	会话类型。
messageList	ZIMMessage[]	消息列表。
nextMessage	ZIMMessage	下一个消息对象。

ZIMMessagesGlobalSearchedResult

方法

onMessagesGlobalSearched

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

全局搜索本地消息结果的回调。

参数

名称	类型	描述
messageList	ZIMMessage[]	消息列表。
nextMessage	ZIMMessage	下一个消息对象。

ZIMMessageReactionAddedResult

方法

onMessageReactionAdded

type ZIMMessageReactionAddedResult = (reaction: ZIMMessageReaction) => void

添加消息表情回应结果的回调。

参数

名称	类型	描述
reaction	ZIMMessageReaction	消息反应对象。

ZIMMessageReactionDeletedResult

方法

onMessageReactionDeleted

type ZIMMessageReactionDeletedResult = (reaction: ZIMMessageReaction) => void

删除消息表情回应结果的回调。

参数

名称	类型	描述
reaction	ZIMMessageReaction	消息反应对象。

ZIMMessageReactionUserListQueriedResult

方法

onMessageReactionUserListQueried

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

查询消息表情回应用户列表结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。
userInfoList	ZIMMessageReactionUserFullInfo[]	用户表态详情信息列表
reactionType	string	消息反应类型。
nextFlag	number	列表查询锚点，用于查询下一个分页。当前值返回 0 的情况下代表列表已全部拉取完毕。
totalCount	number	用户总数。

ZIMCombineMessageDetailQueriedResult

方法

onCombineMessageDetailQueried

type ZIMCombineMessageDetailQueriedResult = (message: ZIMCombineMessage) => void

查询合并消息详情结果的回调。

参数

名称	类型	描述
message	ZIMCombineMessage	组合消息对象。该对象中的 messageList 已携带合并消息的子消息列表。

ZIMMessageRepliedListQueriedResult

方法

onMessageRepliedListQueried

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

查询回复消息列表的结果的回调。

参数

名称	类型	描述
messageList	ZIMMessage[]	消息列表。
nextFlag	number	列表查询锚点，用于查询下一个分页。当前值返回 0 的情况下代表列表已全部拉取完毕。
rootRepliedInfo	ZIMMessageRootRepliedInfo	根消息回复信息。

ZIMMessageEditedResult

方法

onMessageEdited

type ZIMMessageEditedResult = (message: ZIMMessage) => void

编辑消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。

ZIMSendingMessageCancelledResult

方法

onSendingMessageCancelled

type ZIMSendingMessageCancelledResult = () => void

取消发送中消息的操作结果回调。

ZIMMessagePinnedResult

方法

onMessagePinned

type ZIMMessagePinnedResult = () => void

置顶或取消置顶消息的结果的回调。

ZIMPinnedMessageListQueriedResult

方法

onPinnedMessageListQueried

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

开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。

参数

名称	类型	描述
messageList	ZIMMessage[]	置顶消息列表。

ZIMRoomCreatedResult

方法

onRoomCreated

type ZIMRoomCreatedResult = (roomInfo: ZIMRoomFullInfo) => void

创建房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	房间信息。

ZIMRoomJoinedResult

方法

onRoomJoined

type ZIMRoomJoinedResult = (roomInfo: ZIMRoomFullInfo) => void

加入房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	房间信息。

ZIMRoomEnteredResult

方法

onRoomEntered

type ZIMRoomEnteredResult = (roomInfo: ZIMRoomFullInfo) => void

进入房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	房间信息。

ZIMRoomSwitchedResult

方法

onRoomSwitched

type ZIMRoomSwitchedResult = (roomInfo: ZIMRoomFullInfo) => void

切换房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	房间信息。

ZIMRoomLeftResult

方法

onRoomLeft

type ZIMRoomLeftResult = (roomID: string) => void

离开房间的结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。

ZIMRoomAllLeftResult

方法

onRoomAllLeft

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

离开所有房间的结果的回调。

参数

名称	类型	描述
roomIDs	string[]	房间 ID 列表。

ZIMRoomMemberQueriedResult

方法

onRoomMemberQueried

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

查询房间成员列表结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
memberList	ZIMUserInfo[]	房间成员列表。
nextFlag	string	用于查询下一页。当前值返回空字符串，表示已拉取完。

ZIMRoomMembersQueriedResult

方法

onRoomMembersQueried

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

查询指定房间成员信息结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
memberList	ZIMRoomMemberInfo[]	房间成员列表。
errorUserList	ZIMErrorUserInfo[]	错误成员列表。

ZIMRoomOnlineMemberCountQueriedResult

方法

onRoomOnlineMemberCountQueried

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

查询房间在线人数结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
count	unsigned int	在线成员数量。

ZIMRoomAttributesOperatedResult

方法

onRoomAttributesOperated

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

操作房间属性结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
errorKeys	string[]	错误键列表。

ZIMRoomAttributesBatchOperatedResult

方法

onRoomAttributesBatchOperated

type ZIMRoomAttributesBatchOperatedResult = (roomID: string) => void

批量操作房间属性结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。

ZIMRoomAttributesQueriedResult

方法

onRoomAttributesQueried

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

查询房间属性结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
roomAttributes	Map<string, string>	房间属性。

ZIMRoomMembersAttributesOperatedResult

方法

onRoomMembersAttributesOperated

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

设置房间成员属性结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
infos	ZIMRoomMemberAttributesOperatedInfo[]	房间成员属性操作信息列表。
errorUserList	string[]	错误成员列表。

ZIMRoomMembersAttributesQueriedResult

方法

onRoomMembersAttributesQueried

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

批量查询房间成员属性结果的回调。

参数

名称	类型	描述
roomID	string	房间 ID。
infos	ZIMRoomMemberAttributesInfo[]	房间成员属性信息列表。

ZIMRoomMemberAttributesListQueriedResult

方法

onRoomMemberAttributesListQueried

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

房间内用户属性列表查询结果的返回。

参数

名称	类型	描述
roomID	string	房间 ID。
infos	ZIMRoomMemberAttributesInfo[]	房间成员属性信息列表。
nextFlag	string	用于查询下一页的标志。当前值返回 0，表示已拉取完列表。

ZIMGroupCreatedResult

方法

onGroupCreated

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

创建群组结果的回调。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群组信息。
userList	ZIMGroupMemberInfo[]	群成员信息列表。
errorUserList	ZIMErrorUserInfo[]	错误成员列表。

ZIMGroupDismissedResult

方法

onGroupDismissed

type ZIMGroupDismissedResult = (groupID: string) => void

解散群组结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。

ZIMGroupJoinedResult

方法

onGroupJoined

type ZIMGroupJoinedResult = (groupInfo: ZIMGroupFullInfo) => void

加入群组结果的回调。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群组信息。

ZIMGroupLeftResult

方法

onGroupLeft

type ZIMGroupLeftResult = (groupID: string) => void

退出群组结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。

ZIMGroupUsersInvitedResult

方法

onGroupUsersInvited

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

用户被邀请进群的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
userList	ZIMGroupMemberInfo[]	群成员信息列表。
errorUserList	ZIMErrorUserInfo[]	错误成员列表。

ZIMGroupMemberKickedResult

方法

onGroupMemberKicked

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

踢出群成员的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
kickedUserIDList	string[]	被踢出的用户 ID 列表。
errorUserList	ZIMErrorUserInfo[]	错误成员列表。

ZIMGroupOwnerTransferredResult

方法

onGroupOwnerTransferred

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

群主转让的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
toUserID	string	新群主用户 ID。

ZIMGroupNameUpdatedResult

方法

onGroupNameUpdated

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

更新群组名称结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
groupName	string	群组名称。

ZIMGroupAvatarUrlUpdatedResult

方法

onGroupAvatarUrlUpdated

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

更新群组头像 URL 结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
groupAvatarUrl	string	群组头像 URL。

ZIMGroupNoticeUpdatedResult

方法

onGroupNoticeUpdated

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

更新群组公告结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
groupNotice	string	群组公告。

ZIMGroupAliasUpdatedResult

方法

onGroupAliasUpdated

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

更新群组别名结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
groupAlias	string	群组别名。

ZIMGroupInfoQueriedResult

方法

onGroupInfoQueried

type ZIMGroupInfoQueriedResult = (groupInfo: ZIMGroupFullInfo) => void

查询群组信息结果的回调。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群组信息。

ZIMGroupAttributesOperatedResult

方法

onGroupAttributesOperated

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

操作群组属性结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
errorKeys	string[]	操作失败的属性。

ZIMGroupAttributesQueriedResult

方法

onGroupAttributesQueried

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

查询群组属性结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
groupAttributes	Map<string, string>	群组属性。

ZIMGroupMemberRoleUpdatedResult

方法

onGroupMemberRoleUpdated

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

更新群成员角色结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
forUserID	string	被操作的用户 ID。
role	number	用户角色。

ZIMGroupMemberNicknameUpdatedResult

方法

onGroupMemberNicknameUpdated

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

群成员昵称更新的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
forUserID	string	被操作的用户 ID。
nickname	string	用户昵称。

ZIMGroupMemberInfoQueriedResult

方法

onGroupMemberInfoQueried

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

查询群成员信息结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
userInfo	ZIMGroupMemberInfo	群成员用户信息。

ZIMGroupListQueriedResult

方法

onGroupListQueried

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

查询群组列表结果的回调。

参数

名称	类型	描述
groupList	ZIMGroup[]	群组列表。
nextFlag	number	SDK 返回的分页锚点，若为 0 代表列表已拉取完毕，若不为 0 代表还存在未查询的数据。

ZIMGroupMemberListQueriedResult

方法

onGroupMemberListQueried

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

查询群成员列表的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
userList	ZIMGroupMemberInfo[]	群成员列表。
nextFlag	unsigned int	用于查询下一页。当前值返回 0，表示列表已拉取完毕。

ZIMGroupMemberCountQueriedResult

方法

onGroupMemberCountQueried

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

查询群成员数量的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
count	unsigned int	群成员数量。

ZIMGroupMessageReceiptMemberListQueriedResult

方法

onGroupMessageReceiptMemberListQueried

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

查询群回执消息具体已读/未读成员列表的回调接口。

参数

名称	类型	描述
groupID	string	群组 ID。
userList	ZIMGroupMemberInfo[]	群成员列表。
nextFlag	unsigned int	用于查询下一页。当前值返回 0，表示列表已拉取完毕。

ZIMGroupMutedResult

方法

onGroupMuted

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

更新群组禁言状态结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
isMute	boolean	是否禁言。
mutedInfo	ZIMGroupMuteInfo	群禁言信息。

ZIMGroupMembersMutedResult

方法

onGroupMembersMuted

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

更新群成员禁言状态结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
isMute	boolean	是否禁言。
duration	number	禁言时长。
mutedUserIDs	string[]	被禁言的群成员用户 ID 列表。
errorUserList	ZIMErrorUserInfo[]	禁言失败的用户信息列表。

ZIMGroupMemberMutedListQueriedResult

方法

onGroupMemberMutedListQueried

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

查询群组被禁言成员列表结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
nextFlag	number	用于查询下一页。当前值返回 0，表示列表已拉取完毕。
userList	ZIMGroupMemberInfo[]	群成员列表。

ZIMGroupsSearchedResult

方法

onGroupsSearched

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

搜索群组结果的回调。

参数

名称	类型	描述
groupSearchInfoList	ZIMGroupSearchInfo[]	群组搜索信息列表。
nextFlag	unsigned int	用于查询下一页。当前值返回 0，表示列表已拉取完毕。

ZIMGroupMembersSearchedResult

方法

onGroupMembersSearched

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

搜索群成员的结果的返回。

参数

名称	类型	描述
groupID	string	群组 ID。
userList	ZIMGroupMemberInfo[]	群成员列表。
nextFlag	unsigned int	用于查询下一页。当前值返回 0，表示列表已拉取完毕。

ZIMGroupJoinModeUpdatedResult

方法

onGroupJoinModeUpdated

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

更新群组加入模式结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
mode	ZIMGroupJoinMode	群组加入模式。

ZIMGroupInviteModeUpdatedResult

方法

onGroupInviteModeUpdated

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

更新群组邀请模式结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
mode	ZIMGroupInviteMode	群组邀请模式。

ZIMGroupBeInviteModeUpdatedResult

方法

onGroupBeInviteModeUpdated

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

更新群组被邀请模式结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
mode	ZIMGroupBeInviteMode	群组被邀请模式。

ZIMGroupJoinApplicationSentResult

方法

onGroupJoinApplicationSent

type ZIMGroupJoinApplicationSentResult = (groupID: string) => void

发送群组加入申请结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。

ZIMGroupJoinApplicationAcceptedResult

方法

onGroupJoinApplicationAccepted

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

接受群组加入申请结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
userID	string	用户 ID。

ZIMGroupJoinApplicationRejectedResult

方法

onGroupJoinApplicationRejected

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

拒绝群组加入申请结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
userID	string	用户 ID。

ZIMGroupInviteApplicationsSentResult

方法

onGroupInviteApplicationsSent

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

发送群组邀请申请结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
errorUserList	ZIMErrorUserInfo[]	邀请失败的用户信息列表。

ZIMGroupInviteApplicationAcceptedResult

方法

onGroupInviteApplicationAccepted

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

接受群组邀请申请结果的回调。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群组信息。
inviterUserID	string	邀请者用户 ID。

ZIMGroupInviteApplicationRejectedResult

方法

onGroupInviteApplicationRejected

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

拒绝群组邀请申请结果的回调。

参数

名称	类型	描述
groupID	string	群组 ID。
inviterUserID	string	邀请者用户 ID。

ZIMGroupApplicationListQueriedResult

方法

onGroupApplicationListQueried

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

查询群组申请列表结果的回调。

参数

名称	类型	描述
applicationList	ZIMGroupApplicationInfo[]	群组申请信息列表。
nextFlag	number	分页标记，用于获取下一页。当前值返回 0，表示已拉取完。

ZIMCallInvitationSentResult

方法

onCallInvitationSent

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

发送呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。
timeout	number
errorUserList	ZIMErrorUserInfo[]	邀请失败的用户信息列表。

ZIMCallingInvitationSentResult

方法

onCallingInvitationSent

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

在通话中发送邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。
errorUserList	ZIMErrorUserInfo[]	邀请失败的用户信息列表。

ZIMCallCancelSentResult

方法

onCallCancelSent

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

取消呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。
errorInvitees	string[]	呼叫邀请失败的用户 ID 列表。

ZIMCallAcceptanceSentResult

方法

onCallAcceptanceSent

type ZIMCallAcceptanceSentResult = (callID: string) => void

接受呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。

ZIMCallRejectionSentResult

方法

onCallRejectionSent

type ZIMCallRejectionSentResult = (callID: string) => void

拒绝呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。

ZIMCallJoinSentResult

方法

onCallJoinSent

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

加入呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。
createTime	number	呼叫创建的时间戳，单位为毫秒。
joinTime	number	加入呼叫的时间戳，单位为毫秒。
extendedData	string	扩展数据。
callUserList	ZIMCallUserInfo[]	呼叫用户信息列表。

ZIMCallQuitSentResult

方法

onCallQuitSent

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

退出呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。
createTime	number	呼叫创建的时间戳，单位为毫秒。
acceptTime	number	接受呼叫的时间戳，单位为毫秒。
quitTime	number	退出呼叫的时间戳，单位为毫秒。

ZIMCallEndSentResult

方法

onCallEndSent

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

结束呼叫邀请操作结果的回调。

参数

名称	类型	描述
callID	string	呼叫 ID。
createTime	number	呼叫创建的时间戳，单位为毫秒。
acceptTime	number	接受呼叫的时间戳，单位为毫秒。
endTime	number	结束呼叫的时间戳，单位为毫秒。

ZIMCallInvitationListQueriedResult

方法

onCallInvitationListQueried

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

查询呼叫列表结果的回调。

参数

名称	类型	描述
callList	ZIMCallInfo[]	呼叫信息列表。
nextFlag	number	分页标记，用于获取下一页。当前值返回 0，表示已拉取完。

ZIMFriendAddedResult

方法

onFriendAdded

type ZIMFriendAddedResult = (friendInfo: ZIMFriendInfo) => void

添加好友结果的回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。

ZIMFriendsDeletedResult

方法

onFriendsDeleted

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

删除好友结果的回调。

参数

名称	类型	描述
errorUserList	ZIMErrorUserInfo[]	删除失败的好友信息列表。

ZIMFriendListQueriedResult

方法

onFriendListQueried

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

查询好友列表结果的回调。

参数

名称	类型	描述
friendList	ZIMFriendInfo[]	好友信息列表。
nextFlag	number	分页标记，用于获取下一页。当前值返回 0，表示已拉取完。

ZIMFriendsInfoQueriedResult

方法

onFriendsInfoQueried

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

批量查询好友信息结果的回调。

参数

名称	类型	描述
friendInfos	ZIMFriendInfo[]	好友信息列表。
errorUserList	ZIMErrorUserInfo[]	查询失败的好友信息列表。

ZIMFriendsRelationCheckedResult

方法

onFriendsRelationChecked

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

检查好友关系结果的回调。

参数

名称	类型	描述
relationInfos	ZIMFriendRelationInfo[]	好友关系信息列表。
errorUserList	ZIMErrorUserInfo[]	查询失败的好友信息列表。

ZIMFriendApplicationSentResult

方法

onFriendApplicationSent

type ZIMFriendApplicationSentResult = (applicationInfo: ZIMFriendApplicationInfo) => void

发送好友申请结果的回调。

参数

名称	类型	描述
applicationInfo	ZIMFriendApplicationInfo	好友申请信息。

ZIMFriendApplicationAcceptedResult

方法

onFriendApplicationAccepted

type ZIMFriendApplicationAcceptedResult = (friendInfo: ZIMFriendInfo) => void

接受好友申请结果的回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。

ZIMFriendApplicationRejectedResult

方法

onFriendApplicationRejected

type ZIMFriendApplicationRejectedResult = (userInfo: ZIMUserInfo) => void

拒绝好友申请结果的回调。

参数

名称	类型	描述
userInfo	ZIMUserInfo	用户信息。

ZIMFriendApplicationListQueriedResult

方法

onFriendApplicationListQueried

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

查询好友申请列表结果的回调。

参数

名称	类型	描述
applicationList	ZIMFriendApplicationInfo[]	好友申请信息列表。
nextFlag	number	分页标记，用于获取下一页。当前值返回 0，表示已拉取完。

ZIMFriendAliasUpdatedResult

方法

onFriendAliasUpdated

type ZIMFriendAliasUpdatedResult = (friendInfo: ZIMFriendInfo) => void

更新好友备注名称结果的回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。

ZIMFriendAttributesUpdatedResult

方法

onFriendAttributesUpdated

type ZIMFriendAttributesUpdatedResult = (friendInfo: ZIMFriendInfo) => void

更新好友属性结果的回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。

ZIMFriendsSearchedResult

方法

onFriendsSearched

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

搜索本地好友结果的回调。

参数

名称	类型	描述
friendInfos	ZIMFriendInfo[]	好友信息列表。
nextFlag	number	分页标记，用于获取下一页。当前值返回 0，表示已拉取完。

ZIMBlacklistUsersAddedResult

方法

onBlacklistUsersAdded

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

添加用户到黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	ZIMErrorUserInfo[]	添加黑名单失败的用户信息列表。

ZIMBlacklistUsersRemovedResult

方法

onBlacklistUsersRemoved

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

移除用户出黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	ZIMErrorUserInfo[]	移除黑名单失败的用户信息列表。

ZIMBlacklistQueriedResult

方法

onBlacklistQueried

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

查询黑名单结果的回调。

参数

名称	类型	描述
blacklist	ZIMUserInfo[]	黑名单用户信息列表。
nextFlag	number	分页标记，用于获取下一页。当前值返回 0，表示已拉取完。

ZIMBlacklistCheckedResult

方法

onBlacklistChecked

type ZIMBlacklistCheckedResult = (isUserInBlacklist: boolean) => void

检查黑名单结果的回调。

参数

名称	类型	描述
isUserInBlacklist	boolean	是否在黑名单中。

ZIMCommunityCreatedResult

方法

onCommunityCreated

type ZIMCommunityCreatedResult = (communityInfo: ZIMCommunityFullInfo) => void

创建社群结果的回调。

参数

名称	类型	描述
communityInfo	ZIMCommunityFullInfo	社群信息。

ZIMCommunityDismissedResult

方法

onCommunityDismissed

type ZIMCommunityDismissedResult = (communityID: string) => void

解散社群结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。

ZIMCommunityJoinedResult

方法

onCommunityJoined

type ZIMCommunityJoinedResult = (communityInfo: ZIMCommunityFullInfo) => void

加入社群结果的回调。

参数

名称	类型	描述
communityInfo	ZIMCommunityFullInfo	社群信息。

ZIMCommunityLeftResult

方法

onCommunityLeft

type ZIMCommunityLeftResult = (communityID: string) => void

退出社群结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。

ZIMCommunityListQueriedResult

方法

onCommunityListQueried

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

查询社群列表结果的回调。

参数

名称	类型	描述
communityList	ZIMCommunity[]	社群列表。
nextFlag	number	下一次查询社群列表的锚点。

ZIMCommunityNameUpdatedResult

方法

onCommunityNameUpdated

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

更新社群名称结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
communityName	string	社群名称。

ZIMCommunityAvatarUrlUpdatedResult

方法

onCommunityAvatarUrlUpdated

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

更新社群头像 URL 结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
communityAvatarUrl	string	社群头像 URL。

ZIMCommunityNoticeUpdatedResult

方法

onCommunityNoticeUpdated

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

更新社群公告结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
communityNotice	string	社群公告。

ZIMCommunityAttributesOperatedResult

方法

onCommunityAttributesOperated

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

操作社群属性结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
errorKeys	string[]	操作失败的属性。

ZIMCommunityNotificationStatusSetResult

方法

onCommunityNotificationStatusSet

type ZIMCommunityNotificationStatusSetResult = (communityID: string) => void

设置社群消息通知状态结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。

ZIMCommunityInfoQueriedResult

方法

onCommunityInfoQueried

type ZIMCommunityInfoQueriedResult = (communityInfo: ZIMCommunityFullInfo) => void

查询社群信息结果的回调。

参数

名称	类型	描述
communityInfo	ZIMCommunityFullInfo	社群信息。

ZIMCommunityUsersInvitedResult

方法

onCommunityUsersInvited

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

邀请用户加入社群结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
errorUserList	ZIMErrorUserInfo[]	出错的用户 ID 列表。

ZIMCommunityMembersKickedResult

方法

onCommunityMembersKicked

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

踢出社群成员结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
errorUserList	ZIMErrorUserInfo[]	出错的用户 ID 列表。

ZIMCommunityMemberRoleUpdatedResult

方法

onCommunityMemberRoleUpdated

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

更新社群成员角色结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
forUserID	string	设置的用户 ID
memberRole	number	成员角色值

ZIMCommunityOwnerTransferredResult

方法

onCommunityOwnerTransferred

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

转让社群所有者结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
toUserID	string	设置的用户 ID

ZIMCommunityMemberListQueriedResult

方法

onCommunityMemberListQueried

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

查询社群成员列表结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
memberList	ZIMCommunityMemberInfo[]	社群成员列表
nextFlag	number	下一次查询社群列表的锚点。

ZIMCommunityMembersQueriedResult

方法

onCommunityMembersQueried

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

查询指定社群成员信息结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
memberList	ZIMCommunityMemberInfo[]	社群成员列表
errorUserList	ZIMErrorUserInfo[]	查询出错的用户列表

ZIMCommunityChannelCreatedResult

方法

onCommunityChannelCreated

type ZIMCommunityChannelCreatedResult = (channelInfo: ZIMCommunityChannelFullInfo) => void

创建社群频道结果的回调。

参数

名称	类型	描述
channelInfo	ZIMCommunityChannelFullInfo	社群频道信息。

ZIMCommunityChannelDismissedResult

方法

onCommunityChannelDismissed

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

解散社群频道结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelID	string	社群频道 ID

ZIMCommunityChannelNameUpdatedResult

方法

onCommunityChannelNameUpdated

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

更新社群频道名称结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelID	string	社群频道 ID。
channelName	string	社群频道名称。

ZIMCommunityChannelAvatarUrlUpdatedResult

方法

onCommunityChannelAvatarUrlUpdated

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

更新社群频道头像 URL 结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelID	string	社群频道 ID。
channelAvatarUrl	string	社群频道头像 URL。

ZIMCommunityChannelNoticeUpdatedResult

方法

onCommunityChannelNoticeUpdated

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

更新社群频道公告结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelID	string	社群频道 ID。
channelNotice	string	社群频道公告。

ZIMCommunityChannelAttributesOperatedResult

方法

onCommunityChannelAttributesOperated

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

操作社群频道属性结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelID	string	社群频道 ID。
errorKeys	string[]	操作失败的属性。

ZIMCommunityChannelsInfoQueriedResult

方法

onCommunityChannelsInfoQueried

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

查询社群频道信息结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelInfos	ZIMCommunityChannelFullInfo[]	查询到的社群频道列表。
errorChannelIDs	string[]	查询失败的频道 ID 列表。

ZIMCommunityChannelListQueriedResult

方法

onCommunityChannelListQueried

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

查询社群频道列表结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelList	ZIMCommunityChannel[]	社群频道列表。
nextFlag	number	查询下一页频道列表的锚点。

ZIMCommunityMembersMutedResult

方法

onCommunityMembersMuted

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

禁言社群成员结果的回调。

参数

名称	类型	描述
communityID	string	社群 ID。
channelID	string	频道 ID，为空则在社群层面禁言。
isMute	boolean	是否禁言。
errorUserList	ZIMErrorUserInfo[]	操作失败的用户列表。