Skip to content

文档：补充 File 组件路径格式支持及 OneBot 协议兼容说明 #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
astrbot-doc-agent wants to merge 1 commit into
base: v4
Choose a base branch
from
Open

文档：补充 File 组件路径格式支持及 OneBot 协议兼容说明 #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions en/dev/star/guides/send-message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ Similarly,
Comp.File(file="path/to/file.txt", name="file.txt") # Not supported by some platforms
```

> [!NOTE]
> - The `file` parameter supports local absolute paths, `file:///` URI format, and HTTP/HTTPS URLs.
> - In the OneBot v11 (aiocqhttp) adapter, local absolute paths are automatically converted to `file://` URI format to comply with the protocol requirements.
> - Cross-platform compatibility: Uses `pathlib.Path.as_uri()` to generate standard URIs, ensuring proper functionality on both Linux and Windows systems.

**Audio Record**

```py
Expand Down
5 changes: 5 additions & 0 deletions zh/dev/star/guides/send-message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ async def helloworld(self, event: AstrMessageEvent):
Comp.File(file="path/to/file.txt", name="file.txt") # 部分平台不支持
```

> [!NOTE]
> - `file` 参数支持本地绝对路径、`file:///` URI 格式以及 HTTP/HTTPS URL。
> - 在 OneBot v11 (aiocqhttp) 适配器中，本地绝对路径会自动转换为 `file://` URI 格式以符合协议要求。
> - 跨平台兼容性：使用 `pathlib.Path.as_uri()` 生成标准 URI，确保在 Linux 和 Windows 系统下均能正常工作。

**语音 Record**

```py
Expand Down