nonebot.adapters.onebot.v11.message

OneBot v11 消息类型。

class MessageSegment(<auto>)

• 说明: OneBot v11 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。

• 参数

  auto

classmethod get_message_class()

• 参数

  empty

• 返回

  • type[Message]

method to_rich_text(truncate=70)

• 参数

  • truncate (int | None)

• 返回

  • str

method is_text()

• 参数

  empty

• 返回

  • bool

classmethod anonymous(ignore_failure=None)

• 参数

  • ignore_failure (bool | None)

• 返回

  • Self

classmethod at(user_id)

• 参数

  • user_id (int | str)

• 返回

  • Self

classmethod contact(type_, id)

• 参数

  • type_ (str)

  • id (int)

• 返回

  • Self

classmethod contact_group(group_id)

• 参数

  • group_id (int)

• 返回

  • Self

classmethod contact_user(user_id)

• 参数

  • user_id (int)

• 返回

  • Self

classmethod dice()

• 参数

  empty

• 返回

  • Self

classmethod face(id_)

• 参数

  • id_ (int)

• 返回

  • Self

classmethod forward(id_)

• 参数

  • id_ (str)

• 返回

  • Self

classmethod image(file, type_=None, cache=True, proxy=True, timeout=None)

• 参数

  • file (str | bytes | BytesIO | Path)

  • type_ (str | None)

  • cache (bool)

  • proxy (bool)

  • timeout (int | None)

• 返回

  • Self

classmethod json(data)

• 参数

  • data (str)

• 返回

  • Self

classmethod location(latitude, longitude, title=None, content=None)

• 参数

  • latitude (float)

  • longitude (float)

  • title (str | None)

  • content (str | None)

• 返回

  • Self

classmethod music(type_, id_)

• 参数

  • type_ (str)

  • id_ (int)

• 返回

  • Self

classmethod music_custom(url, audio, title, content=None, img_url=None)

• 参数

  • url (str)

  • audio (str)

  • title (str)

  • content (str | None)

  • img_url (str | None)

• 返回

  • Self

classmethod node(id_)

• 参数

  • id_ (int)

• 返回

  • Self

classmethod node_custom(user_id, nickname, content)

• 参数

  • user_id (int)

  • nickname (str)

  • content (str | Message)

• 返回

  • Self

classmethod poke(type_, id_)

• 参数

  • type_ (str)

  • id_ (str)

• 返回

  • Self

classmethod record(file, magic=None, cache=None, proxy=None, timeout=None)

• 参数

  • file (str | bytes | BytesIO | Path)

  • magic (bool | None)

  • cache (bool | None)

  • proxy (bool | None)

  • timeout (int | None)

• 返回

  • Self

classmethod reply(id_)

• 参数

  • id_ (int)

• 返回

  • Self

classmethod rps()

• 参数

  empty

• 返回

  • Self

classmethod shake()

• 参数

  empty

• 返回

  • Self

classmethod share(url="", title="", content=None, image=None)

• 参数

  • url (str)

  • title (str)

  • content (str | None)

  • image (str | None)

• 返回

  • Self

classmethod text(text)

• 参数

  • text (str)

• 返回

  • Self

classmethod video(file, cache=None, proxy=None, timeout=None)

• 参数

  • file (str | bytes | BytesIO | Path)

  • cache (bool | None)

  • proxy (bool | None)

  • timeout (int | None)

• 返回

  • Self

classmethod xml(data)

• 参数

  • data (str)

• 返回

  • Self

class Message(<auto>)

• 说明: OneBot v11 协议 Message 适配。

• 参数

  auto

classmethod get_segment_class()

• 参数

  empty

• 返回

  • type[MessageSegment]

method to_rich_text(truncate=70)

• 参数

  • truncate (int | None)

• 返回

  • str

method extract_plain_text()

• 参数

  empty

• 返回

  • str

method reduce()

• 说明: 合并消息内连续的纯文本段。

• 参数

  empty

• 返回

  • None