Rule

规则 SDK 类，可以提供读取规则的相关操作能力

方法

enable()

启用规则

enable: (name?: string) => Promise<boolean>;

• 参数

  • name: 规则名称选传

    • 不传默认启用该空间内的所有规则

    • 支持传多个名称，中间以逗号隔开，eg：name1,name2,name3

• 返回类型

  • Promise<boolean>

• 示例

import Tacos, { Root } from "@tslfe/tacos-sdk";
import type { Rule } from "@tslfe/tacos-sdk";
...
const rule = await root.search<Rule>("/Office/rules/*");
// 启用规则
await rule.enable("XXX");

disable()

禁用某个规则

disable: (name?: string) => Promise<boolean>;

• 参数

  • name: 规则名称选传

    • 不传默认禁用该空间内的所有规则

    • 支持传多个名称，中间以逗号隔开，eg：name1,name2,name3

• 返回类型

  • Promise<boolean>

• 示例

// 禁用规则
rule.disable("XXX");

remove()

删除规则

remove: (name?: string) => Promise<boolean>;

• 参数

  • name: 规则名称选传

    • 不传默认删除该空间内的所有规则

    • 支持传多个名称，中间以逗号隔开，eg：name1,name2,name3

• 返回类型

  • Promise<boolean>

• 示例

// 删除规则
rule.remove("XXX");

getResourceBy()

基于空间 id 获取该空间下的规则资源列表

getResourceBy: (spaceId: string) => Promise<ResourceOption<RuleMetaData>>

参考: ResourceOption; RuleMetaData

• 参数

  • spaceId: 空间 id 必传

• 返回类型

  • Promise<ResourceOption<RuleMetaData>>

• 示例

const resourceOption = await rule.getResourceBy("0192234");

create()

创建规则新增配置实例

create: (type: string) => ResourceRule;

• 参数

  • type: 规则名称必传，空间下唯一标识

• 返回类型

  • ResourceRule 实例对象

• 示例

// 创建规则新增实例
rule.create("OnWork");

getById()

通过规则 id 查找可用于编辑的 ResourceRule 实例

getById: (id: string) => ResourceRule;

• 参数

  • id: 规则 id 必传，查找指定规则 id 对应的 ResourceRule

• 返回类型

  • ResourceRule 实例对象

• 示例

// 创建规则更新实例
rule.getById("xxxxxxx");

getByType()

通过规则 type 查找可用于编辑的 ResourceRule 实例数组

getByType: (type: string) => ResourceRule[];

• 参数

  • type: 规则 type 必传，查找指定规则type 对应的 ResourceRule集合

• 返回类型

  • ResourceRule 实例对象数组

• 示例

// 创建规则更新实例
rule.getByType("OnWork");

实例类

ResourceRule 实例