Skip to content

Commit

Permalink
📝 补充主页 Readme 的文档说明 (#154)
Browse files Browse the repository at this point in the history
* 📝 补充Satori的文档说明

* 📝 fix typo

* 📝 补充QQ官方的部分以及相关解释

* 📝 补充discord并调整文档
  • Loading branch information
AzideCupric authored Jun 13, 2024
1 parent d30796a commit 026fdcf
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 24 deletions.
53 changes: 30 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,37 +86,44 @@ assert deserialized_target == target

### 支持的 adapter

| OneBot v11 | OneBot v12 | Kaiheila | Telegram | Feishu | Red | DoDo |
| :--------: | :--------: | :------: | :------: | :----: | :-: | :--: |
||||||||
| OneBot v11 | OneBot v12 | Kaiheila | Telegram | Feishu | Red | DoDo | Satori | QQ 官方 | Discord |
| :--------: | :--------: | :------: | :------: | :----: | :-: | :--: | :----: | :-----: | :-----: |
|||||||||||

### 支持的消息类型

| | OneBot v11 | OneBot v12 | 开黑啦 | Telegram | Feishu | Red | DoDo |
| :------: | :--------: | :--------: | :----: | :------: | :----: | :-: | :--: |
| 文字 ||||||||
| 图片 ||||||||
| 提及 ||||||||
| 提及全体 |||| 🚧 ||| 🚧 |
| 回复 |||||| 🚧 ||
| | OneBot v11 | OneBot v12 | 开黑啦 | Telegram | Feishu | Red | DoDo | Satori | QQ 官方 | Discord |
| :------: | :--------: | :--------: | :----: | :------: | :----: | :-: | :--: | :----: | :-----: | :-----: |
| 文字 |||||||||||
| 图片 |||||||||||
| 提及 |||||||||||
| 提及全体 |||| 🚧 ||| 🚧 ||||
| 回复 |||||| 🚧 |||||

> [!NOTE]
> 提及全体在 Telegram 和 DoDo中暂不支持,使用时会使用空的Text代替
> 提及全体在 Telegram 中不存在,在 DoDo 中只能接收,不能发送
### 支持的发送目标

| | OneBot v11 | OneBot v12 | Kaiheila | Telegram | Feishu | Red | DoDo |
| :--------------------: | :--------: | :--------: | :------: | :------: | :----: | :-: | :--: |
| QQ 群 ||| | | || |
| QQ 私聊 ||| | | || |
| QQ 频道子频道消息 | || | | | | |
| QQ 频道私聊 | || | | | | |
| 开黑啦私聊/频道 | | || | | | |
| Telegram 普通对话/频道 | | | || | | |
| 飞书私聊/群聊 | | | | || | |
| DoDo 私聊/群聊 | | | | | | ||

注:对于使用 Onebot v12,但是没有专门适配的发送目标,使用了 TargetOB12Unknow 来保证其可以正常使用
| | OneBot v11 | OneBot v12 | Kaiheila | Telegram | Feishu | Red | DoDo | Satori | QQ 官方 | Discord |
| :--------------------: | :--------: | :--------: | :------: | :------: | :----: | :-: | :--: | :------------: | :-----: | :-----: |
| QQ 群 ||| | | || || | |
| QQ 私聊 ||| | | || || | |
| QQ 频道子频道消息 | || | | | | | || |
| QQ 频道私聊 | || | | | | | || |
| 开黑啦私聊/频道 | | || | | | || | |
| Telegram 普通对话/频道 | | | || | | | ✅(仅普通对话) | | |
| 飞书私聊/群聊 | | | | || | || | |
| DoDo 私聊/群聊 | | | | | | || | | |
| QQ OpenId 版私聊/群聊 | | | | | | | | || |
| Discord 频道 | | | | | | | | | ||

> [!NOTE]
>
> - 对于使用 Onebot v12,但是没有专门适配的发送目标,使用了 TargetOB12Unknow 来保证其可以正常使用
> - 对于使用 Satori,但是没有专门适配对应 Platform 的发送目标,使用了 TargetSatoriUnKnown 来保证其可以正常使用
> - QQ OpenId 版私聊/群聊指的是使用官方的 QQ Open Id 作为用户标识的私聊和群聊
> - **Telegram 普通对话** 所指为其私聊和群聊
## 问题与例子

Expand Down
10 changes: 9 additions & 1 deletion docs/docs/usage/02-message-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,15 @@ mention_all = MentionAll()
```

:::warning[不支持提及全体消息时的行为]
目前并不是所有 Adapter 都支持提及全体消息,如果将提及全体消息发送给不支持的 Adapter,将会 **fallback** 到普通的空 `Text` 消息段,即`Text("")`。(比如DoDo、Telegram)
目前并不是所有 Adapter 都支持提及全体消息,如果将提及全体消息发送给不支持的 Adapter,将会进行 **fallback**

fallback 的默认行为是将 `MentionAll` 替换为 `Text`,用文本消息 `@全体成员` 替代。(取决于 Adapter 的适配实现)。

如果在 `MentionAll` 消息段中指定了 `fallback` 参数,将会使用该参数**原样**作为 fallback 的文本。

有时可能对不同的 Adapter 需要不同的 fallback 文本,这时可以使用 `MentionAll` 实例的`set_specific_fallback` 方法来设置特定适配器的 fallback 文本。

fallback文本的应用优先级为:`set_specific_fallback` > `fallback` > 默认fallback文本。
:::

## MessageId
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/usage/03-send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ SAA 内置了一些常用的 PlatformTarget 子类,可以直接使用。
- TargetFeishuGroup
- TargetDoDoChannel
- TargetDoDoPrivate
- TargetSatoriUnknown
- TargetDiscordChannel

以及一个总的类型 `AllSupportedPlatformTarget`,用于标识所有支持的 PlatformTarget。

Expand Down

0 comments on commit 026fdcf

Please sign in to comment.