127 lines
2.9 KiB
Markdown
127 lines
2.9 KiB
Markdown
|
```markdown
|
|||
|
|
## 注册方法
|
|||
|
|
|
|||
|
|
**以下方法，需要在 boot() 函数中调用。**
|
|||
|
|
|
|||
|
|
#### 定时执行脚本方法
|
|||
|
|
|
|||
|
|
*需求：脚本方法能传参。*
|
|||
|
|
|
|||
|
|
* 方法说明
|
|||
|
|
|
|||
|
|
将脚本方法设置为定时执行。
|
|||
|
|
|
|||
|
|
**注意，该方法需要在 boot() 方法中调用。**
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
def define_scheduled_functions(is_parallel: bool, delay: int, period: int, function_name: str, args: list) -> None
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
* 输入参数
|
|||
|
|
* is_parallel：bool 类型，是否并行。
|
|||
|
|
* delay：int 类型，启动延迟执行的时间，单位毫秒。
|
|||
|
|
* period：int 类型，脚本方法的周期，单位毫秒。
|
|||
|
|
* function_name：str 类型，周期执行的方法名。
|
|||
|
|
* args：list 类型，周期执行的方法的参数。
|
|||
|
|
* 输出参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
* 异常
|
|||
|
|
|
|||
|
|
本方法会抛出异常。
|
|||
|
|
|
|||
|
|
#### 注册系统启动初始化方法
|
|||
|
|
|
|||
|
|
* 方法说明
|
|||
|
|
|
|||
|
|
注册系统启动即执行的初始化方法。
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
def define_init_data_functions(function_name: str) -> None
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
* 输入参数
|
|||
|
|
|
|||
|
|
function_name：str 类型，注册的方法名。
|
|||
|
|
* 输出参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
* 异常
|
|||
|
|
|
|||
|
|
本方法会抛出异常。
|
|||
|
|
|
|||
|
|
#### 注册按钮
|
|||
|
|
|
|||
|
|
* 方法说明
|
|||
|
|
|
|||
|
|
向rds注册管理后台可见的按钮。
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
def register_button(label: str, remark: str, script_function: str, level: str, type: int = 0) -> None
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
* 输入参数
|
|||
|
|
* label，str 类型，按钮名。
|
|||
|
|
* remark，str 类型，按钮备注。
|
|||
|
|
* script_function，str 类型，点击按钮触发的方法名，**注意该方法不能带参数**。
|
|||
|
|
* level，str 类型，按钮等级，用颜色区分。blue：蓝色，yellow：黄色 ，red：红色。
|
|||
|
|
* type，int 类型，0: 普通按钮 1: 导出按钮，可选
|
|||
|
|
* 输出参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
* 异常
|
|||
|
|
|
|||
|
|
本方法会抛出异常。
|
|||
|
|
|
|||
|
|
#### 注册 Web 接口方法
|
|||
|
|
|
|||
|
|
* 方法说明
|
|||
|
|
|
|||
|
|
在脚本中注册接口方法。
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
def register_handler(method: str, path: str, callback: str, auth: bool) -> None
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
* 输入参数
|
|||
|
|
* method：str 类型，HTTP 请求方式，支持 POST，GET。
|
|||
|
|
* path：str 类型，接口的 URL 路径。
|
|||
|
|
* callback：str 类型，处理接口的脚本方法名。
|
|||
|
|
* auth：bool 类型，调用此接口是否需要登录。
|
|||
|
|
* 输出参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
* 异常
|
|||
|
|
|
|||
|
|
本方法会抛出异常。
|
|||
|
|
|
|||
|
|
#### 注册事件处理器
|
|||
|
|
|
|||
|
|
* 方法说明
|
|||
|
|
|
|||
|
|
注册事件处理器，可处理天风任务"触发任务事件"块所抛出的事件。
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
def register_task_event_function(function_name: str) -> None
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
* 输入参数
|
|||
|
|
* function_name：str 类型，注册的方法名。
|
|||
|
|
* 输出参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
* **注意事项**
|
|||
|
|
|
|||
|
|
**若希望处理"触发任务事件"块抛出的事件，需要：**
|
|||
|
|
* **在脚本中实现与"触发任务事件"块的"事件名"参数同名的函数。**
|
|||
|
|
* **脚本函数的签名为：**
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
def function_name(param: str) -> None
|
|||
|
|
```
|
|||
|
|
* **在 boot() 方法中，调用 register_task_event_function 方法将脚本函数注册为事件处理器。**
|
|||
|
|
* 异常
|
|||
|
|
|
|||
|
|
本方法会抛出异常。
|
|||
|
|
```
|