Skip to content
On this page

iamai.adapter.cqhttp.message

CQHTTP 适配器消息。

class CQHTTPMessage(self, message = None)

Bases: iamai.message.Message

CQHTTP 消息。

  • Arguments

    • message (Union[Self, ~T_MessageSegment, str, Mapping[str, Any], Iterable[Union[~T_MessageSegment, str, Mapping[str, Any]]], NoneType]) - 可以被转化为消息的数据。

    • *args - 其他参数。

class CQHTTPMessageSegment(self, type, data = <factory>)

Bases: iamai.message.MessageSegment

CQHTTP 消息字段。

  • Arguments

    • type (str)

    • data (Dict[str, Any])

class method anonymous(cls, ignore = None)

匿名发消息

  • Arguments

    • ignore (Optional[bool])
  • Returns

    Type: CQHTTPMessageSegment

class method at(cls, qq)

@某人

  • Arguments

    • qq (Union[int, Literal['all']])
  • Returns

    Type: CQHTTPMessageSegment

class method contact(cls, type_, id_)

推荐好友/推荐群

  • Arguments

    • type_ (Literal['qq', 'group'])

    • id_ (int)

  • Returns

    Type: CQHTTPMessageSegment

class method contact_friend(cls, id_)

推荐好友

  • Arguments

    • id_ (int)
  • Returns

    Type: CQHTTPMessageSegment

class method contact_group(cls, id_)

推荐好友

  • Arguments

    • id_ (int)
  • Returns

    Type: CQHTTPMessageSegment

class method dice(cls)

掷骰子魔法表情

  • Returns

    Type: CQHTTPMessageSegment

class method face(cls, id_)

QQ 表情

  • Arguments

    • id_ (int)
  • Returns

    Type: CQHTTPMessageSegment

method get_cqcode(self)

获取此消息字段的 CQ 码形式。

  • Returns

    Type: str

    此消息字段的 CQ 码形式。

class method image(cls, file, type_ = None, cache = True, proxy = True, timeout = None)

图片

  • Arguments

    • file (str)

    • type_ (Optional[Literal['flash']])

    • cache (bool)

    • proxy (bool)

    • timeout (Optional[int])

  • Returns

    Type: CQHTTPMessageSegment

class method json_message(cls, data)

JSON 消息

  • Arguments

    • data (str)
  • Returns

    Type: CQHTTPMessageSegment

class method location(cls, lat, lon, title, content = None)

位置

  • Arguments

    • lat (float)

    • lon (float)

    • title (Optional[str])

    • content (Optional[str])

  • Returns

    Type: CQHTTPMessageSegment

class method music(cls, type_, id_)

音乐分享

  • Arguments

    • type_ (Literal['qq', '163', 'xm'])

    • id_ (int)

  • Returns

    Type: CQHTTPMessageSegment

class method music_custom(cls, url, audio, title, content = None, image = None)

音乐自定义分享

  • Arguments

    • url (str)

    • audio (str)

    • title (str)

    • content (Optional[str])

    • image (Optional[str])

  • Returns

    Type: CQHTTPMessageSegment

class method node(cls, id_)

合并转发节点

  • Arguments

    • id_ (int)
  • Returns

    Type: CQHTTPMessageSegment

class method node_custom(cls, user_id, nickname, content)

合并转发自定义节点

  • Arguments

    • user_id (int)

    • nickname (str)

    • content (CQHTTPMessage)

  • Returns

    Type: CQHTTPMessageSegment

class method poke(cls, type_, id_)

戳一戳

  • Arguments

    • type_ (str)

    • id_ (int)

  • Returns

    Type: CQHTTPMessageSegment

class method record(cls, file, magic = False, cache = True, proxy = True, timeout = None)

语音

  • Arguments

    • file (str)

    • magic (bool)

    • cache (bool)

    • proxy (bool)

    • timeout (Optional[int])

  • Returns

    Type: CQHTTPMessageSegment

class method reply(cls, id_)

回复

  • Arguments

    • id_ (int)
  • Returns

    Type: CQHTTPMessageSegment

class method rps(cls)

猜拳魔法表情

  • Returns

    Type: CQHTTPMessageSegment

class method shake(cls)

窗口抖动(戳一戳)

  • Returns

    Type: CQHTTPMessageSegment

class method share(cls, url, title, content = None, image = None)

链接分享

  • Arguments

    • url (str)

    • title (str)

    • content (Optional[str])

    • image (Optional[str])

  • Returns

    Type: CQHTTPMessageSegment

class method text(cls, text)

纯文本

  • Arguments

    • text (str)
  • Returns

    Type: CQHTTPMessageSegment

class method video(cls, file, cache = True, proxy = True, timeout = None)

短视频

  • Arguments

    • file (str)

    • cache (bool)

    • proxy (bool)

    • timeout (Optional[int])

  • Returns

    Type: CQHTTPMessageSegment

class method xml_message(cls, data)

XML 消息

  • Arguments

    • data (str)
  • Returns

    Type: CQHTTPMessageSegment

function escape(s, *, escape_comma = True)

对 CQ 码中的特殊字符进行转义。

  • Arguments

    • s (str) - 待转义的字符串。

    • escape_comma (bool) - 是否转义 ,

  • Returns

    Type: str

    转义后的字符串。

Released under the MIT License.