SDK 事件名称到事件载荷的映射。

interface EventPayloadMap {
    onConnecting: ConnectionEventPayload;
    onConnected: ConnectionEventPayload;
    onDisconnected: ConnectionEventPayload;
    onReconnectFailed: ConnectionEventPayload;
    onTokenWillExpire: undefined;
    onTokenExpired: undefined;
    onOfflineMessageSyncStart: undefined;
    onOfflineMessageSyncFinish: undefined;
    onMessage: Message;
    onStreamMessage: StreamMessage;
    onConversationListUpdate: ConversationListUpdatePayload;
    onMessageReadReceipts: readonly MessageReceiptEventPayload[];
    onMessageDelivered: MessageDeliveredEventPayload;
    onMessageRecalled: MessageRecalledEventPayload;
    onMessageUpdated: MessageUpdatedEventPayload;
    onReactionChanged: ReactionChangedEventPayload;
    onPinnedMessageChanged: PinnedMessageChangedEventPayload;
    onChatThreadCreated: ChatThreadCreatedEventPayload;
    onChatThreadDestroyed: ChatThreadBaseEventPayload;
    onChatThreadUpdated: ChatThreadUpdatedEventPayload;
    onChatThreadUserRemoved: ChatThreadUserRemovedEventPayload;
    onMultiDeviceContact: MultiDeviceContactEvent;
    onMultiDeviceGroup: MultiDeviceGroupEvent;
    onMultiDeviceThread: MultiDeviceThreadEvent;
    onMultiDeviceConversation: MultiDeviceConversationEvent;
    onMultiDeviceMessageRemoved: MultiDeviceMessageRemovedEvent;
    onSyncDataStart: SyncDataStartPayload;
    onSyncDataFinished: SyncDataFinishedPayload;
    onPresenceStatusChange: readonly PresenceState[];
    onContactInvited: ContactRosterEventPayload;
    onContactDeleted: ContactRosterEventPayload;
    onContactAdded: ContactRosterEventPayload;
    onContactRefuse: ContactRosterEventPayload;
    onContactAgreed: ContactRosterEventPayload;
    onContactInfoUpdated: ContactInfoUpdatedEvent;
    onOwnInfoUpdated: UserInfo;
    onUserInfoUpdated: readonly UserInfo[];
    onInvitationReceived: GroupInvitationReceivedEventPayload;
    onRequestToJoinReceived: GroupRequestToJoinReceivedEventPayload;
    onRequestToJoinAccepted: GroupRequestToJoinAcceptedEventPayload;
    onRequestToJoinDeclined: GroupRequestToJoinDeclinedEventPayload;
    onInvitationAccepted: GroupInvitationAcceptedEventPayload;
    onInvitationDeclined: GroupInvitationDeclinedEventPayload;
    onUserRemoved: GroupUserRemovedEventPayload;
    onGroupDestroyed: GroupDestroyedEventPayload;
    onAutoAcceptInvitationFromGroup: GroupAutoAcceptInvitationEventPayload;
    onMuteListAdded: GroupMuteListAddedEventPayload;
    onMuteListRemoved: GroupMuteListRemovedEventPayload;
    onAllowListAdded: GroupAllowListAddedEventPayload;
    onAllowListRemoved: GroupAllowListRemovedEventPayload;
    onAllMemberMuteStateChanged: GroupAllMemberMuteStateChangedEventPayload;
    onAdminAdded: GroupAdminAddedEventPayload;
    onAdminRemoved: GroupAdminRemovedEventPayload;
    onOwnerChanged: GroupOwnerChangedEventPayload;
    onMembersJoined: GroupMembersJoinedEventPayload;
    onMembersExited: GroupMembersExitedEventPayload;
    onAnnouncementChanged: GroupAnnouncementChangedEventPayload;
    onSharedFileAdded: GroupSharedFileAddedEventPayload;
    onSharedFileDeleted: GroupSharedFileDeletedEventPayload;
    onGroupInfoChanged: GroupInfoChangedEventPayload;
    onGroupDisabledChanged: GroupDisabledChangedEventPayload;
    onGroupMemberAttributeChanged: GroupMemberAttributeChangedEventPayload;
    onUserGroupNamecardUpdated: GroupUserGroupNamecardUpdatedEventPayload;
    "__chatroom:onChatRoomDestroyed": ChatRoomDestroyedEventPayload;
    "__chatroom:onMembersJoined": ChatRoomMembersJoinedEventPayload;
    "__chatroom:onMembersExited": ChatRoomMembersExitedEventPayload;
    "__chatroom:onRemovedFromChatRoom": ChatRoomRemovedFromChatRoomEventPayload;
    "__chatroom:onMuteListAdded": ChatRoomMuteListAddedEventPayload;
    "__chatroom:onMuteListRemoved": ChatRoomMuteListRemovedEventPayload;
    "__chatroom:onAllowListAdded": ChatRoomAllowListAddedEventPayload;
    "__chatroom:onAllowListRemoved": ChatRoomAllowListRemovedEventPayload;
    "__chatroom:onAllMemberMuteStateChanged": ChatRoomAllMemberMuteStateChangedEventPayload;
    "__chatroom:onAdminAdded": ChatRoomAdminAddedEventPayload;
    "__chatroom:onAdminRemoved": ChatRoomAdminRemovedEventPayload;
    "__chatroom:onOwnerChanged": ChatRoomOwnerChangedEventPayload;
    "__chatroom:onAnnouncementChanged": ChatRoomAnnouncementChangedEventPayload;
    "__chatroom:onChatRoomInfoChanged": ChatRoomInfoChangedEventPayload;
    "__chatroom:onAttributesUpdate": ChatRoomAttributesUpdateEventPayload;
    "__chatroom:onAttributesRemoved": ChatRoomAttributesRemovedEventPayload;
}

