From d82749c48e962d26faa6827c9b7da3c28d9bec0e Mon Sep 17 00:00:00 2001 From: nonebot Date: Thu, 16 Sep 2021 09:37:47 +0000 Subject: [PATCH] :memo: update api docs --- docs/api/matcher.md | 53 ----------- docs/api/plugin.md | 214 -------------------------------------------- 2 files changed, 267 deletions(-) diff --git a/docs/api/matcher.md b/docs/api/matcher.md index 5ebb8d3f..ecebc0bc 100644 --- a/docs/api/matcher.md +++ b/docs/api/matcher.md @@ -292,59 +292,6 @@ sidebarDepth: 0 -### _classmethod_ `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, expire_time=None, default_state=None, default_state_factory=None, default_parser=None, default_type_updater=None, default_permission_updater=None)` - - -* **说明** - - 创建一个新的事件响应器，并存储至 [matchers](#matchers) - - - -* **参数** - - - * `type_: str`: 事件响应器类型，与 `event.get_type()` 一致时触发，空字符串表示任意 - - - * `rule: Optional[Rule]`: 匹配规则 - - - * `permission: Optional[Permission]`: 权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器，即触发一次后删除 - - - * `priority: int`: 响应优先级 - - - * `block: bool`: 是否阻止事件向更低优先级的响应器传播 - - - * `module: Optional[str]`: 事件响应器所在模块名称 - - - * `default_state: Optional[T_State]`: 默认状态 `state` - - - * `default_state_factory: Optional[T_StateFactory]`: 默认状态 `state` 的工厂函数 - - - * `expire_time: Optional[datetime]`: 事件响应器最终有效时间点，过时即被删除 - - - -* **返回** - - - * `Type[Matcher]`: 新的事件响应器类 - - - ### _async classmethod_ `check_perm(bot, event)` diff --git a/docs/api/plugin.md b/docs/api/plugin.md index c51c93b2..502ac150 100644 --- a/docs/api/plugin.md +++ b/docs/api/plugin.md @@ -68,220 +68,6 @@ sidebarDepth: 0 * **说明**: 插件内定义的 `Matcher` -## `on(type='', rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个基础事件响应器，可自定义类型。 - - - -* **参数** - - - * `type: str`: 事件响应器类型 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_metaevent(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个元事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_message(rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=True, state=None, state_factory=None)` - - -* **说明** - - 注册一个消息事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_notice(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个通知事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_request(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个请求事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - ## `on_startswith(msg, rule=None, ignorecase=False, **kwargs)`