mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-28 05:49:02 +08:00
📝 update api docs
This commit is contained in:
parent
471d306e13
commit
a5948fb5e3
@ -22,24 +22,6 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `IgnoredException`
|
|
||||||
|
|
||||||
基类:`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `reason`: 忽略事件的原因
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ParserExit`
|
## _exception_ `ParserExit`
|
||||||
|
|
||||||
基类:`nonebot.exception.NoneBotException`
|
基类:`nonebot.exception.NoneBotException`
|
||||||
@ -61,57 +43,21 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `PausedException`
|
## _exception_ `IgnoredException`
|
||||||
|
|
||||||
基类:`nonebot.exception.NoneBotException`
|
基类:`nonebot.exception.NoneBotException`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
|
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
|
||||||
可用于用户输入新信息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
* **参数**
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
* `reason`: 忽略事件的原因
|
||||||
## _exception_ `RejectedException`
|
|
||||||
|
|
||||||
基类:`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
|
|
||||||
可用于用户重新输入。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `FinishedException`
|
|
||||||
|
|
||||||
基类:`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
|
|
||||||
可用于结束用户会话。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -132,6 +78,88 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `MatcherException`
|
||||||
|
|
||||||
|
基类:`nonebot.exception.NoneBotException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
所有 Matcher 发生的异常基类。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `SkippedException`
|
||||||
|
|
||||||
|
基类:`nonebot.exception.MatcherException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
指示 NoneBot 立即结束当前 `Handler` 的处理,继续处理下一个 `Handler`。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **用法**
|
||||||
|
|
||||||
|
可以在 `Handler` 中通过 `Matcher.skip()` 抛出。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `PausedException`
|
||||||
|
|
||||||
|
基类:`nonebot.exception.MatcherException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
|
||||||
|
可用于用户输入新信息。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **用法**
|
||||||
|
|
||||||
|
可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `RejectedException`
|
||||||
|
|
||||||
|
基类:`nonebot.exception.MatcherException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
|
||||||
|
可用于用户重新输入。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **用法**
|
||||||
|
|
||||||
|
可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `FinishedException`
|
||||||
|
|
||||||
|
基类:`nonebot.exception.MatcherException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
|
||||||
|
可用于结束用户会话。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **用法**
|
||||||
|
|
||||||
|
可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `AdapterException`
|
## _exception_ `AdapterException`
|
||||||
|
|
||||||
基类:`nonebot.exception.NoneBotException`
|
基类:`nonebot.exception.NoneBotException`
|
||||||
@ -152,7 +180,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
## _exception_ `NoLogException`
|
## _exception_ `NoLogException`
|
||||||
|
|
||||||
基类:`Exception`
|
基类:`nonebot.exception.AdapterException`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
@ -29,7 +29,7 @@ sidebarDepth: 0
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `func: T_Handler`: 事件处理函数。
|
* `func: Callable[..., Any]`: 事件处理函数。
|
||||||
|
|
||||||
|
|
||||||
* `name: Optional[str]`: 事件处理器名称。默认为函数名。
|
* `name: Optional[str]`: 事件处理器名称。默认为函数名。
|
||||||
@ -50,7 +50,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
* **类型**
|
* **类型**
|
||||||
|
|
||||||
`T_Handler`
|
`Callable[..., Any]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -42,7 +42,7 @@ Rule(async_function, run_sync(sync_function))
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `*checkers: Callable[[Bot, Event, T_State], Awaitable[bool]]`: **异步** RuleChecker
|
* `*checkers: T_RuleChecker`: RuleChecker
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,11 +58,11 @@ Rule(async_function, run_sync(sync_function))
|
|||||||
* **类型**
|
* **类型**
|
||||||
|
|
||||||
|
|
||||||
* `Set[Callable[[Bot, Event, T_State], Awaitable[bool]]]`
|
* `Set[Handler]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `__call__(bot, event, state)`
|
### _async_ `__call__(bot, event, state, stack=None, dependency_cache=None)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
@ -179,7 +179,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
* **类型**
|
* **类型**
|
||||||
|
|
||||||
`Callable[[Bot, Event, T_State], Union[bool, Awaitable[bool]]]`
|
`Callable[..., Union[bool, Awaitable[bool]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user