Module graia.application.event.messages

Classes

class Forward (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class Forward(MiraiEvent):
    type: str = "Forward"

    "表示该条转发消息的标题, 通常为 `群聊的聊天记录`"
    title: str

    "显示在消息列表中的预览文本, 调用 asDisplay 方法返回该值"
    brief: str

    "似乎没有什么用, 这个东西找不到在哪里显示"
    source: str

    "描述, 通常都像: `查看 x 条转发消息` 这样"
    summary: str

    content: List[ForwardContentMessage] = Field(..., alias="nodeList")

    def asDisplay(self):
        return self.brief

    class Dispatcher(BaseDispatcher):
        mixin = [MessageChainCatcher, ApplicationDispatcher]

        @staticmethod
        async def catch(interface: DispatcherInterface):
            pass

Ancestors

• MiraiEvent
• BaseEvent
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Dispatcher

所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.

var brief : str

似乎没有什么用, 这个东西找不到在哪里显示

var content : List[ForwardContentMessage]

var source : str

描述, 通常都像: 查看 x 条转发消息 这样

var summary : str

var title : str

显示在消息列表中的预览文本, 调用 asDisplay 方法返回该值

var type : str

表示该条转发消息的标题, 通常为 群聊的聊天记录

Methods

def asDisplay(self)

Expand source code

def asDisplay(self):
    return self.brief

class ForwardContentMessage (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class ForwardContentMessage(BaseModel):
    senderId: int
    senderName: str

    messageChain: MessageChain

    time: datetime

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var messageChain : MessageChain

var senderId : int

var senderName : str

var time : datetime.datetime

class FriendMessage (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class FriendMessage(MiraiEvent):
    type: str = "FriendMessage"
    messageChain: MessageChain
    sender: Friend

    class Dispatcher(BaseDispatcher):
        mixin = [MessageChainCatcher, ApplicationDispatcher, SourceElementDispatcher]

        @staticmethod
        async def catch(interface: DispatcherInterface):
            if interface.annotation is Friend:
                return interface.event.sender

Ancestors

• MiraiEvent
• BaseEvent
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Dispatcher

所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.

var messageChain : MessageChain

var sender : Friend

var type : str

class GroupMessage (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class GroupMessage(MiraiEvent):
    type: str = "GroupMessage"
    messageChain: MessageChain
    sender: Member

    class Dispatcher(BaseDispatcher):
        mixin = [MessageChainCatcher, ApplicationDispatcher, SourceElementDispatcher]

        @staticmethod
        async def catch(interface: DispatcherInterface):
            if interface.annotation is Group:
                return interface.event.sender.group
            elif interface.annotation is Member:
                return interface.event.sender

Ancestors

• MiraiEvent
• BaseEvent
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Dispatcher

所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.

var messageChain : MessageChain

var sender : Member

var type : str

class SourceElementDispatcher

所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.

Expand source code

class SourceElementDispatcher(BaseDispatcher):
    @staticmethod
    async def catch(interface: DispatcherInterface):
        if interface.annotation is Source:
            return interface.event.messageChain.getFirst(Source)

Ancestors

• BaseDispatcher

Inherited members

• BaseDispatcher:
  • afterDispatch
  • afterExecution
  • afterTargetExec
  • beforeDispatch
  • beforeExecution
  • beforeTargetExec
  • catch
  • mixin
  • onActive

class TempMessage (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class TempMessage(MiraiEvent):
    type: str = "TempMessage"
    messageChain: MessageChain
    sender: Member

    @classmethod
    def parse_obj(cls, obj):
        return super().parse_obj(obj)

    class Dispatcher(BaseDispatcher):
        mixin = [MessageChainCatcher, ApplicationDispatcher, SourceElementDispatcher]

        @staticmethod
        async def catch(interface: DispatcherInterface):
            if interface.annotation is Group:
                return interface.event.sender.group
            elif interface.annotation is Member:
                return interface.event.sender

Ancestors

• MiraiEvent
• BaseEvent
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Dispatcher

所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.

var messageChain : MessageChain

var sender : Member

var type : str

Static methods

def parse_obj(obj)

Expand source code

@classmethod
def parse_obj(cls, obj):
    return super().parse_obj(obj)