Skip to content

alicebot.adapter.mirai.event.message

消息事件。

abstract class MiraiBaseMessageEvent

Bases: alicebot.adapter.mirai.event.base.MiraiEvent, alicebot.event.MessageEvent[MiraiAdapter]

Mirai 消息事件基类

  • Attributes

    • messageChain (alicebot.adapter.mirai.message.MiraiMessage)

method get_plain_text(self)

获取消息的纯文本内容。

  • Returns

    Type: str

    消息的纯文本内容。

readonly property message

Type: alicebot.adapter.mirai.message.MiraiMessage

与 messageChain 相同。

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class MessageEvent

Bases: alicebot.adapter.mirai.event.message.MiraiBaseMessageEvent

消息事件

  • Attributes

    • sender (Union[alicebot.adapter.mirai.event.base.FriendInfo, alicebot.adapter.mirai.event.base.GroupMemberInfo, alicebot.adapter.mirai.event.base.OtherClientSender])

method get_sender_id(self)

获取消息的发送者的唯一标识符。

  • Returns

    Type: int

    消息的发送者的唯一标识符。

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class FriendMessage

Bases: alicebot.adapter.mirai.event.message.MessageEvent

好友消息

  • Attributes

    • type (Literal['FriendMessage'])

    • sender (alicebot.adapter.mirai.event.base.FriendInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class GroupMessage

Bases: alicebot.adapter.mirai.event.message.MessageEvent

群消息

  • Attributes

    • type (Literal['GroupMessage'])

    • sender (alicebot.adapter.mirai.event.base.GroupMemberInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class TempMessage

Bases: alicebot.adapter.mirai.event.message.MessageEvent

群临时消息

  • Attributes

    • type (Literal['TempMessage'])

    • sender (alicebot.adapter.mirai.event.base.GroupMemberInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class StrangerMessage

Bases: alicebot.adapter.mirai.event.message.MessageEvent

陌生人消息

  • Attributes

    • type (Literal['StrangerMessage'])

    • sender (alicebot.adapter.mirai.event.base.FriendInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class OtherClientMessage

Bases: alicebot.adapter.mirai.event.message.MessageEvent

其他客户端消息

  • Attributes

    • type (Literal['OtherClientMessage'])

    • sender (alicebot.adapter.mirai.event.base.OtherClientSender)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class SyncMessage

Bases: alicebot.adapter.mirai.event.message.MiraiBaseMessageEvent

同步消息

  • Attributes

    • subject (Union[alicebot.adapter.mirai.event.base.FriendInfo, alicebot.adapter.mirai.event.base.GroupMemberInfo])

method get_sender_id(self)

获取消息的发送者的唯一标识符。

  • Returns

    Type: None

    消息的发送者的唯一标识符。

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class FriendSyncMessage

Bases: alicebot.adapter.mirai.event.message.SyncMessage

同步好友消息

  • Attributes

    • type (Literal['FriendSyncMessage'])

    • subject (alicebot.adapter.mirai.event.base.FriendInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class GroupSyncMessage

Bases: alicebot.adapter.mirai.event.message.SyncMessage

同步群消息

  • Attributes

    • type (Literal['GroupSyncMessage'])

    • subject (alicebot.adapter.mirai.event.base.GroupMemberInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class TempSyncMessage

Bases: alicebot.adapter.mirai.event.message.SyncMessage

同步群临时消息

  • Attributes

    • type (Literal['TempSyncMessage'])

    • subject (alicebot.adapter.mirai.event.base.GroupMemberInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

class StrangerSyncMessage

Bases: alicebot.adapter.mirai.event.message.SyncMessage

同步陌生人消息

  • Attributes

    • type (Literal['StrangerSyncMessage'])

    • subject (alicebot.adapter.mirai.event.base.FriendInfo)

async method reply(self, message, quote = False)

回复消息。

  • Arguments

    • message (Union[List[alicebot.adapter.mirai.message.MiraiMessageSegment], alicebot.adapter.mirai.message.MiraiMessageSegment, str, Mapping[str, Any]]) - 回复消息的内容,同 call_api() 方法。

    • quote (bool) - 引用消息,默认为 False

  • Returns

    Type: Dict[str, Any]

    API 请求响应。

Released under the MIT License.