nonebot.adapters.onebot.v11.event

OneBot v11 事件模型。

class Event(<auto>)

  • 说明

    OneBot v11 协议事件,字段与 OneBot 一致。各事件字段参考 OneBot 文档

  • 参数

    auto

method get_type()

  • 参数

    empty

  • 返回

    • str

method get_event_name()

  • 参数

    empty

  • 返回

    • str

method get_event_description()

  • 参数

    empty

  • 返回

    • str

method get_message()

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

method is_tome()

  • 参数

    empty

  • 返回

    • bool

class Sender(<auto>)

  • 参数

    auto

class Reply(<auto>)

  • 参数

    auto

class Anonymous(<auto>)

  • 参数

    auto

class File(<auto>)

  • 参数

    auto

class Status(<auto>)

  • 参数

    auto

class MessageEvent(<auto>)

  • 说明: 消息事件

  • 参数

    auto

class-var to_me

  • 类型: bool

  • 说明

    :说明: 消息是否与机器人有关

    :类型: bool

class-var reply

  • 类型: Reply | None

  • 说明

    :说明: 消息中提取的回复消息,内容为 get_msg API 返回结果

    :类型: Optional[Reply]

classmethod check_message(values)

  • 参数

    • values (dict[str, Any])
  • 返回

    • dict[str, Any]

method get_event_name()

  • 参数

    empty

  • 返回

    • str

method get_message()

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

method is_tome()

  • 参数

    empty

  • 返回

    • bool

class PrivateMessageEvent(<auto>)

  • 说明: 私聊消息

  • 参数

    auto

method get_event_description()

  • 参数

    empty

  • 返回

    • str

class GroupMessageEvent(<auto>)

  • 说明: 群消息

  • 参数

    auto

method get_event_description()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class NoticeEvent(<auto>)

  • 说明: 通知事件

  • 参数

    auto

method get_event_name()

  • 参数

    empty

  • 返回

    • str

class GroupUploadNoticeEvent(<auto>)

  • 说明: 群文件上传事件

  • 参数

    auto

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class GroupAdminNoticeEvent(<auto>)

  • 说明: 群管理员变动

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class GroupDecreaseNoticeEvent(<auto>)

  • 说明: 群成员减少事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class GroupIncreaseNoticeEvent(<auto>)

  • 说明: 群成员增加事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class GroupBanNoticeEvent(<auto>)

  • 说明: 群禁言事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class FriendAddNoticeEvent(<auto>)

  • 说明: 好友添加事件

  • 参数

    auto

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class GroupRecallNoticeEvent(<auto>)

  • 说明: 群消息撤回事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class FriendRecallNoticeEvent(<auto>)

  • 说明: 好友消息撤回事件

  • 参数

    auto

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class NotifyEvent(<auto>)

  • 说明: 提醒事件

  • 参数

    auto

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class PokeNotifyEvent(<auto>)

  • 说明: 戳一戳提醒事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class LuckyKingNotifyEvent(<auto>)

  • 说明: 群红包运气王提醒事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class HonorNotifyEvent(<auto>)

  • 说明: 群荣誉变更提醒事件

  • 参数

    auto

method is_tome()

  • 参数

    empty

  • 返回

    • bool

class RequestEvent(<auto>)

  • 说明: 请求事件

  • 参数

    auto

method get_event_name()

  • 参数

    empty

  • 返回

    • str

class FriendRequestEvent(<auto>)

  • 说明: 加好友请求事件

  • 参数

    auto

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

async method approve(bot, remark="")

  • 参数

    • bot (Bot)

    • remark (str)

  • 返回

    • untyped

async method reject(bot)

  • 参数

  • 返回

    • untyped

class GroupRequestEvent(<auto>)

  • 说明: 加群请求/邀请事件

  • 参数

    auto

method get_user_id()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

async method approve(bot)

  • 参数

  • 返回

    • untyped

async method reject(bot, reason="")

  • 参数

    • bot (Bot)

    • reason (str)

  • 返回

    • untyped

class MetaEvent(<auto>)

  • 说明: 元事件

  • 参数

    auto

method get_event_name()

  • 参数

    empty

  • 返回

    • str

method get_log_string()

  • 参数

    empty

  • 返回

    • str

class LifecycleMetaEvent(<auto>)

  • 说明: 生命周期元事件

  • 参数

    auto

class HeartbeatMetaEvent(<auto>)

  • 说明: 心跳元事件

  • 参数

    auto