Properties

onConnecting onConnected onDisconnected onReconnectFailed onTokenWillExpire onTokenExpired onOfflineMessageSyncStart onOfflineMessageSyncFinish onMessage onStreamMessage onConversationListUpdate onMessageReadReceipts onMessageDelivered onMessageRecalled onMessageUpdated onReactionChanged onPinnedMessageChanged onChatThreadCreated onChatThreadDestroyed onChatThreadUpdated onChatThreadUserRemoved onMultiDeviceContact onMultiDeviceGroup onMultiDeviceThread onMultiDeviceConversation onMultiDeviceMessageRemoved onSyncDataStart onSyncDataFinished onPresenceStatusChange onContactInvited onContactDeleted onContactAdded onContactRefuse onContactAgreed onContactInfoUpdated onOwnInfoUpdated onUserInfoUpdated onInvitationReceived onRequestToJoinReceived onRequestToJoinAccepted onRequestToJoinDeclined onInvitationAccepted onInvitationDeclined onUserRemoved onGroupDestroyed onAutoAcceptInvitationFromGroup onMuteListAdded onMuteListRemoved onAllowListAdded onAllowListRemoved onAllMemberMuteStateChanged onAdminAdded onAdminRemoved onOwnerChanged onMembersJoined onMembersExited onAnnouncementChanged onSharedFileAdded onSharedFileDeleted onGroupInfoChanged onGroupDisabledChanged onGroupMemberAttributeChanged onUserGroupNamecardUpdated __chatroom:onChatRoomDestroyed __chatroom:onMembersJoined __chatroom:onMembersExited __chatroom:onRemovedFromChatRoom __chatroom:onMuteListAdded __chatroom:onMuteListRemoved __chatroom:onAllowListAdded __chatroom:onAllowListRemoved __chatroom:onAllMemberMuteStateChanged __chatroom:onAdminAdded __chatroom:onAdminRemoved __chatroom:onOwnerChanged __chatroom:onAnnouncementChanged __chatroom:onChatRoomInfoChanged __chatroom:onAttributesUpdate __chatroom:onAttributesRemoved

Properties

正在连接到服务器(含自动重连)。

成功连接到服务器。

onDisconnected: ConnectionEventPayload

与服务器断开连接。断开原因包括:主动登出、Token 过期、被踢下线、设备超限等。

onReconnectFailed: ConnectionEventPayload

自动重连失败(达到最大重试次数)。

onTokenWillExpire: undefined

Token 即将过期(约 80% 生命周期时触发)。应在此时获取新 Token 并调用 renewToken。

onTokenExpired: undefined

Token 已过期,需要重新登录。

onOfflineMessageSyncStart: undefined

登录或重连后首次开始拉取离线消息;同一连接周期的后续心跳不会重复触发。

onOfflineMessageSyncFinish: undefined

登录或重连后的首次离线消息拉取完成;与 onOfflineMessageSyncStart 在每个连接周期内最多各触发一次。

onMessage: Message

收到新消息。 触发时机:有新消息到达(含单聊、群聊、聊天室)。 接收方:消息接收方(含发送方的其他设备)。

onStreamMessage: StreamMessage

流式消息更新。 触发时机:流式消息(如 AI 生成内容)有增量更新。 接收方:消息接收方。

