Files
Auto_Bangumi/docs/ja/dev/plugins/points/message-template.md
Estrella Pan 3258fcca4b docs(4.0-P7): 插件开发文档拆分为总览加每个扩展点一页,补齐中英日三语
- docs/dev/plugins.md 改为总览与导航,旧内容拆入 docs/dev/plugins/
- 新增核心概念、配置表单、事件、前端挂载点、命令行、签名与分发、内置插件、示例页
- 每个扩展点一页,侧边栏由页面表生成
- 改正旧文档中下载器配置、hardlink path_map 与补链按钮的过时描述
2026-10-08 14:51:00 +02:00

26 lines
1.6 KiB
Markdown

# 通知メッセージテンプレート (message_template)
transform フックです。システムイベントを外部チャンネルへプッシュする前に、イベントはこのフックを順に通ります。フックは既定の文面、イベント、チャンネルの種類を受け取ります。新しい `RenderedMessage` を返すと文面を書き換えられます。`None` は変更なしです。
```python
from ab_sdk import Plugin, hook, points
from ab_sdk.notify import RenderedMessage
class Alerts(Plugin):
@hook(points.MESSAGE_TEMPLATE)
def template(self, message: RenderedMessage, event, channel: str):
if event.kind != "rss_failure":
return None
if channel == "telegram":
return RenderedMessage(
f"[警告] {message.title}", f"<b>{event.rss_name}</b>\n{event.error}"
)
return None
```
- フックが影響するのは外部へのプッシュだけです。通知センターの文面は、フロントエンドが `i18n()` から描画するので変わりません。
- フックは、有効な各チャンネルに対して 1 回ずつ呼ばれます。`channel` はチャンネルの種類で、例えば `telegram` です。
- フックが失敗またはタイムアウトした場合は、前の段階の文面を使い、失敗はブレーカーに数えられます。戻り値の型が違うと、メッセージ全体が既定の文面に戻ります。
- 「新しい話」の通知は、まだこのフックを通りません。通知チャンネルに設定した 1 話用のテンプレートを使います。