BotEvent
事件监听入口,通过 bot.event 访问,按类别分组。
架构
bot.event
├── message: MessageEvent ← 收到的消息
├── messageSent: MessageSent ← 发出的消息回执
├── request: RequestEvent ← 加好友/加群请求
└── notice: NoticeEvent ← 通知事件MessageEvent
bot.event.message.xxx()onGroupMessage(fn)
onGroupMessage(fn: (bot: BotClient, event: GroupMessage) => any): void监听所有群消息。
onGroupNormal(fn)
onGroupNormal(fn: (bot: BotClient, event: GroupMessage) => any): void仅监听普通群消息(细粒度)。
onPrivateMessage(fn)
onPrivateMessage(fn: (bot: BotClient, event: PrivateMessage) => any): void监听所有私聊消息(好友 + 群临时)。
onPrivateFriend(fn)
onPrivateFriend(fn: (bot: BotClient, event: PrivateMessage) => any): void仅监听好友私聊(细粒度)。
onPrivateGroup(fn)
onPrivateGroup(fn: (bot: BotClient, event: PrivateMessage) => any): void仅监听群临时私聊(细粒度)。
MessageSent
bot.event.messageSent.xxx()bot 发出消息的回执事件,可用于确认消息发送成功。
onGroupSent(fn)
onGroupSent(fn: (bot: BotClient, event: GroupMessageSelf) => any): void群消息发送回执。
onGroupNormal(fn)
onGroupNormal(fn: (bot: BotClient, event: GroupMessageSelf) => any): void群消息发送回执(细粒度,仅普通消息)。
onPrivateSent(fn)
onPrivateSent(fn: (bot: BotClient, event: PrivateMessageSelf) => any): void私聊消息发送回执。
onPrivateFriend(fn)
onPrivateFriend(fn: (bot: BotClient, event: PrivateFriendMessageSelf) => any): void好友私聊发送回执(细粒度)。
onPrivateGroup(fn)
onPrivateGroup(fn: (bot: BotClient, event: PrivateGroupMessageSelf) => any): void群临时私聊发送回执(细粒度)。
RequestEvent
bot.event.request.xxx()onFriend(fn)
onFriend(fn: (bot: BotClient, event: RequestFriend) => any): void加好友请求。event.flag 可传给 bot.api.handleFriendAddRequest()。
onGroupAdd(fn)
onGroupAdd(fn: (bot: BotClient, event: RequestGroupAdd) => any): void加群请求。event.flag 可传给 bot.api.handleGroupAddRequest()。
onGroupInvite(fn)
onGroupInvite(fn: (bot: BotClient, event: RequestGroupInvite) => any): void邀请入群。
onGroupRequest(fn)
onGroupRequest(fn: (bot: BotClient, event: RequestGroup) => any): void所有群请求(加群 + 邀请),event.sub_type 区分 'add' / 'invite'。
NoticeEvent
bot.event.notice.xxx()onFriendAdd(fn)
onFriendAdd(fn: (bot: BotClient, event: FriendAdd) => any): void好友添加成功。
onFriendRecall(fn)
onFriendRecall(fn: (bot: BotClient, event: FriendRecall) => any): void私聊消息被撤回。
onGroupAdmin(fn)
onGroupAdmin(fn: (bot: BotClient, event: GroupAdminSet | GroupAdminUnset) => any): void群管理员变动,event.sub_type 区分 'set' / 'unset'。
onGroupBan(fn)
onGroupBan(fn: (bot: BotClient, event: GroupBanBan | GroupBanLiftBan) => any): void群禁言变动,event.sub_type 区分 'ban' / 'lift_ban'。
onGroupCard(fn)
onGroupCard(fn: (bot: BotClient, event: GroupCard) => any): void群名片变更。事件包含 card_old 和 card_new。
onGroupDecrease(fn)
onGroupDecrease(fn: (bot: BotClient, event: GroupDecreaseLeave | GroupDecreaseKick | GroupDecreaseKickMe) => any): void群成员减少。event.sub_type 区分 'leave' / 'kick' / 'kick_me'。
onGroupIncrease(fn)
onGroupIncrease(fn: (bot: BotClient, event: GroupIncreaseApprove | GroupIncreaseInvite) => any): void群成员增加。event.sub_type 区分 'approve' / 'invite'。
onGroupRecall(fn)
onGroupRecall(fn: (bot: BotClient, event: GroupRecall) => any): void群消息被撤回。event.operator_id 是操作者,event.user_id 是发送者。
onGroupUpload(fn)
onGroupUpload(fn: (bot: BotClient, event: GroupUpload) => any): void群文件上传。event.file 包含 { id, name, size }。
onGroupEmojiLike(fn)
onGroupEmojiLike(fn: (bot: BotClient, event: GroupMsgEmojiLike) => any): void群表情回应。
onGroupEssence(fn)
onGroupEssence(fn: (bot: BotClient, event: GroupEssenceAdd | GroupEssenceDelete) => any): void群设精/取消。event.sub_type 区分 'add' / 'delete'。
onPoke(fn)
onPoke(fn: (bot: BotClient, event: NotifyPokeFriend | NotifyPokeGroup) => any): void戳一戳(好友/群)。
onGroupNameChange(fn)
onGroupNameChange(fn: (bot: BotClient, event: NotifyGroupName) => any): void群名称变更。event.name_new 为新名称。
onTitleChange(fn)
onTitleChange(fn: (bot: BotClient, event: NotifyTitle) => any): void群头衔变更。event.title 为新头衔。
onProfileLike(fn)
onProfileLike(fn: (bot: BotClient, event: NotifyProfileLike) => any): void个人资料被点赞。
onBotOffline(fn)
onBotOffline(fn: (bot: BotClient, event: BotOffline) => any): voidbot 离线。