onConversationListUpdate: ConversationListUpdatePayload

会话列表有更新。事件载荷始终包含当前完整且已排序的 ConversationItem 快照;需要保留业务本地字段时,可结合 patch.reset、patch.upserted、patch.removed 与 patch.orderChanged 做增量合并。

onMessageReadReceipts: readonly MessageReceiptEventPayload[]

消息已读回执列表。 触发时机:对方发送一条或多条消息已读回执。 接收方:消息的原始发送方。

onMessageDelivered: MessageDeliveredEventPayload

消息送达回执。 触发时机:接收方 SDK 自动回送达回执后,发送方收到此事件。 接收方:消息的原始发送方。

onMessageRecalled: MessageRecalledEventPayload

消息被撤回。 触发时机:发送方撤回消息,或群主/管理员撤回他人消息。 接收方:除当前操作设备外的会话成员,以及撤回者的其他设备。

onMessageUpdated: MessageUpdatedEventPayload

消息被编辑。 触发时机:发送方编辑已发送的消息。 接收方:除当前操作设备外的会话成员,以及编辑者的其他设备。

onReactionChanged: ReactionChangedEventPayload

消息 Reaction 变更。 触发时机:有成员对消息添加或移除 Reaction。 接收方:会话中的所有成员(仅单聊和群聊)。

onPinnedMessageChanged: PinnedMessageChangedEventPayload

消息置顶状态变更。 触发时机:有成员置顶或取消置顶消息。 接收方:除当前操作设备外的会话成员,以及当前用户的其他设备。

onChatThreadCreated: ChatThreadCreatedEventPayload

ChatThread 创建事件。接收方:子区所属群组的所有成员。

onChatThreadDestroyed: ChatThreadBaseEventPayload

ChatThread 解散事件。接收方:子区所属群组的所有成员。

onChatThreadUpdated: ChatThreadUpdatedEventPayload

ChatThread 更新事件。修改子区名称,或子区中添加、撤销回复消息时触发。接收方:子区所属群组的所有成员。

onChatThreadUserRemoved: ChatThreadUserRemovedEventPayload

当前登录用户被群主或群管理员移出 ChatThread。接收方:被移出的当前登录用户。

onMultiDeviceContact: MultiDeviceContactEvent

联系人相关多设备事件。 触发时机:当前用户在其他设备上执行联系人操作(添加/删除/黑名单等)。 接收方:当前用户的其他在线设备。

onMultiDeviceGroup: MultiDeviceGroupEvent

群组相关多设备事件。 触发时机:当前用户在其他设备上执行群组操作。 接收方:当前用户的其他在线设备。

onMultiDeviceThread: MultiDeviceThreadEvent

Thread 相关多设备事件。 触发时机:当前用户在其他设备上执行 Thread 操作。 接收方:当前用户的其他在线设备。

onMultiDeviceConversation: MultiDeviceConversationEvent

会话相关多设备事件。 触发时机:当前用户在其他设备上执行会话操作(删除/置顶/标记/免打扰等)。 接收方:当前用户的其他在线设备。

onMultiDeviceMessageRemoved: MultiDeviceMessageRemovedEvent

消息删除多设备事件。 触发时机:当前用户在其他设备上删除漫游消息。 接收方:当前用户的其他在线设备。

onSyncDataStart: SyncDataStartPayload

自动数据同步开始。

onSyncDataFinished: SyncDataFinishedPayload

自动数据同步完成。

onPresenceStatusChange: readonly PresenceState[]

订阅的用户在线状态变更。 触发时机:已订阅的用户在线状态发生变化。 接收方:订阅方。

onContactInvited: ContactRosterEventPayload

收到好友请求。 触发时机:其他用户向当前用户发送好友请求。 接收方:被邀请方。

onContactDeleted: ContactRosterEventPayload

被对方删除联系人。 触发时机:对方将当前用户从联系人列表中删除。 接收方:被删除方。

新增联系人。 触发时机:好友关系建立成功。 接收方:双方。

onContactRefuse: ContactRosterEventPayload

好友请求被拒绝。 触发时机:对方拒绝了当前用户的好友请求。 接收方:请求发起方。

onContactAgreed: ContactRosterEventPayload

好友请求被接受。 触发时机:对方接受了当前用户的好友请求。 接收方:请求发起方。

onContactInfoUpdated: ContactInfoUpdatedEvent

联系人信息变更。 触发时机:已订阅的联系人信息发生变化。 接收方:订阅方。

onOwnInfoUpdated: UserInfo

自己的用户属性被修改。 触发时机:当前用户的属性被修改(含其他设备修改)。 接收方:当前用户所有设备。

