From 23ec6c7108638aa7bdf4abe2b8e02f33e58a1ea4 Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Mon, 27 Apr 2020 14:01:56 +0800 Subject: [PATCH] update nonebot.message docs --- docs/api.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 5fd733d6..e18f1465 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1344,7 +1344,7 @@ sidebar: auto 将函数装饰为消息预处理器。 -- **要求:** +- **要求:** 被装饰函数必须是一个 async 函数,且必须接收且仅接收三个位置参数,类型分别为 `NoneBot` 、 `aiocqhttp.Event` 和 `nonebot.plugin.PluginManager`,即形如: @@ -1366,6 +1366,24 @@ sidebar: auto 在所有消息处理之前,向消息事件对象中加入 `preprocessed` 字段。 +### _exception_ `CanceledException` + +- **说明:** + + 取消消息处理异常 + +- **要求:** + + 在消息预处理函数 `message_preprocessor` 中可以选择抛出该异常来阻止响应该消息。 + +- **用法:** + + ```python + @message_preprocessor + async def _(bot: NoneBot, event: aiocqhttp.Event, plugin_manager: PluginManager): + raise CanceledException(reason) + ``` + ### _class_ `MessageSegment` 从 `aiocqhttp.message` 模块导入,继承自 `dict`,用于表示一个消息段。该类型是合法的 `Message_T`。