ResourceRule 实例

ResourceRule 实例是一个用于配置规则新增和更新数据的实例，通过内置的zhname() , conditions() , enbale() , actions() , remarks() 方法(支持链式调用)可以快速配置所需的数据，最终调用 apply() 方法实现新增以及更新

类型：ResourceRule

zhname()

配置规则中文名称

zhname: (name: string) => ResourceRule;

• 参数

  • name：规则中文名称必传

• 返回类型

  • ResourceRule 实例对象

• 示例

const sources = rule.create("xxx");
sources.zhname("中文名称");

conditions()

配置规则执行时间

conditions: (condition: string) => ResourceRule;

• 参数

  • condition：规则执行条件（ string 类型，多个条件通过逻辑运算符 && 或 || 连接）

• 返回类型

  • ResourceRule 实例对象

• 示例

const sources = rule.create("xxx");
sources.conditions("(.).metrics(Temperature) < 16 || (.).metrics(Temperature) > 24");

enable()

配置规则是否启用

enable: (isEnable: boolean) => ResourceRule;

• 参数

  • bool：规则是否启用( true 为开启， false 为关闭)

• 返回类型

  • ResourceRule 实例对象

• 示例

const sources = mode.create("xxx");
sources.enable(true);

actions()

配置规则执行动作

actions: (commandsWithGroup: Array<{ group?: string | number; command: string }>) => ResourceRule;

• 参数

  • commandsWithGroup：规则执行动作

    • command 为具体指令

    • group 为分组，相同的指令会被归为一组，若无分组需求可不传

• 返回类型

  • ResourceRule 实例对象

• 示例

const sources = rule.create("xxx");
sources.actions([{ group: 0, command: "(./devices/Window).close()" }]);

remarks()

配置备注

remarks: (remark: string) => ResourceRule;

• 参数

  • remark：备注

• 返回类型

  • ResourceRule 实例对象

• 示例

const sources = rule.create("xxx");
sources.remarks("这是备注");

apply()

提交修改

apply: () => Promise<any>;

• 参数

  • 无

• 返回类型

  • Promise<any>

• 示例

const sources = rule.create("xxx");
sources.apply();