onUserInfoUpdated: readonly UserInfo[]

订阅的用户属性变更。 触发时机:已订阅的用户属性发生变化。 接收方:订阅方。

收到入群邀请。接收方:被邀请者。

收到入群申请。接收方:群主和管理员。

入群申请被同意。接收方:申请者。

入群申请被拒绝。接收方:申请者。

入群邀请被接受。接收方:邀请发起者。

入群邀请被拒绝。接收方:邀请发起者。

被移出群组。接收方:被移出者 + 群内所有成员。

onGroupDestroyed: GroupDestroyedEventPayload

群组被解散。接收方:群内所有成员。

onAutoAcceptInvitationFromGroup: GroupAutoAcceptInvitationEventPayload

自动接受入群邀请(群设置为不需要确认时)。接收方:被邀请者。

成员被禁言。接收方:群内所有成员。

成员被解除禁言。接收方:群内所有成员。

成员加入白名单。接收方:群内所有成员。

成员移出白名单。接收方:群内所有成员。

onAllMemberMuteStateChanged: GroupAllMemberMuteStateChangedEventPayload

全员禁言状态变更。接收方:群内所有成员。

新增管理员。接收方:群内所有成员。

移除管理员。接收方:群内所有成员。

群主变更。接收方:群内所有成员。

新成员加入群组。接收方:群内所有成员。

成员退出群组。接收方:群内所有成员。

群公告变更。接收方:群内所有成员。

新增群共享文件。接收方:群内所有成员。

删除群共享文件。接收方:群内所有成员。

onGroupInfoChanged: GroupInfoChangedEventPayload

群信息变更。接收方:群内所有成员。

onGroupDisabledChanged: GroupDisabledChangedEventPayload

群组禁用状态变更。接收方:群内所有成员。

onGroupMemberAttributeChanged: GroupMemberAttributeChangedEventPayload

群成员自定义属性变更。接收方:群内所有成员。

onUserGroupNamecardUpdated: GroupUserGroupNamecardUpdatedEventPayload

群名片变更。接收方:群内所有成员。

"__chatroom:onChatRoomDestroyed": ChatRoomDestroyedEventPayload

聊天室被销毁。接收方:聊天室内所有成员。

"__chatroom:onMembersJoined": ChatRoomMembersJoinedEventPayload

成员加入聊天室。接收方:聊天室内所有成员。

"__chatroom:onMembersExited": ChatRoomMembersExitedEventPayload

成员离开聊天室。接收方:聊天室内所有成员。

"__chatroom:onRemovedFromChatRoom": ChatRoomRemovedFromChatRoomEventPayload

被移出聊天室。接收方:被移出者 + 聊天室内所有成员。

"__chatroom:onMuteListAdded": ChatRoomMuteListAddedEventPayload

成员被禁言。接收方:聊天室内所有成员。

"__chatroom:onMuteListRemoved": ChatRoomMuteListRemovedEventPayload

成员被解除禁言。接收方:聊天室内所有成员。

"__chatroom:onAllowListAdded": ChatRoomAllowListAddedEventPayload

成员加入白名单。接收方:聊天室内所有成员。

"__chatroom:onAllowListRemoved": ChatRoomAllowListRemovedEventPayload

成员移出白名单。接收方:聊天室内所有成员。

"__chatroom:onAllMemberMuteStateChanged": ChatRoomAllMemberMuteStateChangedEventPayload

全员禁言状态变更。接收方:聊天室内所有成员。

"__chatroom:onAdminAdded": ChatRoomAdminAddedEventPayload

新增管理员。接收方:聊天室内所有成员。

"__chatroom:onAdminRemoved": ChatRoomAdminRemovedEventPayload

移除管理员。接收方:聊天室内所有成员。

"__chatroom:onOwnerChanged": ChatRoomOwnerChangedEventPayload

聊天室主变更。接收方:聊天室内所有成员。

"__chatroom:onAnnouncementChanged": ChatRoomAnnouncementChangedEventPayload

聊天室公告变更。接收方:聊天室内所有成员。

"__chatroom:onChatRoomInfoChanged": ChatRoomInfoChangedEventPayload

聊天室信息变更。接收方:聊天室内所有成员。

"__chatroom:onAttributesUpdate": ChatRoomAttributesUpdateEventPayload

聊天室自定义属性更新。接收方:聊天室内所有成员。

"__chatroom:onAttributesRemoved": ChatRoomAttributesRemovedEventPayload

聊天室自定义属性删除。接收方:聊天室内所有成员。