三、核心类概念#

#Chat

{{< cards >}} {{< card link="/docs/class/chat" title="👉查看Chat类文档" tag="点击跳转" tagType="info" >}} {{< /cards >}}

Chat 类代表一个微信聊天窗口实例，提供了与聊天相关的操作方法，用于对微信聊天窗口进行各种操作，后续文档以变量名chat作为该类对象。

#WeChat

{{< cards >}} {{< card link="/docs/class/wechat" title="👉查看WeChat类文档" tag="点击跳转" tagType="info" >}} {{< /cards >}}

WeChat 类是本项目的主要入口点，它继承自 Chat 类，代表微信主窗口实例，用于对微信主窗口进行各种操作，后续文档以变量名wx作为该类对象。

#初始化参数

wx = WeChat(nickname="张三")

#Message

{{< cards >}} {{< card link="/docs/class/message" title="👉查看Message类文档" tag="点击跳转" tagType="info" >}} {{< /cards >}}

Message类代表微信聊天中的消息，分为两个概念：

• 消息内容类型（type）：文本消息、图片消息、文件消息、语音消息、卡片消息等等
• 消息来源类型（attr）：系统消息、时间消息、自己发送的消息、对方发来的消息

# 导入你想要的消息类型
from wxautox4.msgs import (
    TextMessage,
    FriendMessage,
    FriendTextMessage,
    ...
)

# 假设你获取到了一个消息对象
msg: Message = ...

# 如果是对方发来的消息，则回复收到
if isinstance(msg, FriendMessage):
    msg.reply("收到")

#WxResponse

该类用于该项目多个方法的返回值

# 这里假设result为某个方法的WxResponse类型返回值
result: WxResponse = ...

# 判断是否成功
if result:
    data = result['data'] # 成功，获取返回数据，大多数情况下为None
else:
    print(result['message'])  # 该方法调用失败，打印错误信息

#WxParam

• ENABLE_FILE_LOGGER ( bool ) ：是否启用日志文件，默认True
• DEFAULT_SAVE_PATH ( str ) ：下载文件/图片默认保存路径，默认为当前工作目录下的wxautox文件下载文件夹
• ✨MESSAGE_HASH ( bool ) ：是否启用消息哈希值用于辅助判断消息，开启后会稍微影响性能，默认False
• DEFAULT_MESSAGE_XBIAS ( int ) ：头像到消息X偏移量，用于消息定位，点击消息等操作，默认51
• FORCE_MESSAGE_XBIAS ( bool ) ：是否强制重新自动获取X偏移量，如果设置为True，则每次启动都会重新获取，默认False
• LISTEN_INTERVAL ( int ) ：监听消息时间间隔，单位秒，默认1
• SEARCH_CHAT_TIMEOUT ( int ) ：搜索聊天对象超时时间，单位秒，默认5

from wxautox import WxParam

...