类型参考

约 396 字大约 1 分钟

2026-03-19

NcatBot 类型系统完整参考。按 通用层 → QQ 平台 → Bilibili 平台 组织。

Quick Reference

类型架构

ncatbot.types                    # 通用层导出（平台无关）
├── ncatbot.types.common         #   MessageSegment, MessageArray, PlainText, At, Image ...
├── ncatbot.types.qq             # QQ 平台: Face, Forward, Music, 枚举, Sender ...
├── ncatbot.types.napcat         # QQ 响应: NapCatModel, GroupInfo, SendMessageResult ...
├── ncatbot.types.bilibili       # Bilibili 平台: BiliSender, 枚举, 事件数据模型 ...
└── ncatbot.types.github         # GitHub 平台: GitHubSender, 枚举, Repo, Commit ...

消息段速查

通用段（所有平台共享）— from ncatbot.types import ...

类	`_type`	关键字段
`PlainText`	`"text"`	`text: str`
`At`	`"at"`	`user_id: str`（`"all"` = @全体）
`Reply`	`"reply"`	`id: str`
`Image`	`"image"`	`file`, `url?`, `file_id?`
`Record`	`"record"`	`file`, `url?`
`Video`	`"video"`	`file`, `url?`
`File`	`"file"`	`file`, `url?`

QQ 专属段 — from ncatbot.types.qq import ...

类	`_type`	关键字段
`Face`	`"face"`	`id: str`
`Share`	`"share"`	`url`, `title`
`Location`	`"location"`	`lat`, `lon`
`Music`	`"music"`	`type`, `id?`, `url?`
`Json`	`"json"`	`data: str`
`Markdown`	`"markdown"`	`content: str`
`Forward`	`"forward"`	`id?`, `content?`
`QQImage`	`"image"`	`sub_type`, `type?`

MessageArray 方法速查

方法	说明
`MessageArray()` / `.from_list()` / `.from_any()`	构造
`.add_text()` / `.add_at()` / `.add_image()` / `.add_video()` / `.add_reply()`	链式添加
`.filter(cls)` / `.filter_text()` / `.filter_at()` / `.filter_image()`	查询过滤
`.text`	拼接所有纯文本
`.to_list()`	序列化为 OB11 dict 列表

本目录索引

文件	层级	说明
1_common_segments.md	通用	跨平台消息段基类与 7 种通用段
2_message_array.md	通用	MessageArray 容器完整方法详解
3_qq_segments.md	QQ	QQ 专属消息段（Face, Forward, Music 等）
4_qq_responses.md	QQ	Bot API 响应类型（NapCat 协议）
5_bilibili_types.md	Bilibili	Bilibili 平台类型（Sender, 枚举, 事件数据）
6_github_types.md	GitHub	GitHub 平台类型（Repo, Commit, Release, 枚举, 事件数据）

交叉引用

如果你在找…	去这里
消息发送教程	guide/send_message/
事件类型参考	events/
Bot API 方法签名	api/

版权所有

版权归属：huan-yp

许可证：署名 4.0 国际 (CC-BY-4.0)