nonebot.adapters.onebot.v12.event

OneBot v12 事件模型。

class Event(<auto>)

  • 说明

    OneBot V12 协议事件,字段与 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 BotSelf(<auto>)

  • 说明: 机器人自身标识

  • 参数

    auto

class BotStatus(<auto>)

  • 说明: 机器人的状态

  • 参数

    auto

class Status(<auto>)

  • 说明: 运行状态

  • 参数

    auto

class Reply(<auto>)

  • 参数

    auto

class BotEvent(<auto>)

  • 说明: 包含 self 字段的机器人事件

  • 参数

    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_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 ChannelMessageEvent(<auto>)

  • 说明: 频道消息

  • 参数

    auto

method get_event_description()

  • 参数

    empty

  • 返回

    • str

method get_session_id()

  • 参数

    empty

  • 返回

    • str

class NoticeEvent(<auto>)

  • 说明: 通知事件

  • 参数

    auto

class FriendIncreaseEvent(<auto>)

  • 说明: 好友增加事件

  • 参数

    auto

class FriendDecreaseEvent(<auto>)

  • 说明: 好友减少事件

  • 参数

    auto

class PrivateMessageDeleteEvent(<auto>)

  • 说明: 私聊消息删除

  • 参数

    auto

class GroupMemberIncreaseEvent(<auto>)

  • 说明: 群成员增加事件

  • 参数

    auto

class GroupMemberDecreaseEvent(<auto>)

  • 说明: 群成员减少事件

  • 参数

    auto

class GroupMessageDeleteEvent(<auto>)

  • 说明: 群消息删除事件

  • 参数

    auto

class GuildMemberIncreaseEvent(<auto>)

  • 说明: 群组成员增加事件

  • 参数

    auto

class GuildMemberDecreaseEvent(<auto>)

  • 说明: 群组成员减少事件

  • 参数

    auto

class ChannelMemberIncreaseEvent(<auto>)

  • 说明: 频道成员增加事件

  • 参数

    auto

class ChannelMemberDecreaseEvent(<auto>)

  • 说明: 频道成员减少事件

  • 参数

    auto

class ChannelMessageDeleteEvent(<auto>)

  • 说明: 频道消息删除事件

  • 参数

    auto

class ChannelCreateEvent(<auto>)

  • 说明: 频道新建事件

  • 参数

    auto

class ChannelDeleteEvent(<auto>)

  • 说明: 频道删除事件

  • 参数

    auto

class RequestEvent(<auto>)

  • 说明: 请求事件

  • 参数

    auto

class MetaEvent(<auto>)

  • 说明: 元事件

  • 参数

    auto

method get_log_string()

  • 参数

    empty

  • 返回

    • str

class ImplVersion(<auto>)

  • 参数

    auto

class ConnectMetaEvent(<auto>)

  • 说明: 连接事件

  • 参数

    auto

class HeartbeatMetaEvent(<auto>)

  • 说明: 心跳事件

  • 参数

    auto

class StatusUpdateMetaEvent(<auto>)

  • 说明: 状态更新事件

  • 参数

    auto