## File: README.md

# wxauto (2021-2025)


|  环境  | 版本 |
| :----: | :--: |
|   OS   | [](https://www.microsoft.com/)  |
|  微信  | [](https://pan.baidu.com/s/1FvSw0Fk54GGvmQq8xSrNjA?pwd=vsmj) |
| Python | [](https://www.python.org/)|

获取：https://wxauto.org

文档：https://docs.wxauto.org

## 联系

Email: support@wxauto.org

## 免责声明
代码仅用于对UIAutomation技术的交流学习使用，禁止用于实际生产项目，请勿用于非法用途和商业用途！如因此产生任何法律纠纷，均与作者无关！

---

## File: docs/class/Chat.md

---
weight: 1
bookFlatSection: true
title: "Chat类"
---
## Chat 类属性

在了解`Chat`类的方法之前，我想先介绍一下为什么要做这个类。
`wxauto(x)`这个项目的原理是模拟人工对微信客户端的操作，拿取到的所有信息都是人眼可见的部分，
所以当我们想监听某个人或群消息的时候，需要把这个人的聊天窗口独立出来，以确保UI元素不会因为微信主窗口切换聊天而丢失，
同时也不需要每来一条信息都切换聊天窗口去获取。
所以，`Chat`类就是用来创建一个独立的聊天窗口，并获取这个聊天窗口的信息。

| 属性     | 类型   | 描述             |
| -------- | ------ | ---------------- |
| who  | str    | 当前子窗口的聊天对象名  |
| chat_type  | str    | 聊天窗口类型  |

### 聊天窗口类型 chat_type

获取当前聊天窗口的类型，返回值为字符串，取值范围如下：

- friend：好友
- group：群聊
- service：客服
- official：公众号

```python
chat_type = chat.chat_type
```


## Chat 类方法

### 显示窗口 Show

```python
chat.Show()
```

### 获取聊天窗口信息 ChatInfo

```python
info = chat.ChatInfo()
```

**返回值**：

- 类型：`dict`
- 描述：聊天窗口信息
- 返回值示例：
```python
# 好友
{'chat_type': 'friend', 'chat_name': '张三'}  

# 群聊
{'group_member_count': 500, 'chat_type': 'group', 'chat_name': '工作群'}  

# 客服
{'company': '@肯德基', 'chat_type': 'service', 'chat_name': '店长xxx'} 

# 公众号
{'chat_type': 'official', 'chat_name': '肯德基'} 
```

### @所有人 AtAll

```python
group = '工作群'
content = """
通知：
下午xxxx
xxxx
"""

wx.AtAll(content, group)
```

msg (str): 发送的消息

​      who (str, optional): 发送给谁. Defaults to None.

​      exact (bool, optional): 是否精确匹配. Defaults to False.

**参数**：

| 参数  | 类型   | 默认值 | 描述                                                         |
| ----- | ------ | ------ | ------------------------------------------------------------ |
| msg   | str    | None   | 发送的消息                                                   |
| who   | str    | None   | 发送给谁                                                     |
| exact | bool   | False  | 是否精确匹配                                                 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否发送成功


### 发送消息 SendMsg

```python
wx.SendMsg(msg="你好", who="张三", clear=True, at="李四", exact=False)
```

**参数**：

| 参数  | 类型                  | 默认值 | 描述                                                         |
| ----- | --------------------- | ------ | ------------------------------------------------------------ |
| msg   | str                   | 必填   | 消息内容                                                     |
| who   | str                   | None   | 发送对象，不指定则发送给当前聊天对象，**当子窗口时，该参数无效** |
| clear | bool                  | True   | 发送后是否清空编辑框                                         |
| at    | Union[str, List[str]] | None   | @对象，不指定则不@任何人                                     |
| exact | bool                  | False  | 搜索who好友时是否精确匹配，**当子窗口时，该参数无效**        |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否发送成功

### 发送文本消息（打字机模式）SendTypingText

```python
wx.SendTypingText(msg="你好", who="张三", clear=True, exact=False)
```

**参数**：

| 参数  | 类型 | 默认值 | 描述                                                         |
| ----- | ---- | ------ | ------------------------------------------------------------ |
| msg   | str  | 必填   | 要发送的文本消息                                             |
| who   | str  | None   | 发送对象，不指定则发送给当前聊天对象，**当子窗口时，该参数无效** |
| clear | bool | True   | 是否清除原本的内容                                           |
| exact | bool | False  | 搜索who好友时是否精确匹配，**当子窗口时，该参数无效**        |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否发送成功

**示例**：

```python
# 换行及@功能
wx.SendTypingText('各位下午好\n{@张三}负责xxx\n{@李四}负责xxxx', who='工作群')
```

### 发送文件 SendFiles

```python
wx.SendFiles(filepath="C:/文件.txt", who="张三", exact=False)
```

**参数**：

| 参数     | 类型      | 默认值 | 描述                                                         |
| -------- | --------- | ------ | ------------------------------------------------------------ |
| filepath | str\|list | 必填   | 要复制文件的绝对路径                                         |
| who      | str       | None   | 发送对象，不指定则发送给当前聊天对象，**当子窗口时，该参数无效** |
| exact    | bool      | False  | 搜索who好友时是否精确匹配，**当子窗口时，该参数无效**        |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否发送成功

### 发送自定义表情 SendEmotion

```python
wx.SendEmotion(emotion_index=0, who="张三", exact=False)
```

**参数**：

| 参数          | 类型 | 默认值 | 描述                                                         |
| ------------- | ---- | ------ | ------------------------------------------------------------ |
| emotion_index | str  | 必填   | 表情索引，从0开始                                            |
| who           | str  | None   | 发送对象，不指定则发送给当前聊天对象，**当子窗口时，该参数无效** |
| exact         | bool | False  | 搜索who好友时是否精确匹配，**当子窗口时，该参数无效**        |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否发送成功

### 获取当前聊天窗口的所有消息 GetAllMessage

```python
messages = wx.GetAllMessage()
```

**返回值**：

- 类型：List[[Message](#message-类方法)]
- 描述：当前聊天窗口的所有消息

### 加载当前窗口更多聊天记录 LoadMoreMessage

```python
wx.LoadMoreMessage()
```

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否发送成功

### 添加群成员 AddGroupMembers

```python
wx.AddGroupMembers(group="技术交流群", members=["张三", "李四"], reason="交流技术")
```

**参数**：

| 参数    | 类型                  | 默认值 | 描述                                             |
| ------- | --------------------- | ------ | ------------------------------------------------ |
| group   | str                   | None   | 群名                                             |
| members | Union[str, List[str]] | None   | 成员名或成员名列表                               |
| reason  | str                   | None   | 申请理由，当群主开启验证时需要，不填写则取消申请 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否添加成功

### 获取当前聊天群成员 GetGroupMembers

```python
members = wx.GetGroupMembers()
```

**返回值**：

- 类型：`List[str]`
- 描述：当前聊天群成员列表

### 移除群成员 RemoveGroupMembers

```python
wx.RemoveGroupMembers(group="群名", members=["成员名1", "成员名2"])
```

**参数**：

| 参数    | 类型    | 默认值 | 描述    |
| ------- | ------- | ------ | ------- |
| group   | str     | None   | 群名    |
| members | str     | None   | 成员名  |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否移除成功

### 从群聊中添加好友 AddFriendFromGroup

```python
index = 5  # 申请群里索引值为5的成员为好友
remark = "备注名"
tags = ["标签1", "标签2"]
result = wx.AddFriendFromGroup(index=index, remark=remark, tags=tags)
if result:
    print("成功发起申请")
else:
    print(f"申请失败：{result['message']}")
```

**参数**：

| 参数    | 类型    | 默认值 | 描述    |
| ------- | ------- | ------ | ------- |
| index   | int     | None   | 群聊索引 |
| who     | str     | None   | 群名，当`Chat`对象时该参数无效，仅`WeChat`对象有效 |
| addmsg  | str     | None   | 申请理由，当群主开启验证时需要，不填写则取消申请 |
| remark  | str     | None   | 添加好友后的备注名 |
| tags    | list    | None   | 添加好友后的标签 |
| permission | Literal['朋友圈', '仅聊天'] | '仅聊天' | 添加好友后的权限 |
| exact   | bool    | False  | 是否精确匹配群聊名 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)

### 修改好友备注名或标签 ManageFriend

```python
wx.ManageFriend(remark="新备注名")
wx.ManageFriend(tags=["标签1", "标签2"])
```

**参数**：

| 参数   | 类型    | 默认值 | 描述     |
| ------ | ------- | ------ | -------- |
| remark | str     | None   | 备注名   |
| tags   | List[str] | None   | 标签列表 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否成功修改备注名或标签

### 管理当前群聊 ManageGroup

```python
wx.ManageGroup(name="新群名")
wx.ManageGroup(remark="新备注名")
wx.ManageGroup(myname="新群昵称")
wx.ManageGroup(notice="新群公告")
wx.ManageGroup(quit=True)   # 谨慎使用
```

**参数**：

| 参数   | 类型    | 默认值 | 描述     |
| ------ | ------- | ------ | -------- |
| name   | str     | None   | 群名称   |
| remark | str     | None   | 备注名   |
| myname | str     | None   | 我的群昵称 |
| notice | str     | None   | 群公告   |
| quit   | bool    | False  | 是否退出群，当该项为True时，其他参数无效 |

### 关闭窗口 Close

```python
wx.Close()
```

### 合并转发消息 MergeForward

**参数**：

| 参数   | 类型    | 默认值 | 描述     |
| ------ | ------- | ------ | -------- |
| targets   | Union[List[str], str]     | None   | 要转发的对象  |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：是否成功转发
  
### 获取对话框 GetDialog

```python
if dialog := wx.GetDialog():
    dialog.click_button("确定")
```

**参数**：

| 参数   | 类型    | 默认值 | 描述     |
| ------ | ------- | ------ | -------- |
| wait   | int     | 3   | 隐性等待时间  |

**返回值**：

- 类型：[`WeChatDialog`](/docs/class/other/#wechatdialog)
- 描述：对话框对象，如果不存在则返回None

### 移除置顶消息 GetTopMessage

```python
if top_messages := wx.GetTopMessage():
    for top_message in top_messages:
        print(f"移除置顶消息: {top_message.content}")
        top_message.remove()
```

**参数**：无

**返回值**：

- 类型：`List[TopMsg]`

---

## File: docs/class/Message.md

---
weight: 3
bookFlatSection: true
title: "Message类"
---

消息类中，有两个固定属性：

- **`attr`**：消息属性，即消息的来源属性
  - system：系统消息
  - time：时间消息
  - tickle：拍一拍消息
  - self：自己发送的消息
  - friend：好友消息
  - other：其他消息
- **`type`**：消息类型，即消息的内容属性
  - text：文本消息
  - quote：引用消息
  - voice：语音消息
  - image：图片消息
  - video：视频消息
  - file：文件消息
  - location：位置消息
  - link：链接消息
  - emotion：表情消息
  - merge：合并转发消息
  - personal_card：个人名片消息
  - note: 笔记消息
  - other：其他消息

而`self`和`friend`又可以跟消息类型所组合，所以所有消息类别如下：



|                                                      |   [自己发送的消息`SelfMessage`](#selfmessage)  |   [对方发来的消息`FriendMessage`](#friendmessage)  |
| :--------------------------------------------------: | :-----------------------------------------: | :---------------------------------------------: |
|         [文本消息`TextMessage`](#textmessage)         |                SelfTextMessage             |               FriendTextMessage                  |
|        [引用消息`QuoteMessage`](#quotemessage)        |                SelfQuoteMessage            |               FriendQuoteMessage                 |
|        [语音消息`VoiceMessage`](#voicemessage)        |                SelfVoiceMessage            |               FriendVoiceMessage                 |
|        [图片消息`ImageMessage`](#imagemessage)        |                SelfImageMessage            |               FriendImageMessage                 |
|        [视频消息`VideoMessage`](#videomessage)        |                SelfVideoMessage            |               FriendVideoMessage                 |
|         [文件消息`FileMessage`](#filemessage)         |                SelfFileMessage             |               FriendFileMessage                  |
|     [位置消息`LocationMessage`](#locationmessage)     |              SelfLocationMessage           |             FriendLocationMessage                |
|         [链接消息`LinkMessage`](#linkmessage)         |                SelfLinkMessage             |               FriendLinkMessage                  |
|      [表情消息`EmotionMessage`](#emotionmessage)      |               SelfEmotionMessage           |              FriendEmotionMessage                |
|        [合并消息`MergeMessage`](#mergemessage)        |                SelfMergeMessage            |               FriendMergeMessage                 |
| [名片消息`PersonalCardMessage`](#personalcardmessage) |            SelfPersonalCardMessage         |           FriendPersonalCardMessage              |
|      [笔记消息`NoteMessage`](#notemessage)            |                SelfNoteMessage             |               FriendNoteMessage                  |
|        [其他消息`OtherMessage`](#othermessage)        |                SelfOtherMessage            |               FriendOtherMessage                 |

简单的使用示例：

```python
from wxauto.msgs import *

... # 省略获取消息对象的过程

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

# 当消息为好友消息时，回复收到
# 方法一：
if msg.attr == 'friend':
    msg.reply('收到')

# 方法二：
if isinstance(msg, FriendMessage):
    msg.reply('收到')
```

## Message

消息基类，所有消息类型都继承自该类

**属性**（所有消息类型都包含以下属性）：

| 属性名 | 类型 | 描述  |
| :-----: | :---: | -------- |
| type  | str | 消息内容类型 |
| attr  | str | 消息来源类型 |
| info | Dict | 消息的详细信息 |
| id | str | 消息UI ID（不重复，切换UI后会变） |
| hash | str | 消息hash值（可能重复，切换UI后不变） |
| sender | str | 消息发送者 |
| content | str | 消息内容 |

### chat_info

获取该消息所属聊天窗口的信息

```python
chat_info = msg.chat_info()
```

**返回值**：

- 类型：`dict`
- 描述：聊天窗口信息
- 返回值示例：
```python
# 好友
{'chat_type': 'friend', 'chat_name': '张三'}  

# 群聊
{'group_member_count': 500, 'chat_type': 'group', 'chat_name': '工作群'}  

# 客服
{'company': '@肯德基', 'chat_type': 'service', 'chat_name': '店长xxx'} 

# 公众号
{'chat_type': 'official', 'chat_name': '肯德基'} 
```

###  get_all_text

获取消息中所有文本内容

```python
text_list = msg.get_all_text()
```

**返回值**：

- 类型：List[str]

### roll_into_view

将消息滚动到视野内

```python
msg.roll_into_view()
```

## SystemMessage

系统消息，没有特殊用法

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| attr | str |  system | 消息属性 |

## TickleMessage

拍一拍消息，继承自[SystemMessage](#systemmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| attr | str |  tickle | 消息属性 |

特有属性：

| 属性     | 类型   | 描述             |
| -------- | ------ | ---------------- |
| tickle_list     | str    | 拍一拍消息列表  |

## TimeMessage

时间消息

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| attr | str |  time | 消息属性 |

特有属性：

| 属性     | 类型   | 描述             |
| -------- | ------ | ---------------- |
| time     | str    | 时间  YYYY-MM-DD HH:MM:SS  |

## HumanMessage

人发送的消息，即自己或好友、群友发送的消息

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| attr | str |  friend | 消息属性 |

特有属性：

| 属性     | 类型   | 描述             |
| -------- | ------ | ---------------- |
| sender_remark  | str    | **群消息**中，该消息发送人自己设置的“我在本群的昵称”  |

### click

点击该消息，一般特殊消息才会有作用，比如图片消息、视频消息等

```python
msg.click()
```

### select_option

右键该消息，弹出右键菜单，并选择指定选项

```python
msg.select_option("复制")
```

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果

### quote

引用该消息，并回复

```python
msg.quote("回复内容")
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| text   | str    | 无       | 引用内容       |
| at     | Union[List[str], str] | 无       | @用户列表     |
| timeout | int    | 3        | 超时时间，单位为秒 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果

### forward

转发该消息

```python
msg.forward("张三")

msg.forward("张三", message="转发会议材料给你，请查收")
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| targets    | Union[List[str], str]    | 无       | 转发对象名称   |
| message    | str    | None       | 要附加的消息   |
| timeout | int    | 3        | 超时时间，单位为秒 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果


### tickle

拍一拍该消息发送人

```python
msg.tickle()
```

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果

### delete

删除该消息

```python
msg.delete()
```

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果

### download_head_image

下载该消息发送人的头像

```python
msg.download_head_image()
```

**返回值**：

- 类型：Path
- 描述：下载路径Path对象

## FriendMessage

好友、群友发送的消息，即聊天页面中，左侧人员发送的消息。继承自[HumanMessage](#humanmessage)



### sender_info

获取发送人信息

```python
msg.sender_info()
```

**返回值**：

- 类型：Dict[str, str]



### at

@该消息发送人

```python
msg.at('xxxxxx')
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| content   | str  | 必填       | 要发送的内容    |
| quote     | bool | False     | 是否引用该消息    |


**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果



### add_friend

添加该消息的发送人为好友

```python
msg.add_friend()
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| addmsg   | str  | None      | 添加好友时的附加消息，默认为None    |
| remark     | str | None     | 添加好友后的备注，默认为None    |
| tags     | list | None     | 添加好友后的标签，默认为None    |
| permission     | Literal['朋友圈', '仅聊天'] | '朋友圈'     | 添加好友后的权限，默认为'朋友圈'    |
| timeout     | int | 3     | 搜索好友的超时时间，默认为3秒    |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：操作结果


### multi_select

多选该消息，仅作合并转发使用，如果不进行合并转发，请勿调用该方法

```python
msg.multi_select()
```

**参数**：无

**返回值**：无


## SelfMessage

自己发送的消息，即聊天页面中，右侧自己发送的消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| attr | str |  self | 消息属性 |

## TextMessage

文本消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  text | 消息属性 |

## QuoteMessage

引用消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  quote | 消息属性 |

特有属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| quote_content | str |  引用消息内容 | 引用消息内容 |

### download_quote_image

下载引用消息中的图片，返回图片路径

```python
msg.download_quote_image()
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述         |
| ----- | --- |----- | -------- |
| dir_path     | str | None     | 下载路径，默认为None |
| timeout     | int | 10     | 超时时间，默认为10秒    |

**返回值**：
Path: 视频路径，成功时返回该类型

### click_quote

点击引用框体

```python
msg.click_quote()
```

**参数**：无

**返回值**：无

## ImageMessage

图片消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  image | 消息属性 |

### download

下载图片，返回图片路径

```python
msg.download()
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| dir_path | Union[str, Path]  | None | 下载图片的目录，不填则默认[WxParam.DEFAULT_SAVE_PATH](#wxparam-类) |
| timeout | int  |  10 | 下载超时时间 |

**返回值**：

- Path: 图片路径，成功时返回该类型
- [`WxResponse`](/docs/class/other/#wxresponse): 下载结果，失败时返回该类型

## VideoMessage

视频消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  video | 消息属性 |

### download

下载视频，返回视频路径

```python
msg.download()
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| dir_path | Union[str, Path]  | None | 下载视频的目录，不填则默认[WxParam.DEFAULT_SAVE_PATH](#wxparam-类) |
| timeout | int  |  10 | 下载超时时间 |

**返回值**：

- Path: 视频路径，成功时返回该类型
- [`WxResponse`](/docs/class/other/#wxresponse): 下载结果，失败时返回该类型

## VoiceMessage

语音消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  voice | 消息属性 |

### to_text

将语音消息转换为文本，返回文本内容

```python
msg.to_text()
```

## FileMessage

文件消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  file | 消息属性 |

### download

下载文件，返回文件路径

```python
msg.download()
```

**参数**：

| 参数名 | 类型   |  默认值  | 描述           |
| ------ | ------ | -------- | -------------- |
| dir_path | Union[str, Path]  | None | 下载文件的目录，不填则默认[WxParam.DEFAULT_SAVE_PATH](#wxparam-类) |
| force_click | bool  |  False | 是否强制点击文件消息（当自动下载不可用时指定，否则会打开该文件） |
| timeout | int  |  10 | 下载超时时间 |

**返回值**：

- Path: 文件路径，成功时返回该类型
- [`WxResponse`](/docs/class/other/#wxresponse): 下载结果，失败时返回该类型

## LocationMessage

位置消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  location | 消息属性 |

特有属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| address | str |  地址信息 | 该消息卡片的地址信息 |

## LinkMessage

链接消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  link | 消息属性 |

### get_url

获取链接地址

```python
msg.get_url()
```

| 参数名 | 类型   |  默认值  | 描述    |
| ------ | ------ | -------- | ------ |
| timeout | int  |  10 | 下载超时时间 |

**返回值**：

- str: 链接地址

## EmotionMessage

表情消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  emotion | 消息属性 |

## MergeMessage

合并消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  merge | 消息属性 |

### get_messages

获取合并消息中的所有消息

```python
msg.get_messages()
```

**返回值**：

- List[str]: 合并消息中的所有消息

## PersonalCardMessage

名片消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  personal_card | 消息属性 |

### add_friend

添加好友

```python
msg.add_friend()
```

| 参数名 | 类型   |  默认值  | 描述    |
| ------ | ------ | -------- | ------ |
| addmsg | str    | None     | 添加好友时的附加消息 |
| remark | str    | None     | 添加好友后的备注 |
| tags   | List[str]   | None     | 添加好友后的标签 |
| permission | Literal['朋友圈', '仅聊天'] | '朋友圈' | 添加好友后的权限 |
| timeout | int    | 3        | 搜索好友的超时时间 |

**返回值**：

- [`WxResponse`](/docs/class/other/#wxresponse): 是否添加成功

## NoteMessage

笔记消息。继承自[HumanMessage](#humanmessage)

固定属性：

| 属性名 | 类型 | 属性值  | 描述  |
| ----- | --- |----- | -------- |
| type | str |  note | 消息属性 |

### get_content

获取笔记内容

```python
from pathlib import Path

note_content_list = msg.get_content()
for content in note_content_list:
    if isintance(content, str):
        # 文本内容
        print(content)
    elif isintance(content, Path):
        # 文件路径，文件、视频、图片等
        print('文件路径：', content)
```


### save_files

保存笔记中的文件

```python
msg.save_files()
```

| 参数名 | 类型   |  默认值  | 描述    |
| ------ | ------ | -------- | ------ |
| dir_path | Union[str, Path]    | None     | 保存路径 |

**返回值**：

- [`WxResponse`](/docs/class/other/#wxresponse): 是否保存成功，若成功则data为保存的文件路径列表

### to_markdown

将笔记转换为Markdown格式

```python
msg.to_markdown()
```

| 参数名 | 类型   |  默认值  | 描述    |
| ------ | ------ | -------- | ------ |
| dir_path | Union[str, Path]    | None     | 保存路径 |

**返回值**：

- Path: markdown文件路径

## OtherMessage

其他暂未支持解析的消息类型

---

## File: docs/class/Moment.md

---
weight: 5
bookFlatSection: true
title: "朋友圈类"
---

## MomentsWnd

**朋友圈窗口**对象，即的是朋友圈的窗口对象，提供对朋友圈窗口的各种操作，如获取朋友圈内容、刷新、关闭等功能。

```python
from wxauto import WeChat

wx = WeChat()
pyq = wx.Moments()   # 打开朋友圈并获取朋友圈窗口对象（如果为None则说明你没开启朋友圈，需要在手机端设置）
```

### GetMoments

**获取朋友圈内容**

```python
# 获取当前页面的朋友圈内容
moments = pyq.GetMoments()

# 通过`next_page`参数获取下一页的朋友圈内容
moments = pyq.GetMoments(next_page=True)
```

**参数**：

|   参数    | 类型 | 默认值  |                             说明                             |
| :-------: | :--: | :---: | :----------------------------------------------------------: |
| next_page | bool | False |                       是否翻页后再获取                       |
|  speed1   | int  |   3   |  翻页时的滚动速度，根据自己的情况进行调整，建议3-10自行调整  |
|  speed2   | int  |   1   | 翻页最后时的速度，避免翻页过多导致遗漏所以一般比speed1慢，建议1-3 |

**返回值**：List[[Moments](#Moments)]

### Refresh

**刷新朋友圈**

```python
pyq.Refresh()
```

### close

**关闭朋友圈**

```python
pyq.close()
```


## Moments

**朋友圈内容**对象，即的是朋友圈的内容对象，提供对朋友圈的各种操作，如获取朋友圈内容、点赞、评论等功能。



```python
# 获取朋友圈对象
moments = pyq.GetMoments()

# 获取第一条朋友圈
moment = moments[0]
```


### 获取朋友圈内容

```python
# 获取朋友圈内容
info = moment.info
# {
#     'type': 'moment',            # 类型，分为`朋友圈`和`广告`
#     'id': '4236572776458165',    # ID
#     'sender': '天天鲜花2号客服',   # 发送者
#     'content': '客订花束',        # 内容，就是朋友圈的文字内容，如果没有文字内容则为空字符串
#     'time': '4分钟前',            # 发送时间
#     'img_count': 3,              # 图片数量
#     'comments': [],              # 评论
#     'addr': '',                  # 发送位置
#     'likes': []                  # 点赞
# }

moment.sender
# '天天鲜花2号客服'

moment.content
# '客订花束'

moment.time
# '4分钟前'

# info中所有的键值对都可以通过对象的属性来获取，就不一一列举了
...
```

### SaveImages

**保存朋友圈图片**

**参数**：

|     参数     |    类型     | 默认值 |                             说明                             |
| :----------: | :---------: | :----: | :----------------------------------------------------------: |
| `save_index` | int \| list |  None  | 保存图片的索引，可以是一个整数或者一个列表，如果为None则保存所有图片 |
|  `savepath`  |     str     |  None  | 绝对路径，包括文件名和后缀，例如："D:/Images/微信图片_xxxxxx.jpg"，如果为None则保存到默认路径 |

**返回值**：List[str]，保存的图片的绝对路径列表

```python
# 获取朋友圈图片
images = moment.SaveImages()
# [
#     'D:/Images/微信图片_xxxxxx1.jpg',
#     'D:/Images/微信图片_xxxxxx2.jpg',
#     'D:/Images/微信图片_xxxxxx3.jpg',
#     ...
# ]
```

### Like

**点赞朋友圈**

**参数**：

| 参数 | 类型 | 默认值 | 说明 |
| :--: | :--: | :----: | :--: |
| like | bool |  True  | True点赞，False取消赞 |

```python
# 点赞
moment.Like()
# 取消赞
moment.Like(False)
```

**返回值**：无

### Comment

**评论朋友圈**

**参数**：

| 参数 | 类型   | 默认值 | 说明 |
| :--: | :----: | :----: | :--: |
| text | str |  必填  | 评论内容 |

```python
# 评论
moment.Comment('评论内容')
```

**返回值**：无

---

## File: docs/class/Other.md

---
weight: 6
bookFlatSection: true
title: "其他类（方法）"
---

### WxResponse

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

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

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

### WxParam

该类用于该项目的一些参数，在获取`WeChat`实例前，可以通过修改该类的属性来修改默认参数

| 属性                | 类型   |  默认值  | 描述                                                                                     |
| ------------------- | ------ | -------- | ---------------------------------------------------------------------------------------- |
| ENABLE_FILE_LOGGER  | bool   | True     | 是否启用日志文件                                                                         |
| DEFAULT_SAVE_PATH   | str    | ./wxauto | 下载文件/图片默认保存路径 |
| MESSAGE_HASH        | bool   | False    | 是否启用消息哈希值用于辅助判断消息，开启后会稍微影响性能                               |
| DEFAULT_MESSAGE_XBIAS | int    | 51       | 头像到消息X偏移量，用于消息定位，点击消息等操作                                       |
| FORCE_MESSAGE_XBIAS  | bool   | True    | 是否强制重新自动获取X偏移量，如果设置为True，则每次启动都会重新获取，系统设置了分辨率缩放时开启    |
| LISTEN_INTERVAL     | int    | 1        | 监听消息时间间隔，单位秒                                                                 |
| LISTENER_EXCUTOR_WORKERS | int    | 4        | 监听执行器线程池大小，根据自身需求和设备性能设置                                       |
| SEARCH_CHAT_TIMEOUT | int    | 5        | 搜索聊天对象超时时间，单位秒                                                             |
| NOTE_LOAD_TIMEOUT | int    | 30        | 微信笔记加载超时时间，单位秒                                                            |


示例：

```python
from wxauto import WxParam

# 设置8个监听线程
WxParam.LISTENER_EXCUTOR_WORKERS = 8
...
```


### NewFriendElement



| 属性     | 类型   | 描述（以上图为例）       |
| -------- | ------ | --------------- |
| name     | str    | 对方名（诸葛孔明）  |
| msg     | str    | 申请信息（wxauto）  |
| acceptable | bool    | 是否可接受（True）  |

#### accept

**同意添加好友**

参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| remark | str | None | 备注 |
| tags | list | None | 标签 |
| permission | str  | '朋友圈' | 朋友圈权限，可选值：'全部'、'仅聊天' |

#### delete

**删除好友申请**

参数：无

#### reply

**回复好友申请**

参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| text | str | 必填 | 回复信息 |

#### get_account

**获取申请添加的好友的账号信息**


参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| wait | int | 5 | 等待时间 |

返回值：str

### LoginWnd


该类用于微信登录、获取二维码等操作

```python
from wxauto import LoginWnd

wxlogin = LoginWnd(app_path="...")
```



参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| app_path | str | None | 微信客户端路径 |


属性：无

#### login

**登录微信**

参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| timeout | int | 10 | 登录超时时间 |

返回值：[`WxResponse`](#wxresponse)

#### get_qrcode

**获取二维码**

参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| path | str | None | 二维码图片的保存路径，None即本地目录下的wxauto_qrcode文件夹 |

返回值：str，二维码图片的路径

#### reopen

**重新打开微信**，为了避免各种弹窗影响操作，建议调用该方法后再执行login或get_qrcode

参数：无

返回值：无

#### open

**启动微信**，建议在初始化的时候传入app_path参数，否则可能会启动失败

参数：无

返回值：无

### WeChatImage

```python
from wxauto.ui.component import WeChatImage

imgwnd = WeChatImage()
```

微信图片/视频**窗口**类，用于处理微信图片或图片窗口的各种操作



#### ocr

**识别图片中的文字**，仅支持图片，不支持视频

参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| wait | int | 10 | 隐性等待时间 |

返回值：str，识别到的文字

#### save

**保存图片/视频**

参数：

| 参数名 | 类型 |  默认值 | 说明 |
| :--- | :--- | :--- |:--- |
| dir_path | str | None | 保存的目录路径，None即本地路径下自动生成 |
| timeout | int | 10 | 保存超时时间 |

返回值：Path，保存的文件路径

#### close

**关闭图片/视频窗口**

参数：无

返回值：无

### WeChatDialog

微信对话框对象，用于处理微信对话框的各种操作



#### select_option

**选择对话框中的选项**，如“确定”、“取消”等

参数：无

返回值：[WxResponse](#wxresponse)对象

#### get_all_text

**获取对话框中所有的文字内容**

参数：无

返回值：str

#### close

**关闭对话框**

参数：无

返回值：无

### get_wx_clients

**获取所有已登录的微信3.9客户端**

```python
from wxauto import get_wx_clients

# 获取所有微信客户端
clients = get_wx_clients()
for client in clients:
    print(f"微信客户端: {client}")
```

返回值：List[[WeChat](/docs/class/wechat)]

> [!Warning]
> **wxauto项目不支持一切违反官方用户协议的操作，不建议、不支持、不提供微信多开的方法或行为。**
> 但是如果你**自行使用**其他方法多开微信，wxauto不承担由你自行多开的行为导致的风险，也不保证所有功能的正常调用。

### get_wx_logins

```python
from wxauto import get_wx_logins

# 获取所有微信客户端
login_windows = get_wx_logins()

# 关闭所有登录窗口
for login_window in login_windows:
    login_window.close()  # 关闭
```

返回值：List[[LoginWnd](#loginwnd)]


> [!Warning]
> **wxauto项目不支持一切违反官方用户协议的操作，不建议、不支持、不提供微信多开的方法或行为。**
> 但是如果你**自行使用**其他方法多开微信，wxauto不承担由你自行多开的行为导致的风险，也不保证所有功能的正常调用。

---

## File: docs/class/Session.md

---
weight: 4
bookFlatSection: true
title: "Session类"
---

## Session 类方法

```python
... # 此处省略wx对象的初始化

sessionbox = wx.SessionBox
```

### search

**仅用于触发搜索**，返回搜索结果，不会进行下一步的动作，可自行处理搜索结果

**示例**：

```python
search_result = sessionbox.search('张三')
for item in search_result:
    print(f"type: {item.type}, text: {item.text}")
```

**参数**：

|   参数    | 类型 | 默认值  |        说明             |
| :-------: | :--: | :---: | :-------------------: |
| keywords | str | False |  搜索关键词      |
| force | bool | False |  是否强制等待，避免未搜索到就返回结果      |
| force_wait | Union[float, int] | 0.5 |  强制等待时间，秒      |

**返回值**：

List[[SearchResultElement](#searchresultelement)]

### go_top

回到会话列表顶部

**参数**：无

**返回值**：无

### roll_up

向上滚动会话列表

**参数**：

|   参数    | 类型 | 默认值  |        说明             |
| :-------: | :--: | :---: | :-------------------: |
| n | int | 5 |  滚动次数，自行调节滚动幅度      |

**返回值**：无

### roll_down

向下滚动会话列表

**参数**：

|   参数    | 类型 | 默认值  |        说明             |
| :-------: | :--: | :---: | :-------------------: |
| n | int | 5 |  滚动次数，自行调节滚动幅度      |

**返回值**：无



## SessionElement



| 属性     | 类型   | 描述（以上图为例）       |
| -------- | ------ | --------------- |
| name     | str    | 会话名（wxauto三群）  |
| time     | str    | 时间（2025-05-14 14:41）  |
| content     | str    | 消息内容（[10条]天道酬勤：这..）  |
| ismute     | bool    | 是否消息免打扰（True）  |
| isnew     | bool    | 是否有新消息（True）  |
| new_count     | int    | 新消息数量（10）  |
| info     | Dict[str, Any]    | 会话信息（包含了上述所有属性的dict）  |

```python
from wxauto import WeChat

wx = WeChat()
sessions = wx.GetSession()
session = sessions[0]  # 获取第一个会话
```

### click

**点击会话**，即切换到这个聊天窗口

参数：无

返回值：无

示例：
```python
session.click()
```

### double_click

**双击会话**，即将这个聊天窗口独立出去

参数：无

返回值：无

示例：
```python
session.double_click()
```

### delete

**删除会话**

参数：无

返回值：[`WxResponse`](/docs/class/other/#wxresponse)

示例：
```python
session.delete()
```

### hide

**隐藏会话**

参数：无

返回值：[`WxResponse`](/docs/class/other/#wxresponse)

示例：
```python
session.hide()
```

### select_option

**选择会话选项**，即右键点击会话，然后选择某个选项

参数：

| 参数名 | 类型 | 说明 |
| :--- | :--- | :--- |
| option | str | 选项名称，例如“置顶”、“标为未读”等 |

返回值：[`WxResponse`](/docs/class/other/#wxresponse)

## SearchResultElement

会话搜索结果对象

| 属性     | 类型   | 描述             |
| -------- | ------ | ---------------- |
| type  | str    | 搜索结果对象的UI类型，一般`pane`是分割线或者标签，不可交互；`listitem`是搜索结果，可交互  |
| text  | str    | 搜索结果，有时候卡可能为空，建议使用`get_all_text`方法进行完整判断  |

### get_all_text

获取该结果对象的所有UI文字内容，用于判断是不是你要的搜索结果

**参数**：无

**返回值**：List[str]

### click

点击该搜索对象

**参数**：无

**返回值**：无

### close

关闭搜索窗口，关闭后本次搜索的所有对象均不可再交互

**参数**：无

**返回值**：无

---

## File: docs/class/WeChat.md

---
weight: 1
bookFlatSection: true
title: "WeChat类"
---


## WeChat 类方法


### 初始化参数

| 参数     | 类型 | 默认值 | 描述                             |
| -------- | ---- | ------ | -------------------------------- |
| nickname | str  | None   | 微信昵称，用于定位特定的微信窗口 |
| debug    | bool | False  | 是否开启调试模式                 |

```python
from wxauto import WeChat

wx = WeChat()
```

### 保持程序运行 KeepRunning

由于wxauto使用守护线程来监听消息，当程序仅用于监听模式时，主线程会退出，因此需要调用此方法来保持程序运行

```python
from wxauto import WeChat

wx = WeChat()
wx.AddListenChat('张三', callback=lambda msg, chat: ...)

# 保持程序运行，确保正常监听
wx.KeepRunning()
```

### 获取当前会话列表 GetSession

```python
sessions = wx.GetSession()
for session in sessions:
    print(session.info)
```

**返回值**：

- 类型：List[[SessionElement](/docs/class/other/#sessionelement)]
- 描述：当前会话列表

### 发送链接卡片 SendUrlCard

```python
wx.SendUrlCard(url="https://example.com", friends="张三", timeout=10)
```

**参数**：

| 参数    | 类型                  | 默认值 | 描述                                   |
| ------- | --------------------- | ------ | -------------------------------------- |
| url     | str                   | 必填   | 链接地址                               |
| friends | Union[str, List[str]] | None   | 发送对象，可以是单个用户名或用户名列表 |
| message | str | None   | 附加消息，默认不发送 |
| timeout | int                   | 10     | 等待时间（秒）                         |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：发送结果

### 打开聊天窗口 ChatWith

```python
wx.ChatWith(who="张三", exact=False)
```

**参数**：

| 参数  | 类型 | 默认值 | 描述                   |
| ----- | ---- | ------ | ---------------------- |
| who   | str  | 必填   | 要聊天的对象           |
| exact | bool | False  | 搜索好友时是否精确匹配 |

**返回值**：无

### 获取子窗口实例 GetSubWindow

```python
chat = wx.GetSubWindow(nickname="张三")
```

**参数**：

| 参数     | 类型 | 默认值 | 描述                 |
| -------- | ---- | ------ | -------------------- |
| nickname | str  | 必填   | 要获取的子窗口的昵称 |

**返回值**：

- 类型：[`Chat`](/docs/class/Chat)
- 描述：子窗口实例

### 获取所有子窗口实例 GetAllSubWindow

```python
chats = wx.GetAllSubWindow()
```

**返回值**：

- 类型：List[[`Chat`](/docs/class/Chat)]
- 描述：所有子窗口实例的列表

### 添加监听聊天窗口 AddListenChat

```python
def on_message(msg, chat):
    print(f"收到来自 {chat} 的消息: {msg.content}")

wx.AddListenChat(nickname="张三", callback=on_message)
```

**参数**：

| 参数     | 类型                                              | 默认值 | 描述                                                       |
| -------- | ------------------------------------------------- | ------ | ---------------------------------------------------------- |
| nickname | str                                               | 必填   | 要监听的聊天对象                                           |
| callback | Callable[[[Message](/docs/class/message/), [Chat](/docs/class/chat/)], None] | 必填   | 回调函数，参数为([Message](/docs/class/message/)对象, [Chat](/docs/class/chat/)对象) |

**返回值**：

- 成功时：
  - 类型：[Chat](/docs/class/chat/)
  - 描述：该监的听子窗口实例

- 失败时：
  - 类型：[`WxResponse`](/docs/class/other/#wxresponse)
  - 描述：执行结果，成功时包含监听名称

### 移除监听聊天 RemoveListenChat

```python
wx.RemoveListenChat(nickname="张三")
```

**参数**：

| 参数     | 类型 | 默认值 | 描述                 |
| -------- | ---- | ------ | -------------------- |
| nickname | str  | 必填   | 要移除的监听聊天对象 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：执行结果

### 开始监听 StartListening

```python
wx.StartListening()
```

**参数**：无

**返回值**：无

### 停止监听 StopListening

```python
wx.StopListening()
```

**参数**：

| 参数     | 类型 | 默认值 | 描述                 |
| -------- | ---- | ------ | -------------------- |
| remove | bool  | True   | 是否移出所有子窗口 |

**返回值**：无

### 进入朋友圈 Moments

```python
moments = wx.Moments(timeout=3)
```

**参数**：

| 参数    | 类型 | 默认值 | 描述           |
| ------- | ---- | ------ | -------------- |
| timeout | int  | 3      | 等待时间（秒） |

**返回值**：

- 类型：[`MomentsWnd`](/docs/class/moment)
- 描述：朋友圈窗口实例

### 获取下一个新消息 GetNextNewMessage

```python
messages = wx.GetNextNewMessage(filter_mute=False)
```

**参数**：

| 参数        | 类型 | 默认值 | 描述                 |
| ----------- | ---- | ------ | -------------------- |
| filter_mute | bool | False  | 是否过滤掉免打扰消息 |

**返回值**：

- 类型：Dict[str, List[[Message](/docs/class/message/)]
- 描述：消息列表，键为聊天名称，值为消息列表
- 示例：
    ```python
    {'chat_name': 'wxauto交流',
      'chat_type': 'group',
      'msg': [
          <wxauto - TimeMessage(2025年5月2...) at 0x227379555d0>,
          <wxauto - FriendImageMessage([图片]) at 0x2273795ca10>,
          <wxauto - FriendTextMessage(/[微笑]) at 0x22737967c50>,
          <wxauto - FriendTextMessage(你点击发送会自动...) at 0x227366c4f50>, 
          ...
        ]
    }
    ```

### 获取好友列表 GetFriendDetails

```python
# 获取前10个好友详情信息
messages = wx.GetFriendDetails(n=10)
```

**参数**：

| 参数        | 类型 | 默认值 | 描述                 |
| ----------- | ---- | ------ | -------------------- |
|        n    | int  | None   | 获取前n个好友详情信息 |
| tag         | str  | None   | 从指定拼音首字母开始 |
| timeout     | int  | 0xFFFFF | 获取超时时间（秒） |

**返回值**：

- 类型：List[dict]
- 描述：好友详情信息列表

> [!warning]
> 1. 该方法运行时间较长，约0.5~1秒一个好友的速度，好友多的话可将n设置为一个较小的值，先测试一下
> 2. 如果遇到企业微信的好友且为已离职状态，可能导致微信卡死，需重启（此为微信客户端BUG）
> 3. 该方法未经过大量测试，可能存在未知问题，如有问题请微信群内反馈


### 获取新的好友申请列表 GetNewFriends


```python
newfriends = wx.GetNewFriends(acceptable=True)
```

**参数**：

| 参数       | 类型 | 默认值 | 描述                       |
| ---------- | ---- | ------ | -------------------------- |
| acceptable | bool | True   | 是否过滤掉已接受的好友申请 |

**返回值**：

- 类型：List[[`NewFriendElement`](/docs/class/other/#newfriendelement)]
- 描述：新的好友申请列表

**示例**：

```python
newfriends = wx.GetNewFriends(acceptable=True)
tags = ['标签1', '标签2']
for friend in newfriends:
    remark = f'备注{friend.name}'
    friend.accept(remark=remark, tags=tags)  # 接受好友请求，并设置备注和标签
```

### 添加新的好友 AddNewFriend

```python
wx.AddNewFriend(keywords="张三", addmsg="我是小明", remark="老张", tags=["同学"], permission="朋友圈", timeout=5)
```

**参数**：

| 参数       | 类型                        | 默认值   | 描述                                     |
| ---------- | --------------------------- | -------- | ---------------------------------------- |
| keywords   | str                         | 必填     | 搜索关键词，可以是昵称、微信号、手机号等 |
| addmsg     | str                         | None     | 添加好友时的附加消息                     |
| remark     | str                         | None     | 添加好友后的备注                         |
| tags       | List[str]                   | None     | 添加好友后的标签                         |
| permission | Literal['朋友圈', '仅聊天'] | '朋友圈' | 添加好友后的权限                         |
| timeout    | int                         | 5        | 搜索好友的超时时间（秒）                 |

**返回值**：

- 类型：[`WxResponse`](/docs/class/other/#wxresponse)
- 描述：添加好友的结果

### 获取最近群聊名称列表 GetAllRecentGroups

```python
groups = wx.GetAllRecentGroups()
if groups:
    print(groups)
else:
    print('获取失败')
```

**返回值**：

- 类型：WxResponse | List[str]: 失败时返回WxResponse，成功时返回所有最近群聊列表

### 切换到聊天页面 SwitchToChat

```python
wx.SwitchToChat()
```

**返回值**：无

### 切换到联系人页面 SwitchToContact

```python
wx.SwitchToContact()
```

**返回值**：无


### 是否在线 IsOnline

```python
wx.IsOnline()
```

**返回值**：

- 类型：bool

### 获取我的信息 GetMyInfo

获取自己的微信号等信息

```python
wx.GetMyInfo()
```

**返回值**：

- 类型：Dict[str, str]

### 获取通讯录群聊列表 GetContactGroups

获取通讯录中的群聊列表

```python
wx.GetContactGroups()
```

**参数**：

> [!NOTE]
> 自动化操作个体差异较大，根据实际情况调整以下参数，速度不合适可能导致漏掉部分群聊

| 参数  | 类型    | 默认值   | 描述     |
| ------ | -------- | -------- | ----- |
| speed  | int   | 1     | 滚动速度 |
| interval | float    | 0.1     |  滚动时间间隔  |

**返回值**：

- 类型：List[str]

---

## File: docs/example.md

---
weight: 5
bookFlatSection: true
title: "五、使用示例"
---

### 1. 基本使用
 
```python
from wxauto import WeChat

# 初始化微信实例
wx = WeChat()

# 发送消息
wx.SendMsg("你好", who="张三")

# 获取当前聊天窗口消息
msgs = wx.GetAllMessage()
for msg in msgs:
    print(f"消息内容: {msg.content}, 消息类型: {msg.type}")
```

### 2. 监听消息

```python
from wxauto import WeChat
from wxauto.msgs import FriendMessage
import time

wx = WeChat()

# 消息处理函数
def on_message(msg, chat):
    # 示例1：将消息记录到本地文件
    with open('msgs.txt', 'a', encoding='utf-8') as f:
        f.write(msg.content + '\n')

    # 示例2：自动下载图片和视频
    if msg.type in ('image', 'video'):
        print(msg.download())

    # 示例3：自动回复收到
    if isinstance(msg, FriendMessage):
        msg.quote('收到')

    ...# 其他处理逻辑，配合Message类的各种方法，可以实现各种功能

# 添加监听，监听到的消息用on_message函数进行处理
wx.AddListenChat(nickname="张三", callback=on_message)

# 保持程序运行
wx.KeepRunning()
```

```python
# ... 程序运行一段时间后 ...

# 移除监听
wx.RemoveListenChat(nickname="张三")
```

### 3. 处理好友申请

```python
from wxauto import WeChat

wx = WeChat()

# 获取新的好友申请
newfriends = wx.GetNewFriends(acceptable=True)

# 处理好友申请
tags = ['同学', '技术群']
for friend in newfriends:
    remark = f'备注_{friend.name}'
    friend.accept(remark=remark, tags=tags)  # 接受好友请求，并设置备注和标签
```

### 4. 使用打字机模式发送消息

```python
from wxauto import WeChat

wx = WeChat()

# 普通文本发送
wx.SendTypingText("你好，这是一条测试消息", who="张三")

# 使用@功能和换行
wx.SendTypingText("各位好：\n{@张三} 请负责前端部分\n{@李四} 请负责后端部分", who="项目群")
```

### 5. 获取多个微信客户端/登录窗口

#### 5.1 获取多个微信客户端
```python
from wxauto import get_wx_clients

# 获取所有微信客户端
clients = get_wx_clients()
for client in clients:
    print(f"微信客户端: {client}")
```

#### 5.2 获取多个登录窗口

```python
from wxauto import get_wx_logins

# 获取所有微信客户端
login_windows = get_wx_logins()

# 关闭所有登录窗口
for login_window in login_windows:
    login_window.close()  # 关闭
```

### 6. 自动登录

```python
from wxauto import LoginWnd

wxpath = "D:/path/to/WeChat.exe"

# 创建登录窗口
loginwnd = LoginWnd(wxpath)

# 登录微信
loginwnd.login()
```

### 7. 获取登录二维码

```python
from wxauto import LoginWnd

wxpath = "D:/path/to/WeChat.exe"

# 创建登录窗口
loginwnd = LoginWnd(wxpath)

# 获取登录二维码图片路径
qrcode_path = loginwnd.get_qrcode()
print(qrcode)
```

### 8. 合并转发消息

```python
from wxauto import WeChat
from wxauto.msgs import HumanMessage

wx = WeChat()

# 打开指定聊天窗口
wx.ChatWith("工作群")

# 获取消息列表
msgs = wx.GetAllMessage()

# 多选最后五条消息
n = 0
for msg in msgs[::-1]:
    if n >= 5:
        break
    if isinstance(msg, HumanMessage):
        n += 1
        msg.multi_select()

# 执行合并转发
targets = [
    '张三',
    '李四
]
wx.MergeForward(targets)
```

### 9. 创建群聊

```python
from wxauto import WeChat

wx = WeChat()

# 以“张三”聊天窗口，添加“李四”，形成群聊
wx.AddGroupMembers(group='张三', members=['李四'])

# 简单等待
time.sleep(3)

# 修改群名
wx.ManageGroup(name='这是新群名')
```

---

## File: docs/README.md

当前目录`docs`为文档目录，请自行参考相应文档文件

## 快速开始

### 获取微信实例

```python
from wxauto import WeChat

# 初始化微信实例
wx = WeChat()
```

### 发送消息

```python
# 发送消息
wx.SendMsg("你好", who="文件传输助手")
```

### 获取当前聊天窗口消息

```python
# 获取当前聊天窗口消息
msgs = wx.GetAllMessage()

for msg in msgs:
    print('==' * 30)
    print(f"{msg.sender}: {msg.content}")
```

> [!TIP] Success
> ✅ 恭喜，你已经成功进行了自动化操作，接下来你可以继续探索更多功能。